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

Replace operator by id

put

/productionMonitoring/clientapi/v2/operators/{operator-username}

Replace the specified operator information with the provided operator definition. 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
  • 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 : Operator_create
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : Operator_receive
Type: object
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
The machine's external entity properties as key, value pairs.
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.

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 PUT 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   https://iotserver/productionMonitoring/clientapi/v2/operators/{operator-username}

Example of Request Body

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


{
    "description":"Description about the operator",
    "email":"The email address of the operator. IDCS user will be created if value is provided",
    "factory":"The factory this operator belongs to",
    "state":"State of the operatorOne of [NOT_AVAILABLE, WORKING, IDLE, UNKNOWN].",
    "stateModifiedTime":1469184297746,
    "type":"Type of the operator",
    "username":"Username of the operator"
}

Example of Response Body

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


{
    "description":"Description about the operator",
    "email":"The email address of the operator. IDCS user will be created if value is provided",
    "extId":"72637d5178f6-7eff",
    "factory":"The factory this operator belongs to",
    "integrationId":"580f75886384-32c1",
    "lastModifiedBy":"Name of the user who last modified the definition of the operator",
    "lastModifiedTime":1469184297746,
    "lastModifiedTimeAsString":1469184297746,
    "properties":{
        "properties_key1":"properties_value1",
        "properties_key2":"properties_value2",
        "properties_key3":"properties_value3"
    },
    "registeredBy":"Name of the user who registered this operator",
    "registrationTime":1469184297746,
    "registrationTimeAsString":1469184297746,
    "state":"State of the operatorOne of [NOT_AVAILABLE, WORKING, IDLE, UNKNOWN].",
    "type":"Type of the operator",
    "username":"Username of the operator"
}



Complete cURL Example

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

curl -X PUT 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json'  
   -d '{"description":"Description about the operator","email":"The email address of the operator. IDCS user will be created if value is provided","factory":"The factory this operator belongs to","state":"State of the operatorOne of [NOT_AVAILABLE, WORKING, IDLE, UNKNOWN].","stateModifiedTime":1469184297746,"type":"Type of the operator","username":"Username of the operator"}'
   https://iotserver/productionMonitoring/clientapi/v2/operators/{operator-username}



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