Skip to main content
GET
The statuses each register can be in, with how the screens should draw them.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
entity_type
string
state_model_id
string
state_model_version_id
string
code
string
display_name
string
category
string
color
string
icon
string
sort_order
string
is_active
string
is_initial
string
is_terminal
string
counts_as_open
string
counts_as_active
string
counts_as_downtime
string
counts_as_accepted
string
stops_sla
string
pauses_sla
string
allows_technician_edit
string
allows_parts_consumption
string
allows_labour_entry
string
allows_attachments
string
allows_cancellation
string
allows_reopen
string
offline_allowed
string
row_version
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

allows_attachments
boolean<boolean>
allows_cancellation
boolean<boolean>
allows_labour_entry
boolean<boolean>
allows_parts_consumption
boolean<boolean>
allows_reopen
boolean<boolean>
allows_technician_edit
boolean<boolean>
category
string<character varying>
Maximum string length: 20
code
string<character varying>
Maximum string length: 60
color
string<character varying>
Maximum string length: 20
counts_as_accepted
boolean<boolean>
counts_as_active
boolean<boolean>
counts_as_downtime
boolean<boolean>
counts_as_open
boolean<boolean>
display_name
string<character varying>
Maximum string length: 150
entity_type
string<character varying>
Maximum string length: 80
icon
string<character varying>
Maximum string length: 60
id
string<uuid>

Note: This is a Primary Key.

is_active
boolean<boolean>
is_initial
boolean<boolean>
is_terminal
boolean<boolean>
offline_allowed
boolean<boolean>
pauses_sla
boolean<boolean>
row_version
integer<bigint>
sort_order
integer<integer>
state_model_id
string<uuid>

Note: This is a Primary Key.

state_model_version_id
string<uuid>

Note: This is a Foreign Key to state_models.version_id.

stops_sla
boolean<boolean>