getSigCorrelationInfo

A Graze API GET request that returns all correlation information related to a specified Situation.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint getSigCorrelationInfo takes the following request arguments:

Name

Type

Required

Description

auth_token

String

Yes

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

sitn_id

Number

Yes

Situation ID.

Response

Endpoint getSigCorrelationInfo returns the following response:

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

Name

Type

Description

sig_id

Number

Situation ID.

service_name

String

Service name.

external_id

String

External ID.

properties

List of Strings

Properties of the Situation.

Examples

The following examples demonstrate typical use of endpoint getSigCorrelationInfo:

Request example

Example cURL request to return the correlation information for Situation ID 5:

curl -X GET -u graze:graze -k -v "https://localhost/graze/v1/getSigCorrelationInfo?sitn_id=5" \
-H "Content-Type: application/json; charset=UTF-8"

Response example

Example response returning :

[
    {
        "sig_id": 1, 
        "service_name": "Example1", 
        "external_id": "Example1",
        "properties": "{"Example1":"Example1"}
    },
    {
        "sig_id": 2,
        "service_name": "Example2",
        "external_id": "Example2",
        "properties": "{"Example2":"Example2"}
    }
]