Update an existing service ticket.
Update a service ticket
This endpoint updates an existing service ticket.
The ticket to update is identified by its internal reference, its external identifier, or both; if both are given, they must refer to the same ticket, otherwise the request fails.
This endpoint does not accept realEstateObjectReference, reporterReference, reporterContactPersonReference, the reporterExternalContactPerson fields, or reportingDate. These are fixed at creation and cannot be changed through this endpoint. Any field that is accepted but not included in the request will be cleared, not left unchanged.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Conditional | Internal identifier of the ticket to update. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values. Maximum length 100 characters. |
externalIdentifier | string | Conditional | External identifier of the ticket to update, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values. Maximum length 100 characters. |
externalLink | string | No | URL of the ticket in a system outside of Bloxs. Maximum length 256 characters. |
stateName | string | Yes | Name of the ticket's state. States are configurable in the Bloxs admin module. Maximum length 256 characters. |
priority | integer | Yes | Priority of the report. Valid values are 1 (Low), 2 (Normal), or 3 (High). Fixed list, not configurable. |
problemCategoryName | string | No | Problem category the ticket belongs to. Fixed list, not configurable. Maximum length 256 characters. |
costsAreForTenant | boolean | No | Indicates whether the tenant is responsible for the costs of the ticket. Default value is false, meaning the owner is responsible. |
costCategoryName | string | No | Cost category of the ticket, used to determine how the associated costs should be allocated. Fixed list, not configurable. Maximum length 256 characters. |
description | string | Yes | Description of the reported problem. |
supplierReference | string | No | Reference of the supplier handling the ticket. Must be an existing relation in Bloxs. Maximum length 100 characters. |
handledBySupplier | boolean | No | Indicates whether the supplier has accepted responsibility for resolving the ticket. Default value is false. |
expectedCosts | number (double) | No | Estimated cost for resolving the issue. |
isVisibleInPortal_Owner | boolean | No | Indicates whether the ticket should be visible in the Owner Portal. Only effective if the service ticket portal visibility feature is enabled for the environment. |
isVisibleInPortal_Tenant | boolean | No | Indicates whether the ticket should be visible in the Tenant Portal. Only effective if the service ticket portal visibility feature is enabled for the environment. |
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. |
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. Not changeable through this endpoint. |
reporterReference | string | Yes | Reference of the relation to contact regarding the ticket. Not changeable through this endpoint. |
reporterContactPersonReference | string | No | Reference of the contact person for communication about the ticket. Not changeable through this endpoint. |
reporterExternalContactPersonName | string | No | Name of the contact person, if not registered in Bloxs. Not changeable through this endpoint. |
reporterExternalContactPersonPhoneNumber | string | No | Phone number of the contact person, if not registered in Bloxs. Not changeable through this endpoint. |
reporterExternalContactPersonMobileNumber | string | No | Mobile phone number of the contact person, if not registered in Bloxs. Not changeable through this endpoint. |
reporterExternalContactPersonEmail | string | No | Email address of the contact person, if not registered in Bloxs. Not changeable through this endpoint. |
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. |
Low = 1 Normal = 2 High = 3
The service ticket was updated
Low = 1 Normal = 2 High = 3
The service ticket data has validation issues