Moogsoft Docs

getSeverities

A Graze API GET request that returns a list of possible severities and their severity IDs.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint getSeverities takes the following request argument:

Name

Type

Required

Description

auth_token

String

Yes

A valid auth_token returned from the authenticate request. See the authenticate endpoint for more information.

There are no other arguments, as this endpoint returns data on all severities.

Response

Endpoint getSeverities returns the following response:

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

Name

Type

Description

name

String

Severity name.

severity_id

Number

ID of the severity.

Examples

The following examples demonstrate typical use of endpoint getSeverities:

Request example

Example cURL request to return the list of all severities:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getSeverities"
Response example

Example response returning a list of all severities:

[{
        "name": "Clear",
        "severity_id": 0
}, {
        "name": "Indeterminate",
        "severity_id": 1
}, {
        "name": "Warning",
        "severity_id": 2
}, {
        "name": "Minor",
        "severity_id": 3
}, {
        "name": "Major",
        "severity_id": 4
}, {
        "name": "Critical",
        "severity_id": 5
}]