Contents x
    Change service ticket state to Done
    • 09 May 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Change service ticket state to Done

    • Updated on 09 May 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /api/v1/maintenance/servicetickets/done

    [PREVIEW] Changes the service ticket state to Done.

    Description

    The user can call this endpoint to close a service ticket. When this endpoint is called, the status of the service ticket is set to 'done'.

    Use Case

    The Bloxs user wants to close a service ticket.

    Request fields

    The request contains the following fields:

    FieldDescription
    referenceThe 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.
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.


    Response fields

    The  200 response contains the following fields:

    FieldDescription
    referenceThe 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.
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
    messageThe 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

    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.

    Responses
    200

    The service ticket state was changed to Done

    object
    reference
    string | null
    externalIdentifier
    string | null
    message
    string
    Min length1
    400

    The service ticket state change has validation issues

    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
    404

    There was a problem changing the state of 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
    What's Next