Changes the service ticket state to Done.
Change service ticket state to Done
This endpoint sets the state of an existing service ticket to Done, closing it out.
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 close. 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 close, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values. |
closingDate | string (date-time) | No | Date and time the ticket was closed. If omitted, Bloxs populates this automatically depending on configuration. Used for reporting on process duration. ISO 8601 format. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Yes | Internal identifier of the service ticket, generated by Bloxs. |
externalIdentifier | string | No | External identifier of the ticket, as set by the integrating system. |
externalLink | string | No | URL of the ticket in a system outside of Bloxs. |
reportingDate | string (date) | Yes | Date the ticket was created. |
stateName | string | Yes | Name of the ticket's current state. Expected to reflect the Done state after this operation. |
priority | integer | Yes | Priority of the report. Valid values are 1 (Low), 2 (Normal), or 3 (High). |
problemCategoryName | string | No | Problem category the ticket belongs to. |
costsAreForTenant | boolean | No | Indicates whether the tenant is responsible for the costs of the ticket. |
costCategoryName | string | No | Cost category of the ticket. |
description | string | Yes | Description of the reported problem. |
realEstateObjectReference | string | Yes | Reference of the real estate object the ticket applies to. |
reporterReference | string | Yes | Reference of the relation to contact regarding the ticket. |
reporterContactPersonReference | string | No | Reference of the contact person for communication about the ticket. |
reporterExternalContactPersonName | string | No | Name of the contact person, if not registered in Bloxs. |
reporterExternalContactPersonPhoneNumber | string | No | Phone number of the contact person, if not registered in Bloxs. |
reporterExternalContactPersonMobileNumber | string | No | Mobile phone number of the contact person, if not registered in Bloxs. |
reporterExternalContactPersonEmail | string | No | Email address of the contact person, if not registered in Bloxs. |
supplierReference | string | No | Reference of the supplier handling the ticket. |
handledBySupplier | boolean | No | Indicates whether the supplier has accepted responsibility for resolving the ticket. |
expectedCosts | number (double) | No | Estimated cost for resolving the issue. |
mandateAmount | number (double) | No | Maximum amount for which the supplier has the mandate to resolve the issue underlying the ticket. |
disableUIMutations | boolean | No | Indicates whether changes to the ticket are disabled in the Bloxs application. |
disableSystemTasks | boolean | No | Indicates whether the system tasks triggered by the ticket's priority are disabled. |
disableSystemCorrespondence | boolean | No | Indicates whether automatic system-generated correspondence for the ticket is disabled. |
isVisibleInPortal_Owner | boolean | Yes | Indicates whether the ticket is visible in the Owner Portal. |
isVisibleInPortal_Tenant | boolean | Yes | Indicates whether the ticket is visible in the Tenant Portal. |
The service ticket state was changed to Done
Low = 1 Normal = 2 High = 3
The service ticket state change has validation issues
There was a problem changing the state of the service ticket