get
/v4/States
Returns all incident states available in the system.
CURL
curl -X GET \
-H "Accept: application/json" \
"http://localhost/v4/States?offset=56&limit=56&includeUsers=true"
Query parameters
offset
optional
Object
format: int32
This query parameter allows you to set the number of items to be skipped.
The default value for this parameter is 0. format: int32
The default value for this parameter is 0. format: int32
Example:
56
limit
optional
Object
format: int32
This query parameter allows you to set the number of items to retrieve. Maximum value: 100.
The default value for this parameter is 25. format: int32
The default value for this parameter is 25. format: int32
Example:
56
includeUsers
optional
Boolean
Used to expand the Allowed user from the state configuration, should be used when trying to get the configuration as a system
Example:
true
Responses
Success
Body
TotalResultsCount
optional
Integer
format: int32
Results
optional
Array
of objects
The Web API was unable to process the request due to a client error (malformed request syntax, size too large, invalid request message framing, or deceptive request routing).
The token you submitted was either invalid or expired.
The token you submitted was valid, but either did not grant sufficient privilege to access the requested resource, or the Web API license is not active.
The Web API was unable to process the request.
The Web API received an invalid response from the Incident Manager role.
The Web API did not receive a response to the request. The Incident Manager role might be down at the moment.