Create and Get Ticket Notes

Creates and gets ticket notes.

Gets multiple notes from a ticket.

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.

Responses

  • resultsarray

  • totalResultsinteger

  • orderBystring

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • nextPageNointeger

  • previousPageNointeger

  • descendingOrderboolean

Loading Examples...

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

Request Body

application/json

  • descriptionstring

Loading Examples...

Responses

  • idinteger

  • subjectstring

Loading Examples...