1. REST API for Oracle IoT Production Monitoring Cloud Service
  2. Tasks
  3. Warnings

Retrieve all warnings

get

/productionMonitoring/clientapi/v2/warnings

This operation returns information about all the warnings that are filtered by a query. This method supports the request header with name 'X-ORACLE-IOT-ORG', which allows targeting requests to different organizations. The value of this request header should contain the organization identifier.

Request

Query Parameters
Header Parameters
  • This method supports the request header with name 'X-ORACLE-IOT-ORG', which allows targeting requests to different organizations. The value of this request header should contain the organization identifier.
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : ProductionWarning_receive_list
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : ContextInformationModel_receive
Type: object
Show Source
Nested Schema : tags
Type: array
Tags assigned to the warning.
Show Source
Nested Schema : affectedObjects
Type: array
Property description was not set
Show Source
Nested Schema : occurrences
Type: array
Property description was not set
Show Source
Nested Schema : ProductionMonitoringWarningAffectedObject_receive
Type: object
Show Source
Nested Schema : RuleOccurrence_receive
Type: object
Show Source
Nested Schema : satisfiedPredicates
Type: array
Property description was not set
Show Source
Nested Schema : SatisfiedPredicate_receive
Type: object
Show Source
Nested Schema : information
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source

401 Response

Unauthorized. The request requires user authentication.

406 Response

Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
Back to Top

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/productionMonitoring/clientapi/v2/warnings

Example of Response Body

The following example shows the content of the response body in JSON format:


{
    "count":2,
    "hasMore":false,
    "items":[
        {
            "contextInformation":{
                "affectedObjects":[
                    {
                        "factoryId":"759d14df2489-4304",
                        "id":"26b27f826432-7faf",
                        "machineTypeId":"66431e9442de-17a8",
                        "machineTypeName":"Property description was not set",
                        "name":"Property description was not set",
                        "workOrderId":"70bc2351295d-379e"
                    }
                ],
                "occurrences":[
                    {
                        "id":"1a4a4aa934fe-143f",
                        "incidentId":"2f0e4e4b2fcf-3fce",
                        "satisfiedPredicates":[
                            {
                                "information":{
                                    "information_key1":"information_value1",
                                    "information_key2":"information_value2",
                                    "information_key3":"information_value3"
                                },
                                "type":"Property description was not set"
                            }
                        ],
                        "time":12345
                    }
                ]
            },
            "createdBy":"User ID or a special ID reserved for IoT CS.",
            "createdTime":1469184297746,
            "description":"Detailed description of the warning.",
            "duration":12345,
            "geoLocation":"The geo location where the warning was first reported.",
            "id":"3c9520b344b3-310d",
            "lastModifiedBy":"User ID or a special ID reserved for IoT CS.",
            "lastModifiedTime":1469184297746,
            "level":"Specifies a warning level.One of [LOW, MEDIUM, HIGH].",
            "rule":"Id of rule the warning was created for.",
            "state":"Specifies a warning state.One of [ACTIVE, RESOLVED].",
            "summary":"Short description of the warning.",
            "tags":[
                "tags_1",
                "tags_2",
                "tags_3"
            ],
            "type":"Specified type of the warning."
        },
        {
            "contextInformation":{
                "affectedObjects":[
                    {
                        "factoryId":"218263c77483-51c8",
                        "id":"704c9316f66-cb6",
                        "machineTypeId":"69e570476c02-1a7b",
                        "machineTypeName":"Property description was not set",
                        "name":"Property description was not set",
                        "workOrderId":"13721831eff-a02"
                    }
                ],
                "occurrences":[
                    {
                        "id":"a7024d57fe-754c",
                        "incidentId":"6c87728267e7-385e",
                        "satisfiedPredicates":[
                            {
                                "information":{
                                    "information_key1":"information_value1",
                                    "information_key2":"information_value2",
                                    "information_key3":"information_value3"
                                },
                                "type":"Property description was not set"
                            }
                        ],
                        "time":12345
                    }
                ]
            },
            "createdBy":"User ID or a special ID reserved for IoT CS.",
            "createdTime":1469184297746,
            "description":"Detailed description of the warning.",
            "duration":12345,
            "geoLocation":"The geo location where the warning was first reported.",
            "id":"148016ba3be7-685c",
            "lastModifiedBy":"User ID or a special ID reserved for IoT CS.",
            "lastModifiedTime":1469184297746,
            "level":"Specifies a warning level.One of [LOW, MEDIUM, HIGH].",
            "rule":"Id of rule the warning was created for.",
            "state":"Specifies a warning state.One of [ACTIVE, RESOLVED].",
            "summary":"Short description of the warning.",
            "tags":[
                "tags_1",
                "tags_2",
                "tags_3"
            ],
            "type":"Specified type of the warning."
        }
    ],
    "limit":10,
    "links":[
        {
            "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
            "rel":"self"
        },
        {
            "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
            "rel":"canonical"
        }
    ],
    "offset":0
}



Complete cURL Example

The following example shows a complete cURL command that you can use to perform the described operation:

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/productionMonitoring/clientapi/v2/warnings



Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.
Back to Top