Connect to 3rd party systems

API Rest and Soap 

API Docs

 

Create a Ticket

This API will allow you to create a new client in the application.

URL

{Url_Application}/API/Ticket/Save

Request Type

POST

URL Parameters

  • Username: name of the resource running the API call.
  • Password: password of the resource running the API call.

Syntax:

{Url_Application}/API/Ticket/Save?username=Username&password=Password

Successful Response Codes

  • Code of the HTML: 200.
  • JSON Response Code: "Status":0,"

Call Example (with custom fields)

 

 

Response Answer (without custom fields)

 

Call Example (with custom fields, section « CustomFields »)

 

Response Example (with custom fields, section « CustomFields »)

NOTE

  • The resource that executes the API call must have permission to create tickets in the application.

 

 

Update a ticket

 

URL

{Url_Application}/API/Ticket/UpdateProperty

 

Request Type

POST

 

URL Parameters

  • Username: name of the resource running the API call.
  • Password: password of the resource running the API call.

Syntax: {Url_Application}/API/Ticket/UpdateProperty?username=Username&password=Password

 

Successful Response Code

  • HTML code: 200.
  • JSON response code: "Status":0,"

 

Call Example (System field)

Parameters passed in the call

  • “Id”: the ticket ID.
  • “PropertyName”: the name of the system field to update.
  • “Value”: the new value of the system field. 

Call Example (system field)

 

 

Call Example (custom field)

Parameters passed in the call:

  • “Id”: the Ticket Id.
  • “CustomFieldSequenceNumber”: The sequence number of the custom field to update.

“Value”: the new value of the custom field.     

 

 

Response Example (custom field)

 

 

NOTES

  • The resource that executes the API call must have permission to edit tickets in the application.

 

 

Create a client

 

This API allows you to create a new client in the application.

URL

{Url_Application}/API/Clients/Save

Request Type

POST

URL Parameters

  • Username: name of the resource running the API call.
  • Password: password of the resource running the API call.

Syntax:

{Url_Application}/API/Clients/Save?username=Username&password=Password

Successful Response Codes

  • Code of the HTML: 200
  • JSON Response Code: "Status":0,"

 

Call Example (without custom fields)

 

 

Response Example (without custom fields)

 

Call Example (with custom fields, section « CustomFields »)

 

Response Example (with custom fields, « CustomFields » section)

 

NOTES

  • The resource that executes the API call must have permission to create clients in the application.

 

Update a client

 

URL

{Url_Application}/API/Clients/UpdateProperty

Request Type

POST

URL Parameters

  • Username: name of the resource running the API call.
  • Password: password of the resource running the API call.

Syntax: {Url_Application}/API/Clients/UpdateProperty?username=Username&password=Password

Successful Response Codes

  • HTML code: 200.
  • JSON response code: "Status":0,"

Call Example (system field)

Parameters passed in the call

  • “Id”: the client Id.
  • “PropertyName”: the system field to update.

“Value”: the new value of the system field.

 

 

Response Example (system field)

 

 

Call Example (custom field)

 

Response Example (custom field)

 

 

NOTE

  • The resource that executes the API call must have permission to edit clients in the application.

 

Create a CI

 

This API will allow you to create a new client in the application.

URL

{Url_Application}/API/CI/Save

Request Type

POST

URL Parameters

  • Username: name of the resource running the API call.
  • Password: password of the resource running the API call.

Syntax:

{Url_Application}/API/CI/Save?username=Username&password=Password

Successful Response Codes 

  • Code of the HTML: 200.
  • JSON response code: "Status":0,"

 

Call Example (without custom fields)

 

 

Response Example (without custom fields)

 

 

Call Example (with custom fields, section « CustomFields »)

 

 

Response Example (with custom fields, section « CustomFields »)

 

 

NOTE

  • The resource that executes the API call must have permission to create CIs in the application.

 

Update a CI

 

This API allows you to update a ticket in the application.

URL

{Url_Application}/API/CI/UpdateProperty

Request Type

POST

URL Parameters

  • Username: name of the resource running the API call.
  • Password: name of the resource running the API call.

Syntax: {Url_Application}/API/CI/UpdateProperty?username=Username&password=Password

Successful Response Codes

  • HTML code: 200.
  • JSON response code: "Status":0,"

Call Example (system field)

Parameters passed in the call

  • “Id”: the CI Id.
  • “PropertyName”: the name of the system field to update.
  • “Value”: the new value of the system field.            

 

This API allows you to update a ticket in the application.

  • URL

{Url_Application}/API/CI/UpdateProperty

  • Request Type

POST

  • URL Parameters
    • Username: name of the resource running the API call.
    • Password: name of the resource running the API call.

Syntax: {Url_Application}/API/CI/UpdateProperty?username=Username&password=Password

  • Successful Response Codes
    • HTML code: 200.
    • JSON response code: "Status":0,"
  • Call Example (system field)

Parameters passed in the call

  • “Id”: the CI Id.
  • “PropertyName”: the name of the system field to update.
  • “Value”: the new value of the system field.    

 

This API allows you to update a ticket in the application.

  • URL

{Url_Application}/API/CI/UpdateProperty

  • Request Type

POST

  • URL Parameters
    • Username: name of the resource running the API call.
    • Password: name of the resource running the API call.

Syntax: {Url_Application}/API/CI/UpdateProperty?username=Username&password=Password

  • Successful Response Codes
    • HTML code: 200.
    • JSON response code: "Status":0,"
  • Call Example (system field)

Parameters passed in the call

  • “Id”: the CI Id.
  • “PropertyName”: the name of the system field to update.
  • “Value”: the new value of the system field.            

 

 

Response Example (system field)

 

 

Call Example (custom field)

 

Response Example (custom field)

 

 

 

NOTE

  • The resource that executes the API call must have permission to edit CIs in the application.