Powered by Redocly

Notes

Ticket notes describe additional text and files connected to your tickets.

Note

Note that is linked to a ticket.

id
string <uuid>

Identifier of the note.

author_id
string <uuid>

Identifier of the author of the note.

author_name
string [ 0 .. 255 ] characters

Name of the note author.

categories
Array of any (NoteCategories) >= 0 items

Categories on the note.

Items Enum Value Description
pre-scan

pre-scan of the vehicle.

post-scan

post-scan of the vehicle.

created_at
string <date-time>

Date and time when the note was created.

is_public
boolean

Indicates if a note is publicly available.

ticket_id
string <uuid>

Identifier of the ticket.

updated_at
string or null <date-time>

Date and time when the note was updated.

value
string [ 0 .. 1500 ] characters

Value of the note.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "author_id": "78424c75-5c41-4b25-9735-3c9f7d05c59e",
  • "author_name": "string",
  • "categories": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_public": true,
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "value": "string"
}

Attachment

Attachment that is linked to a note linked to a ticket.

filename
string

Name of the attachment.

note_id
string <uuid>

Identifier of the note of a ticket.

signed_url
string <uri>

Url to download or upload the file of the attachment. Few things are important when using this url:

  • The url is valid for 1 minute when using an upload url.
  • The url is valid for 8 hours when using a download url.
  • When using the url its important to set the header Content-Type to the correct mime type of the file.
  • For more information about the upload and download urls see the documentation.
{
  • "filename": "string",
  • "note_id": "f37a7c27-f466-4182-88ae-001e80802cdc",
  • "signed_url": "http://example.com"
}

Retrieve notes

Retrieve a list of ticket notes.

SecurityOAuth2
Request
query Parameters
limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

ticket_id
required
string <uuid>

The identifier of the ticket of which you want to retrieve ticket notes.

Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Note) >= 0 items

List of ticket notes.

Array (>= 0 items)
id
string <uuid>

Identifier of the note.

author_id
string <uuid>

Identifier of the author of the note.

author_name
string [ 0 .. 255 ] characters

Name of the note author.

categories
Array of any (NoteCategories) >= 0 items

Categories on the note.

Items Enum Value Description
pre-scan

pre-scan of the vehicle.

post-scan

post-scan of the vehicle.

created_at
string <date-time>

Date and time when the note was created.

is_public
boolean

Indicates if a note is publicly available.

ticket_id
string <uuid>

Identifier of the ticket.

updated_at
string or null <date-time>

Date and time when the note was updated.

value
string [ 0 .. 1500 ] characters

Value of the note.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/tickets/notes
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Add ticket note

Add a note to a ticket.

SecurityOAuth2
Request
Request Body schema: application/json

The note you wish to add.

categories
Array of any (NoteCategories)

Categories on a note.

Items Enum Value Description
pre-scan

pre-scan of the vehicle.

post-scan

post-scan of the vehicle.

is_public
boolean
Default: false

Share note with customer.

ticket_id
required
string <uuid>

Identifier of the ticket.

value
required
string

Value of the note.

Responses
201

Created.

Response Schema: application/json
id
string <uuid>

Identifier of the note.

author_id
string <uuid>

Identifier of the author of the note.

author_name
string [ 0 .. 255 ] characters

Name of the note author.

categories
Array of any (NoteCategories) >= 0 items

Categories on the note.

Items Enum Value Description
pre-scan

pre-scan of the vehicle.

post-scan

post-scan of the vehicle.

created_at
string <date-time>

Date and time when the note was created.

is_public
boolean

Indicates if a note is publicly available.

ticket_id
string <uuid>

Identifier of the ticket.

updated_at
string or null <date-time>

Date and time when the note was updated.

value
string [ 0 .. 1500 ] characters

Value of the note.

default

An error occurred - see status code and problem response for more information.

post/v2/tickets/notes
Request samples
application/json
{
  • "categories": [
    ],
  • "is_public": false,
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "value": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "author_id": "78424c75-5c41-4b25-9735-3c9f7d05c59e",
  • "author_name": "string",
  • "categories": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_public": true,
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "value": "string"
}

Retrieve note

Retrieve a single note by its identifier.

SecurityOAuth2
Request
path Parameters
note-id
required
string <uuid>

The identifier of the note you want to edit.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Identifier of the note.

author_id
string <uuid>

Identifier of the author of the note.

author_name
string [ 0 .. 255 ] characters

Name of the note author.

categories
Array of any (NoteCategories) >= 0 items

Categories on the note.

Items Enum Value Description
pre-scan

pre-scan of the vehicle.

post-scan

post-scan of the vehicle.

created_at
string <date-time>

Date and time when the note was created.

is_public
boolean

Indicates if a note is publicly available.

ticket_id
string <uuid>

Identifier of the ticket.

updated_at
string or null <date-time>

Date and time when the note was updated.

value
string [ 0 .. 1500 ] characters

Value of the note.

default

An error occurred - see status code and problem response for more information.

get/v2/tickets/notes/{note-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "author_id": "78424c75-5c41-4b25-9735-3c9f7d05c59e",
  • "author_name": "string",
  • "categories": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_public": true,
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "value": "string"
}

Update note

Update note for a ticket.

SecurityOAuth2
Request
path Parameters
note-id
required
string <uuid>

The identifier of the note you want to edit.

Request Body schema: application/json
categories
Array of any (NoteCategories)

Categories on a note.

Items Enum Value Description
pre-scan

pre-scan of the vehicle.

post-scan

post-scan of the vehicle.

is_public
boolean
Default: false

Share note with customer.

ticket_id
required
string <uuid>

Identifier of the ticket.

value
required
string

Value of the note.

Responses
200

OK.

Response Schema: application/json
id
string <uuid>

Identifier of the note.

author_id
string <uuid>

Identifier of the author of the note.

author_name
string [ 0 .. 255 ] characters

Name of the note author.

categories
Array of any (NoteCategories) >= 0 items

Categories on the note.

Items Enum Value Description
pre-scan

pre-scan of the vehicle.

post-scan

post-scan of the vehicle.

created_at
string <date-time>

Date and time when the note was created.

is_public
boolean

Indicates if a note is publicly available.

ticket_id
string <uuid>

Identifier of the ticket.

updated_at
string or null <date-time>

Date and time when the note was updated.

value
string [ 0 .. 1500 ] characters

Value of the note.

put/v2/tickets/notes/{note-id}
Request samples
application/json
{
  • "categories": [
    ],
  • "is_public": false,
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "value": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "author_id": "78424c75-5c41-4b25-9735-3c9f7d05c59e",
  • "author_name": "string",
  • "categories": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_public": true,
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "value": "string"
}

Delete ticket note

Delete a ticket note. This will also delete all attachments linked to the note.

SecurityOAuth2
Request
path Parameters
note-id
required
string <uuid>

The identifier of the note you want to edit.

Responses
204

OK.

delete/v2/tickets/notes/{note-id}

Retrieve note attachments

Retrieve a list of note attachments.

SecurityOAuth2
Request
query Parameters
limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

note_id
required
string <uuid>

The identifier of the note of which you want to retrieve note attachments.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Attachment) >= 0 items

List of note attachments.

Array (>= 0 items)
filename
string

Name of the attachment.

note_id
string <uuid>

Identifier of the note of a ticket.

signed_url
string <uri>

Url to download or upload the file of the attachment. Few things are important when using this url:

  • The url is valid for 1 minute when using an upload url.
  • The url is valid for 8 hours when using a download url.
  • When using the url its important to set the header Content-Type to the correct mime type of the file.
  • For more information about the upload and download urls see the documentation.
total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/tickets/note-attachments
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Add note attachment

Generate signed url for note attachment.

SecurityOAuth2
Request
Request Body schema: application/json
filename
required
string

Name of the file plus extension.

note_id
required
string <uuid>

The identifier of the note.

Responses
200

Successful response.

Response Schema: application/json
filename
string

Name of the attachment.

note_id
string <uuid>

Identifier of the note of a ticket.

signed_url
string <uri>

Url to download or upload the file of the attachment. Few things are important when using this url:

  • The url is valid for 1 minute when using an upload url.
  • The url is valid for 8 hours when using a download url.
  • When using the url its important to set the header Content-Type to the correct mime type of the file.
  • For more information about the upload and download urls see the documentation.
default

An error occurred - see status code and problem response for more information.

post/v2/tickets/note-attachments
Request samples
application/json
{
  • "filename": "image.png",
  • "note_id": "f37a7c27-f466-4182-88ae-001e80802cdc"
}
Response samples
application/json
{
  • "filename": "string",
  • "note_id": "f37a7c27-f466-4182-88ae-001e80802cdc",
  • "signed_url": "http://example.com"
}

Retrieve note attachment

Retrieve a single note attachment by its identifier.

SecurityOAuth2
Request
path Parameters
note-id
required
string <uuid>

The identifier of the note of which you want to retrieve the note attachment.

filename
required
string

The filename of the note attachment you want to retrieve.

Responses
200

Successful response.

Response Schema: application/json
filename
string

Name of the attachment.

note_id
string <uuid>

Identifier of the note of a ticket.

signed_url
string <uri>

Url to download or upload the file of the attachment. Few things are important when using this url:

  • The url is valid for 1 minute when using an upload url.
  • The url is valid for 8 hours when using a download url.
  • When using the url its important to set the header Content-Type to the correct mime type of the file.
  • For more information about the upload and download urls see the documentation.
default

An error occurred - see status code and problem response for more information.

get/v2/tickets/note-attachments/{note-id}/{filename}
Response samples
application/json
{
  • "filename": "string",
  • "note_id": "f37a7c27-f466-4182-88ae-001e80802cdc",
  • "signed_url": "http://example.com"
}
➔ Next to Used diagnostic equipment