Post
/api/v1/maintenance/servicetickets/notes
[PREVIEW] Create a new service ticket note.
Description
Endpoint to add a note to an existing report, or to transfer the history of notes from another system into Bloxs. Each note requires a separate call to this endpoint. As an alternative, users can generate a PDF of the notes history and submit it as a file using the XXXX API, which requires only a single call.
Use Case
The Bloxs user wants to add a note or a series of notes to a service ticket.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| reference | The unique identifier for this service ticket within Bloxs. This is unique (per client specific environment) for all service tickets. This identifier is generated by the Bloxs system. |
| externalIdentifier | The unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. |
| message | The comment associated with the note, for example to indicate why the note was created or to provide additional context or clarification. |
Security
HTTP
Type Bearer
Please enter a valid token
Body parameters
object
reference
string | null
externalIdentifier
string | null
message
string Required
Min length1
Responses
200
The service ticket note was created
object
reference
string | null
externalIdentifier
string | null
message
string
Min length1
400
The service ticket note data has validation issues
object
type
string | null
title
string | null
traceId
string | null
status
integer (int32)
errors
object | null
property*
Array of string | null additionalProperties
string
404
There was a problem creating the note for the service ticket
object
type
string | null
title
string | null
traceId
string | null
status
integer (int32)
errors
object | null
property*
Array of string | null additionalProperties
string