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

Get operator by id

get

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

Get information for the specified operator. 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
Query Parameters
  • The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
  • The comma-separated list of fields to be shown in response. By default all response object fields will be present.
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 : 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

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.
Back to Top

Examples

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

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":"68f8313f6814-7abf",
    "factory":"The factory this operator belongs to",
    "integrationId":"3309354d71fd-5a11",
    "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 GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   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