Create and Get Ticket Notes

Creates and gets ticket notes.

get
/api/v2/tenants/{clientId}/{ticketType}/{ticketId}/notes

Gets multiple notes from a ticket.

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.

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

  • ticketTypestringrequired

    Supported ticket type

    Enum:
    incidentsproblemsserviceRequeststimeBoundRequestschangeRequeststasks
  • ticketIdstringrequired

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

  • clientIdstringrequired

    Describes the clientId of the tenant

Query Parameters

  • pageNointeger

    page no

  • pageSizeinteger

    page size

    Default: 100

  • sortNamestring

    sort based on name

    Default: note.id

  • isDescendingOrderboolean

    sorting in descending

  • queryStringstring

    queryString for filtering

  • searchWordstring

    Search for a note with a specific word provided in the note.

  • startCreationDatestring

    Search for note created within a specific date range. startCreationDate denotes the from date.

  • idstring

    Note ID

  • endCreationDatestring

    endCreationDate denotes the to date.

  • endUpdationDatestring

    endUpdationDate denotes the to date.

  • startUpdationDatestring

    Search for the note updated within a specific date range. startUpdationDate denotes the from date.

00
post
/api/v2/tenants/{clientId}/{ticketType}/{ticketId}/notes

Creates ticket notes.

Path Parameters

  • ticketTypestringrequired

    Supported ticket type

    Enum:
    incidentsproblemsserviceRequeststimeBoundRequestschangeRequeststasks
  • ticketIdstringrequired

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

  • clientIdstringrequired

    Describes the clientId of the tenant

00
00