Get all service ticket states
- 09 May 2025
- 1 Minute to read
- Print
- DarkLight
Get all service ticket states
- Updated on 09 May 2025
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Get
/api/v1/maintenance/servicetickets/states
[PREVIEW] Get all service ticket states in the system.
Description
Service tickets have to be assigned a status. However, in order to add the correct status the Bloxs user needs to know which statuses are available in the application. This endpoint can be used to retrieve the available states. This is a standard list, however it can be edited by the user in the Bloxs application (it is not possible through the API).
The response provides the full list of available statuses as an array.
Use Case
The PUT/servicetickets operation is used to update a service ticket. As part of this update, the user has to specify the status associated with the service ticket. However, the user may not know which statuses are available. This endpoint can be used to retrieve the full list of available statuses.
Response fields
The response contains the fields in the table below. For every status this property will be shown separately in the array.
| Field | Description |
|---|---|
| name | Name of the status. |
| systemState | This is the system status linked to the main status. Please note: this is only populated for the default statuses available in Bloxs, not for custom statuses created by users. For user-created statuses, the systemState will return a value of null. The system status can trigger certain actions within Bloxs, such as sending a reminder when a status is set to 'on hold'. User control over these actions is limited. |
Security
HTTP
Type Bearer
Please enter a valid token
Responses
200
OK
Array of object
object
name
string | null
systemState
integer (int32)
1 = Active
2 = OnHold
3 = SignedOff
4 = Done
Valid values[ \1\, \2\, \3\, \4\ ]