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

Retrieve operator type by ID

get

/productionMonitoring/clientapi/v2/operatorTypes/{type-id}

Ths operation retrieves information about the specified operator type. 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
  • Identifier created by the Oracle IoT Cloud Service for the operator type
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 : OperatorType_receive
Type: object
Show Source
Nested Schema : icon
Type: object
Binary object representing operator type icon.
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
The operator type's external entity properties as key, value pairs.
Show Source

401 Response

Unauthorized. The request requires user authentication.

403 Response

Forbidden. The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated.

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

Examples

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

Example of Response Body

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


{
    "description":"The description for the given operator type",
    "extId":"535956786343-4537",
    "icon":{
        "links":[
            {
                "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
                "rel":"self"
            },
            {
                "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
                "rel":"canonical"
            }
        ]
    },
    "id":"45b46f5713bf-b8a",
    "integrationId":"188e3b9c32e9-64e3",
    "lastModifiedTime":1469184297746,
    "lastModifiedTimeAsString":1469184297746,
    "modifiedBy":"The name of the user who last modified the definition of the operator type",
    "name":"User-defined unique name for the operator type",
    "properties":{
        "properties_key1":"properties_value1",
        "properties_key2":"properties_value2",
        "properties_key3":"properties_value3"
    },
    "registeredBy":"The name of the user who registered this operator type",
    "registrationTime":1469184297746,
    "registrationTimeAsString":1469184297746
}



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/operatorTypes/a22bef3e47-45af



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