Endpoint
/api/v2/tenants/{tenantId}/{ticketType}/{ticketId}/notes

Gets multiple notes from a ticket.

Query VariableDescription
searchWordSearch for a note with a specific word provided in the note.
idNote ID
startCreationDateSearch for note created within a specific date range. startCreationDate denotes the from date.
endCreationDateendCreationDate denotes the to date.
startUpdationDateSearch for the note updated within a specific date range. startUpdationDate denotes the from date.
endUpdationDateendUpdationDate denotes the to date.
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)

Path Parameters
tenantId
string

Describes the clientId of the tenant

ticketType
string

Supported ticket type:INCIDENT

ticketId
string

Unique Identifier (UUID) for incidents,service requests,problem universall called as tickets

Query Parameters
pageNo
integer

pageSize
integer

sortName
string

isDescendingOrder
boolean

queryString
string

Responses

OK

descendingOrder
boolean

nextPage
boolean

nextPageNo
integer

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.createdBy
results.createdTime
results.description
results.id
results.subject
results.updatedTime
totalPages
integer

totalResults
integer

{
  "descendingOrder": true,
  "nextPage": true,
  "nextPageNo": 2,
  "orderBy": "note.id",
  "pageNo": 1,
  "pageSize": 3,
  "previousPageNo": 0,
  "results": [
    {
      "createdBy": {
        "changePassword": false,
        "email": "john.smith@domain.com",
        "firstName": "John",
        "id": "USR0000002095",
        "lastName": "Smith",
        "loginName": "John.Smith"
      },
      "createdTime": "2015-11-02T09:17:09+0000",
      "description": "this notes is created and updated from api 1",
      "id": 12,
      "subject": "this notes",
      "updatedTime": ""
    },
    {
      "createdBy": {
        "changePassword": false,
        "email": "james.hudson@domain.com",
        "firstName": "JAMES",
        "id": "USR0000002113",
        "lastName": "HUDSON",
        "loginName": "james@superadmin"
      },
      "createdTime": "2015-10-27T13:39:17+0000",
      "description": "note31",
      "id": 10,
      "subject": "note31",
      "updatedTime": ""
    },
    {
      "createdBy": {
        "changePassword": false,
        "email": "john.smith@domain.com",
        "firstName": "John",
        "id": "USR0000002095",
        "lastName": "Smith",
        "loginName": "John.Smith"
      },
      "createdTime": "2015-10-27T13:19:01+0000",
      "description": "this notes is created and updated from api",
      "id": 8,
      "subject": "this notes",
      "updatedTime": ""
    }
  ],
  "totalPages": 2,
  "totalResults": 6
}
Endpoint
/api/v2/tenants/{tenantId}/{ticketType}/{ticketId}/notes

Creates ticket notes.

Path Parameters
tenantId
string

Describes the clientId of the tenant

ticketType
string

Supported ticket type:INCIDENT

ticketId
string

Unique Identifier (UUID) for incidents,service requests,problem universall called as tickets

description
string

{
  "description": "Sample description of Note"
}

Responses

OK

id
integer

subject
string

{
  "id": 15,
  "subject": "Sample Note"
}