Overview of the simplified REST API
Example API call
The following is a simplified REST API call to retrieve a person's support group details based on the person ID:
cURL example
The following is an example response:
"loginId": "string",
"firstName": "string",
"lastName": "string",
"fullName": "string",
"company": "string",
"permission": [
"string"
],
"assigneeSupportGroups": [
{
"id": "string",
"name": "string",
"company": "string",
"organization": "string",
"defaultGroup": false,
"available": false,
"functionalRole": "string"
}
]
}
Supported resources and methods
The following table lists the resources and HTTP methods for the REST operations.
Resource | Endpoints | HTTP method | Actions |
|---|---|---|---|
Change ticket | /change/search | POST | Get change ticket details based on search criteria. |
/change/{id} | GET | Get change ticket details based on ticket id. | |
PATCH | Update change ticket status based on ticket id. | ||
Incident ticket | /incident/search | POST | Search for incident tickets based on search criteria. |
/incident/{id} | GET | Get incident ticket details based on incident id. | |
PATCH | Update incident ticket details based on incident id. | ||
Problem ticket | /problem/search | POST | Get problem investigation ticket details based on search criteria. |
/problem/{id} | GET | Get problem investigation ticket details based on ticket id. | |
PATCH | Update problem investigation ticket status based on ticket id. | ||
Ticket search | /ticket/search | POST | Get ticket details based on search criteria. |
Attachment | /attachment/download/{dataSource}/{attachmentFieldId}/{dataSourceId} | GET | Download attachment from a form. |
Foundation | /foundation/supportGroups | POST | Get a list of support groups for a person id. |
Person record | /person/permission | GET | Get a list of permissions assigned to a logged in user. |
/person/{id} | GET | Get person details based on person id. | |
Metadata | /metadata/{type} | GET | Search for a specific type of metadata. |
Work note | /worknote/{type}/{id} | GET | Get a work note by type and id. |
POST | Add a work note. | ||
Recommended knowledge articles and tickets | /incident/{id}/recommended/{ticketType} | GET | Get a list of recommended knowledge articles and related tickets for an incident. |
/problem/{id}/recommended/{ticketType} | GET | Get a list of recommended knowledge articles and related tickets for a problem ticket. |