Add file to a service ticket

Prev Next
Post
/api/v1/maintenance/servicetickets/files

Uploads a file and links it to the service ticket.

Add file to a service ticket

This endpoint uploads a file and links it to an existing service ticket, for example a photo or supporting document related to the reported issue.

Each file must be uploaded in a separate request.

The ticket is identified by its internal reference, its external identifier, or both.


Request Fields

Field

Type

Required

Description

reference

string

Conditional

Internal identifier of the service ticket to attach the file to, passed as a query parameter. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values.

externalIdentifier

string

Conditional

External identifier of the service ticket to attach the file to, passed as a query parameter. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values.

File

string (binary)

Yes

The file to upload, sent as multipart/form-data (or as application/json with the same field name). This is the only field in the request body; reference and externalIdentifier are query parameters, not part of the body.


Response Fields

Field

Type

Required

Description

(response body)

integer (int64)

Yes

The response body is a single integer, the internal identifier generated by Bloxs for the uploaded file, not a JSON object with named fields.

Security
Query parameters
reference
string

The internal identifier of the model (i.e. Reference, Code, Name, depends on model).

externalIdentifier
string

The external API identifier of the model.

Body parameters
object
File
string (binary)
object
File
string (binary)
Responses
200

The file was created

400

No file was uploaded

404

There was a problem attaching the file to the service ticket

Expand All
object
type
string | null
title
string | null
traceId
string | null
status
integer (int32)
errors
object | null
property*
Array of string | null additionalProperties
string