URL
GET https://{api-url}/api/v2/tenants/{tenantId}/{ticketType}/{ticketId}/notes
Sample URLs
These are the supported ticket types and sample URLs:
Ticket Type | Sample URL |
---|---|
Incident | https://{api-url}/api/v2/tenants/client_7/incidents/INC0000001030/notes?pageNo=1&pageSize=5&queryString=startCreationDate:2015-11-02T09:17:09 0000+endCreationDate:2015-11-02T09:17:09 0000 |
Service request | https://{api-url}/api/v2/tenants/client_7/serviceRequests/SRQ0000000996/notes |
Change request | https://{api-url}/api/v2/tenants/client_7/changeRequests/CHG0000001111/notes |
Timebound request | https://{api-url}/api/v2/tenants/client_7/timeBoundRequests/TBT0000001127/notes |
Problem | https://{api-url}/api/v2/tenants/client_7/problems/PRB0000001032/notes |
Task | https://{api-url}/api/v2/tenants/client_7/tasks/TASK0000001049/notes?pageNo=1&pageSize=5&queryString=startCreationDate:2015-11-02T09:17:09 0000+endCreationDate:2015-11-02T09:17:09 0000 |
Notes
There are special characters that can be used in a query string:
- (+) represents the next field and must be URL-encoded.
- (:) represents equals. An example is
key : value
. - Space characters must be URL-encoded.
- Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).
Parameters
All parameters are optional:
Field | Default Value |
---|---|
pageNo={pageNo} | 1 |
pageSize={pageSize} | 100 |
isDescendingOrder={true/false} | true |
sortName={field} | note.id |
queryString={queryString} | NA |
NA indicates that the value is not applicable.
Query Variable | Description |
---|---|
searchWord | Search for a note with a specific word provided in the note. |
id | Note ID |
startCreationDate | Search for note created within a specific date range. startCreationDate denotes the from date. |
endCreationDate | endCreationDate denotes the to date. |
startUpdationDate | Search for the note updated within a specific date range. startUpdationDate denotes the from date. |
endUpdationDate | endUpdationDate denotes the to date. |
Status code
200 OK
Sample response
{
"results": [{
"id": 12,
"subject": "this notes",
"description": "this notes is created and updated from api 1",
"createdTime": "2015-11-02T09:17:09+0000",
"updatedTime": "",
"createdBy": {
"id": "USR0000002095",
"loginName": "John.Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@domain.com",
"changePassword": false
}
},
{
"id": 10,
"subject": "note31",
"description": "note31",
"createdTime": "2015-10-27T13:39:17+0000",
"updatedTime": "",
"createdBy": {
"id": "USR0000002113",
"loginName": "james@superadmin",
"lastName": "HUDSON",
"firstName": "JAMES",
"email": "james.hudson@domain.com",
"changePassword": false
}
},
{
"id": 8,
"subject": "this notes",
"description": "this notes is created and updated from api",
"createdTime": "2015-10-27T13:19:01+0000",
"updatedTime": "",
"createdBy": {
"id": "USR0000002095",
"loginName": "John.Smith",
"lastName": "Smith",
"firstName": "John",
"email": "john.smith@domain.com",
"changePassword": false
}
}
],
"totalResults": 6,
"orderBy": "note.id",
"pageNo": 1,
"pageSize": 3,
"totalPages": 2,
"nextPage": true,
"nextPageNo": 2,
"previousPageNo": 0,
"descendingOrder": true
}