Retrieve warning by ID
get
/productionMonitoring/clientapi/v2/warnings/{warning-id}
This operation returns information about a warning that is specified by its ID. 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
Path Parameters
-
warning-id: string
The unique identifier of the warning
Query Parameters
-
expand(optional): string
The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
-
fields(optional): string
The comma-separated list of fields to be shown in response. By default all response object fields will be present.
Header Parameters
-
X-ORACLE-IOT-ORG: string
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.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Root Schema : ProductionWarning_receive
Type:
Show Source
object
-
contextInformation:
object ContextInformationModel_receive
-
createdBy:
string
User ID or a special ID reserved for IoT CS.
-
createdTime:
integer
Date of the warning creation.
-
description:
string
Detailed description of the warning.
-
duration:
integer
Duration is a time period between generating of a warning and a moment of time when a rule predicate(-s) generate false result.
-
geoLocation:
string
The geo location where the warning was first reported.
-
id:
string
Unique identifier of the warning.
-
lastModifiedBy:
string
User ID or a special ID reserved for IoT CS.
-
lastModifiedTime:
integer
Date of the warning modification.
-
level:
string
Specifies a warning level.One of [LOW, MEDIUM, HIGH].
-
rule:
string
Id of rule the warning was created for.
-
state:
string
Specifies a warning state.One of [ACTIVE, RESOLVED].
-
summary:
string
Short description of the warning.
-
tags:
array tags
Tags assigned to the warning.
-
type:
string
Specified type of the warning.
Nested Schema : ContextInformationModel_receive
Type:
Show Source
object
-
affectedObjects:
array affectedObjects
Property description was not set
-
occurrences:
array occurrences
Property description was not set
Nested Schema : ProductionMonitoringWarningAffectedObject_receive
Type:
Show Source
object
-
factoryId:
string
Property description was not set
-
id:
string
Property description was not set
-
machineTypeId:
string
Property description was not set
-
machineTypeName:
string
Property description was not set
-
name:
string
Property description was not set
-
workOrderId:
string
Property description was not set
Nested Schema : RuleOccurrence_receive
Type:
Show Source
object
-
id:
string
Property description was not set
-
incidentId:
string
Property description was not set
-
satisfiedPredicates:
array satisfiedPredicates
Property description was not set
-
time:
integer
Property description was not set
Nested Schema : SatisfiedPredicate_receive
Type:
Show Source
object
-
information:
object information
Additional Properties Allowed: additionalPropertiesProperty description was not set
-
type:
string
Property description was not set
Nested Schema : information
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
Property description was not set
Show Source
401 Response
Unauthorized. The request requires user authentication.
404 Response
Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.
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.
Examples
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/productionMonitoring/clientapi/v2/warnings/{warning-id}
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"contextInformation":{
"affectedObjects":[
{
"factoryId":"17923a133202-95f",
"id":"133f403a894-58a5",
"machineTypeId":"6dea71211d-2dd0",
"machineTypeName":"Property description was not set",
"name":"Property description was not set",
"workOrderId":"7d470e656b-6033"
}
],
"occurrences":[
{
"id":"655344703526-21d1",
"incidentId":"62e62d056b6d-5c12",
"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":"1d47612ce9a-a57",
"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."
}
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/2d38b6b1cea-76c3
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.