getStatuses

A Graze API GET request that returns a list of statuses that can apply to Situations and their IDs.

Request arguments

Endpoint getStatuses takes the following request arguments:

Name	Type	Required	Description
`auth_token`	String	Yes	A valid `auth_token` returned from the `authenticate` request. Alternatively, basic authenticate headers can be used in place of this parameter. See the authenticate endpoint for more information and usage examples.

There are no other arguments because this endpoint returns data on all statuses.

Response

Endpoint getStatuses returns the following response:

Type	Description
HTTP Code	HTTP status or error code indicating request success or failure. See HTTP status code definitions for more information.

Successful requests return an array of JSON objects containing the following:

Name	Type	Description
`status_id`	Number	ID of the status.
`name`	String	Status name.

Examples

The following examples demonstrate typical use of endpoint getStatuses:

Request example

Example cURL request to return a list of statuses:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getStatuses"

Response example

Example response returning a list of statuses:

[
   {
        "status_id": 1,
        "name": "Opened"
   }, 
   {
        "status_id": 2,
        "name": "Unassigned"
   }, 
   {
        "status_id": 3,
        "name": "Assigned"
   }, 
   {
        "status_id": 4,
        "name": "Acknowledged"
   }, 
   {
        "status_id": 5,
        "name": "Unacknowledged"
   }, 
   {
        "status_id": 6,
        "name": "Active"
   }, 
   {
        "status_id": 7,
        "name": "Dormant"
   }, 
   {
        "status_id": 8,
        "name": "Resolved"
   }, 
   {
        "status_id": 9,
        "name": "Closed"
   }, 
   {
        "status_id": 10,
        "name": "SLA Exceeded"
   }
]

In this section: