Ticket Web APIs
Ticket Web APIs are available to:
- Create APIs that retrieve a variety of information about tickets.
- Create APIs that create ticket or perform operations on specific tickets.
Using Get calls, Ticket Web APIs enable you to retrieve all:
- Notes
- Ticket note fields
- Assignments
- Ticket templates
Using Post calls, Ticket Web APIs can:
- Change the return status.
- Create a user note linked to a ticket.
- Create a ticket
- Close a ticket
- Delete a ticket
The following topics provide details about the Ticket Web APIs:
GET /tickets/{id}
Description | Returns sequence, display names, and values of all fields for the specified ticket in JSON format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Type of call | GET | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL Syntax | http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/{id} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Authorization Header | Bearer access_token received through the Token API call. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Parameters | Specify the Ticket ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Body | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Execution response | Click here to see a table of the execution response values. The following table lists the sequence number and Display Names of the fields that are returned by the GET tickets/{id} Web API:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Important considerations |
|
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/101
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Response:
{
"Tickets": {
"1": {
"DisplayName": " Ticket ID",
"Value": 101
},
"2": {
"DisplayName": "Last Modified",
"Value": "2019-01-21T09:12:06.1730000Z"
},
"3": {
"DisplayName": "Last User",
"Value": "dbo"
},…
}}
POST /tickets/{id}
Description | Modifies and returns the specified ticket in JSON format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Type of call | POST | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL Syntax | http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/{id} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Authorization Header | Bearer access_token received through the Token API call. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Parameters | (required) id Specify the Ticket ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Body |
{ Click here to see a table of the fields you can update. For the specified ticket, you can update the following fields:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Execution response | Click here to see a table of the execution response values. The POST /tickets/{id} Web API can update the following fields for the specified assignment:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Important considerations | None |
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebAPI/WebApi/tickets/101
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Request Body:
updateInput:
{
"Properties": {
"Category" :"Applications",
"Additional Information" : "Additional Information field is updated. "
},
"OptionalParams": {
"Param1": {},
"Param2": {}
}
}
Response:
{
"Tickets": {
"1": {
"DisplayName": "Ticket ID",
"Value": 101
},
"2": {
"DisplayName": "Last Modified",
"Value": "2019-01-23T11:27:09.7970000Z"
},
"3": {
"DisplayName": "Last User",
"Value": "TECH1"
},
"4": {
"DisplayName": "Seq_Group",
"Value": 2
},
"7": {
"DisplayName": "Additional Information",
"Value": "Additional Information field is updated. "
}….
"72": {
"DisplayName": "Category",
"Value": "Applications"
}….
}}
GET /tickets/{id}/Attachments/{pageSize}/{pageNumber}
Description | Returns all Attachments linked to the specified ticket in JSON format |
---|---|
Type of call | GET |
URL Syntax | http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/{id}/Attachments/{pageSize}/{pageNumber} |
Request Authorization Header | Bearer access_token received through the Token API call. |
Request Parameters |
|
Request Body | None |
Execution response | Returns count and all attachments linked to a specific ticket |
Important considerations |
|
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/101/Attachments/0/0
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Response:
{
"Count": 10, "TicketAttachments": [ { "1": { "DisplayName": "Sequence", "Value": 1001 }, "6": { "DisplayName": "File Size", "Value": 120743 }, "7": { "DisplayName": "File Name", "Value": "Serengeti_National_Park_070.jpg" }, "14": { "DisplayName": "URL Link", "Value": "www.sangreti.com" } },… ]}
GET /tickets/{id}/Notes/{pageSize}/{pageNumber}
Description | This returns all notes linked to specified ticket in JSON format |
---|---|
Type of call | GET |
URL Syntax | http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/{id}/Notes/{pageSize}/{pageNumber} |
Request Authorization Header | Bearer access_token received through the Token API call. |
Request Parameters |
|
Request Body | None |
Execution response | Returns all notes linked to a specific ticket |
Important considerations |
|
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/101/0/0/Notes?maxContentLength=-1&SystemNote=true
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Response:
{ "Count": 3, "TicketNotes": [ { "1": { "DisplayName": "Sequence", "Value": 1003 }, "2": { "DisplayName": "Last Modified", "Value": "2019-01-23T08:20:43.3030000Z" }, "3": { "DisplayName": "Last User", "Value": "TECH1" }, "4": { "DisplayName": "Seq_Group", "Value": 2 },… }}
GET /tickets/Note/{noteId}
Description | Returns sequence, display names, and values of all fields for the specified ticket note in JSON format | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Type of call | GET | ||||||||||||||||||||||||||||||||||||||||||||||||||
URL Syntax | http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/Note/{noteId} | ||||||||||||||||||||||||||||||||||||||||||||||||||
Request Authorization Header | Bearer access_token received through the Token API call. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Request Parameters | Specify the Ticket Note ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Request Body | None | ||||||||||||||||||||||||||||||||||||||||||||||||||
Execution response | Click here to see a table of the execution response values. For the specified ticket note, the following fields can be returned:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
Important considerations |
|
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/Note/1001
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Response:
{ "Note": [ { "1": { "DisplayName": "Sequence", "Value": 1001 }, "2": { "DisplayName": "Last Modified", "Value": "2019-01-23T08:20:43.1530000Z" }, "3": { "DisplayName": "Last User", "Value": "TECH1" }, "4": { "DisplayName": "Seq_Group", "Value": 2 },… }}
GET /tickets/{id}/Assignments/{pageSize}/{pageNumber}
Description | Returns all Assignments linked to specified Ticket in JSON format |
---|---|
Type of call | GET |
URL Syntax | http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/{id}/Assignments/{pageSize}/{pageNumber} |
Request Authorization Header | Bearer access_token received through the Token API call. |
Request Parameters |
|
Request Body | None |
Execution response | Returns the count and all assignments linked to a specified ticket |
Important considerations |
|
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/101/Assignments/0/0
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Response:
{ "Count": 10, "Assignments": [ { "1": { "DisplayName": "Sequence", "Value": 1003 }, "2": { "DisplayName": "Last Modified", "Value": "2019-01-23T08:20:43.3030000Z" }, "3": { "DisplayName": "Last User", "Value": "TECH1" }, "4": { "DisplayName": "Seq_Group", "Value": 2 },… }}
POST /tickets/{id}/ChangeStatus
Description | Changes and returns the status of the specified ticket in JSON format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Type of call | POST | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL Syntax | http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/{id}/ChangeStatus | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Authorization Header | Bearer access_token received through the Token API call. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Parameters | (required) id Specify the Ticker ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Body | Specify the changeStatusInput as follows:
{ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Execution response | For the specified ticket, updates the status and adds a note. Click here to see a table of the execution response values. For the specified ticket, you can return the following fields:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Important considerations |
|
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebAPI/tickets/101/ChangeStatus
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Request Body:
{
"StatusName": "Escalated",
"Note": {
"Note Type": "Ticket Description",
"Activity Code": "Install",
"Note": " This is a Ticket Note added by API to change Status."
}
}
Response:
{
"Ticket": {
"1": {
"DisplayName": "Ticket ID",
"Value": 101
},
"2": {
"DisplayName": "Last Modified",
"Value": "2019-01-23T13:06:08.7500000Z"
},
"3": {
"DisplayName": "Last User",
"Value": "TECH1"
},
"4": {
"DisplayName": "Seq_Group",
"Value": 2
},….
"96": {
"DisplayName": "Status",
"Value": "Escalated"
},…..
}
}
"TicketNote": {
"1": {
"DisplayName": "Sequence",
"Value": 1010
},
"2": {
"DisplayName": "Last Modified",
"Value": "2019-01-23T13:06:09.3370000Z"
},
"3": {
"DisplayName": "Last User",
"Value": "TECH1"
},
"4": {
"DisplayName": "Seq_Group",
"Value": 2
},
"5": {
"DisplayName": "Note",
"Value": "This is a Ticket Note added by API to change Status. "
},
"6": {
"DisplayName": "Ticket ID",
"Value": 101
}….
}
}
POST /tickets/{id}/AddNote
Description | Creates and returns a user note linked to the specified ticket in JSON format |
---|---|
Type of call | POST |
URL Syntax | http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/{id}/AddNote |
Request Authorization Header | Bearer access_token received through the Token API call. |
Request Parameters | (required) id Specify the Ticket ID. |
Request Body | (required) note
{ |
Execution response | Creates and returns a user note linked to a specific ticket |
Important considerations |
|
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebAPI/tickets/101/AddNote
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Request Body:
{
"Note Type": "Ticket Description",
"Activity Code": "Install",
"Note": "This is a ticket Note added by API",
"Duration": "00:10:00",
"OptionalParams": {
"Param1": {},
"Param2": {}
}
}
Response:
{
"Ticket": {
"1": {
"DisplayName": "Ticket ID",
"Value": 101
},
"2": {
"DisplayName": "Last Modified",
"Value": "2019-01-23T11:27:09.7970000Z"
},
"3": {
"DisplayName": "Last User",
"Value": "TECH1"
},
"4": {
"DisplayName": "Seq_Group",
"Value": 2
},…
}
"TicketNote": {
"1": {
"DisplayName": "Sequence",
"Value": 1008
},
"2": {
"DisplayName": "Last Modified",
"Value": "2019-01-23T12:40:46.6130000Z"
},
"3": {
"DisplayName": "Last User",
"Value": "SAK2"
},
"4": {
"DisplayName": "Seq_Group",
"Value": 2
},
"5": {
"DisplayName": "Note",
"Value": "This is a ticket Note added by API"
},
"6": {
"DisplayName": "Ticket ID",
"Value": 101
},
"8": {
"DisplayName": "Seq_Technician",
"Value": 1035
},
"10": {
"DisplayName": "Duration",
"Value": 600
},…..
}}
POST /tickets
Description | Creates and returns the specified ticket in JSON format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Type of call | POST | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL Syntax | http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebAPI/tickets | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Authorization Header | Bearer access_token received through the Token API call. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Parameters | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Body | Specify createInput as follows:
{ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Execution response | Click here to see a table of the execution response values. For the created ticket, you can return the following fields:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Important considerations |
|
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebAPI/tickets
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Request Body:
{
"Properties": {
"Category":"Applications",
"Additional Information": "Additional Information field is updated. "},
"OptionalParams": {
"Param1": {},
"Param2": {}
}
}
Response:
{
"Tickets": {
"1": {
"DisplayName": "Ticket ID",
"Value": 101
},
"2": {
"DisplayName": "Last Modified",
"Value": "2019-01-23T11:27:09.7970000Z"
},
"3": {
"DisplayName": "Last User",
"Value": "TECH1"
},
"4": {
"DisplayName": "Seq_Group",
"Value": 2
},
"7": {
"DisplayName": "Additional Information",
"Value": "Additional Information field is updated. "
}….
"72": {
"DisplayName": "Category",
"Value": "Applications"
},
}}
POST /tickets/{id}/Close
Description | Changes and returns the status of the specified ticket to the default status type of Closed in JSON format. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Type of call | POST | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL Syntax | http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/{id}/Close | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Authorization Header | Bearer access_token received through the Token API call. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Parameters | (required) id Specify the Ticket ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Body | (required) closeInput Specify as follows:
{ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Execution response | Changes the status type of a specific ticket to closed, and returns the ticket and the note Click here to see a table of the execution response values. For the specified ticket, you can return the following fields:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Important considerations |
|
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebAPI/tickets/101/Close
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Request Body:
closeInput: { "Note": { "Note Type": "Ticket Description", "Activity Code": "Install", "Note": " This is a Ticket Note added by API to close the Ticket.", "OptionalParams": { "Param1": {}, "Param2": {} } } }
{ "Ticket": { "1": { "DisplayName": "Ticket ID", "Value": 101 }, "2": { "DisplayName": "Last Modified", "Value": "2019-01-23T13:06:08.7500000Z" }, "3": { "DisplayName": "Last User", "Value": "TECH1" }, "4": { "DisplayName": "Seq_Group", "Value": 2 },…. "96": { "DisplayName": "Status", "Value": "Closed" },….. } } "Note": { "1": { "DisplayName": "Sequence", "Value": 1010 }, "2": { "DisplayName": "Last Modified", "Value": "2019-01-23T13:06:09.3370000Z" }, "3": { "DisplayName": "Last User", "Value": "SAK2" }, "4": { "DisplayName": "Seq_Group", "Value": 2 }, "5": { "DisplayName": "This is a Ticket Note added by API to close the Ticket.", "Value": "note" }, "6": { "DisplayName": "Ticket ID", "Value": 101 }…. } }
POST /tickets/{id}/Delete
Description | This deletes the specified ticket and returns the status in JSON format |
---|---|
Type of call | POST |
URL Syntax | http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/{id}/Delete |
Request Authorization Header | Bearer access_token received through the Token API call. |
Request Parameters | Specify the Ticket ID. |
Request Body | None |
Execution response | Deletes a specific ticket and returns the status |
Important considerations |
|
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebAPI/tickets/101/Delete
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Response:
{ "success": true }
GET /tickets/Templates
Description | Returns all active ticket templates in JSON format |
---|---|
Type of call | GET |
URL Syntax | http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/Templates |
Request Authorization Header | Bearer access_token received through the Token API call. |
Request Parameters | Specify the Ticket ID. |
Request Body | None |
Execution response | Returns all active Ticket Templates |
Important considerations |
|
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/tickets/Templates
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Response:
{
"TicketTemplates": [
{
"1": {
"DisplayName": "Sequence",
"Value": 3
},
"3": {
"DisplayName": "Name",
"Value": "New Hire"
}, "4": {
"DisplayName": "Description",
"Value": "New Hire Creation"
},
"6": {
"DisplayName": "Template Data",
"Value": "<TemplateData>\r\n <RowData>\r\n <sequence>81</sequence>\r\n <datatype>nvarchar</datatype>\r\n <fkcolumn>80</fkcolumn>\r\n <fkvalue>1</fkvalue>\r\n <fieldname>Status</fieldname>\r\n <value>Open</value>\r\n </RowData>\r\n <RowData>\r\n <sequence>114</sequence>\r\n <datatype>nvarchar</datatype>\r\n <fkcolumn>113</fkcolumn>\r\n <fkvalue>3</fkvalue>\r\n <fieldname>Priority</fieldname>\r\n <value>3 - Medium</value>\r\n ……..</TemplateData>"
},
"10": {
"DisplayName": "Is Used in Self Service",
"Value": false
},…
}}
Comments
Log in or register to comment.