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

Update incident by ID

post

/productionMonitoring/clientapi/v2/incidents/{incident-id}

This operation updates information about an incident specified by its ID with the provided incident definition that is partial or complete. 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

Supported Media Types
Path Parameters
Header Parameters
  • To perform a partial update of the incident, the POST request should be orchestrated with method override set to PATCH
  • 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.
Body ()
Root Schema : ProductionIncident_update
Type: object
Show Source
Nested Schema : affectedObjects
Type: array
Property description was not set
Show Source
Nested Schema : comments
Type: array
Comments
Show Source
Nested Schema : ContextInformationModel_update
Type: object
Show Source
Nested Schema : metadata
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
incident metadata map
Show Source
Nested Schema : tags
Type: array
Tags assigned to the incident
Show Source
Nested Schema : AffectedObject_update
Type: object
Show Source
Nested Schema : productsManufactured
Type: array
Property description was not set
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : ProductionIncidentAffectedObject$Plan_update
Type: object
Show Source
Nested Schema : IncidentCommentModel_update
Type: object
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_update
Type: object
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : RuleOccurrence_update
Type: object
Show Source
Nested Schema : satisfiedPredicates
Type: array
Property description was not set
Show Source
Nested Schema : SatisfiedPredicate_update
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
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : ProductionIncident_receive
Type: object
Show Source
Nested Schema : comments
Type: array
Comments
Show Source
Nested Schema : ContextInformationModel_receive
Type: object
Show Source
Nested Schema : metadata
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
incident metadata map
Show Source
Nested Schema : tags
Type: array
Tags assigned to the incident
Show Source
Nested Schema : IncidentCommentModel_receive
Type: object
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

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

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.

405 Response

Method Not Allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

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.

415 Response

Unsupported Media Type. The request entity has a media type which the server or resource does not support.
Back to Top

Examples

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   --header "X-HTTP-Method-Override: PATCH" 
   https://iotserver/productionMonitoring/clientapi/v2/incidents/{incident-id}

Example of Request Body

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


{
    "affectedObjects":[
        {
            "factoryId":"783a12b97983-558a",
            "id":"5805444e184b-2a6f",
            "machineId":"68d16bf821d7-15d7",
            "machineTypeId":"3cbe6ef56aee-73c6",
            "machineTypeName":"Property description was not set",
            "name":"Property description was not set",
            "productionLineId":"f1a4ec77c8d-6200",
            "productsManufactured":[
                {
                    "productId":"2c97417413-19ba",
                    "routingTaskId":"748b27929e3-2568"
                }
            ],
            "properties":{
                "properties_key1":"properties_value1",
                "properties_key2":"properties_value2",
                "properties_key3":"properties_value3"
            },
            "workOrderId":"3b0a5dc57316-7cd5"
        }
    ],
    "contextInformation":{
        "affectedObjects":[
            {
                "factoryId":"35876547eca-2a1f",
                "id":"6c4322a263a2-698e",
                "machineTypeId":"cb868d24379-5818",
                "machineTypeName":"Property description was not set",
                "name":"Property description was not set",
                "properties":{
                    "properties_key1":"properties_value1",
                    "properties_key2":"properties_value2",
                    "properties_key3":"properties_value3"
                },
                "workOrderId":"4a5323142404-40be"
            }
        ],
        "occurrences":[
            {
                "id":"292573db787b-119f",
                "incidentId":"256e2c0c6476-5149",
                "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,
    "createdTimeAsString":1469184297746,
    "delayedModel":false,
    "description":"Detailed description",
    "geoLocation":"incident geoLocation",
    "id":"48621c1f78a3-6bbc",
    "incidentTime":1469184297746,
    "incidentTimeAsString":1469184297746,
    "lastModifiedBy":"last modified by",
    "lastModifiedTime":1469184297746,
    "lastModifiedTimeAsString":1469184297746,
    "metadata":{
        "metadata_key1":"metadata_value1",
        "metadata_key2":"metadata_value2",
        "metadata_key3":"metadata_value3"
    },
    "priority":"Incident priorityOne of [LOW, MEDIUM, HIGH].",
    "rule":"Id of rule the incident was created for. May be null if the incident was created manually",
    "state":"Incident stateOne of [NEW, OPEN, WORK_IN_PROGRESS, RESOLVED, WITHDRAWN].",
    "summary":"Short high-level description",
    "tags":[
        "tags_1",
        "tags_2",
        "tags_3"
    ],
    "type":"Type of Incident"
}

Example of Response Body

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


{
    "comments":[
        {
            "createdBy":"Author of Incident comment",
            "createdTime":1469184297746,
            "state":"State of Incident comment",
            "text":"Text of Incident comment",
            "type":"Type of Incident comment, One of [USER_DEFINED, LIFECYCLE_STATE_TRANSITION]."
        }
    ],
    "contextInformation":{
        "affectedObjects":[
            {
                "factoryId":"5e7b100a3976-23a9",
                "id":"343d114f1d11-5d29",
                "machineTypeId":"2e6463c1571d-76ed",
                "machineTypeName":"Property description was not set",
                "name":"Property description was not set",
                "workOrderId":"136a637d1e08-5d07"
            }
        ],
        "occurrences":[
            {
                "id":"1fda4be82a99-64b7",
                "incidentId":"174750eecd6-5290",
                "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,
    "createdTimeAsString":1469184297746,
    "description":"Detailed description",
    "geoLocation":"incident geoLocation",
    "id":"7abc7b68701d-7420",
    "incidentTime":1469184297746,
    "incidentTimeAsString":1469184297746,
    "lastModifiedBy":"last modified by",
    "lastModifiedTime":1469184297746,
    "lastModifiedTimeAsString":1469184297746,
    "metadata":{
        "metadata_key1":"metadata_value1",
        "metadata_key2":"metadata_value2",
        "metadata_key3":"metadata_value3"
    },
    "priority":"Incident priorityOne of [LOW, MEDIUM, HIGH].",
    "rule":"Id of rule the incident was created for. May be null if the incident was created manually",
    "state":"Incident stateOne of [NEW, OPEN, WORK_IN_PROGRESS, RESOLVED, WITHDRAWN].",
    "summary":"Short high-level description",
    "tags":[
        "tags_1",
        "tags_2",
        "tags_3"
    ],
    "type":"Type of Incident"
}



Complete cURL Example

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

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   --header "X-HTTP-Method-Override: PATCH"  
   -d '{"affectedObjects":[{"factoryId":"783a12b97983-558a","id":"5805444e184b-2a6f","machineId":"68d16bf821d7-15d7","machineTypeId":"3cbe6ef56aee-73c6","machineTypeName":"Property description was not set","name":"Property description was not set","productionLineId":"f1a4ec77c8d-6200","productsManufactured":[{"productId":"2c97417413-19ba","routingTaskId":"748b27929e3-2568"}],"properties":{"properties_key1":"properties_value1","properties_key2":"properties_value2","properties_key3":"properties_value3"},"workOrderId":"3b0a5dc57316-7cd5"}],"contextInformation":{"affectedObjects":[{"factoryId":"35876547eca-2a1f","id":"6c4322a263a2-698e","machineTypeId":"cb868d24379-5818","machineTypeName":"Property description was not set","name":"Property description was not set","properties":{"properties_key1":"properties_value1","properties_key2":"properties_value2","properties_key3":"properties_value3"},"workOrderId":"4a5323142404-40be"}],"occurrences":[{"id":"292573db787b-119f","incidentId":"256e2c0c6476-5149","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,"createdTimeAsString":1469184297746,"delayedModel":false,"description":"Detailed description","geoLocation":"incident geoLocation","id":"48621c1f78a3-6bbc","incidentTime":1469184297746,"incidentTimeAsString":1469184297746,"lastModifiedBy":"last modified by","lastModifiedTime":1469184297746,"lastModifiedTimeAsString":1469184297746,"metadata":{"metadata_key1":"metadata_value1","metadata_key2":"metadata_value2","metadata_key3":"metadata_value3"},"priority":"Incident priorityOne of [LOW, MEDIUM, HIGH].","rule":"Id of rule the incident was created for. May be null if the incident was created manually","state":"Incident stateOne of [NEW, OPEN, WORK_IN_PROGRESS, RESOLVED, WITHDRAWN].","summary":"Short high-level description","tags":["tags_1","tags_2","tags_3"],"type":"Type of Incident"}'
   https://iotserver/productionMonitoring/clientapi/v2/incidents/65a244bf24b9-736f



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