REST API for Oracle IoT Production Monitoring Cloud Service

Get all operators

get

/productionMonitoring/clientapi/v2/operators

Get information about all the operators filtered by a query. 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

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.
limit(optional): integer

The maximum number of entries to return to the end user.
offset(optional): integer

The number that the first record of results is starting from.
orderBy(optional): string

Ordering criteria for the returned operator list
q(optional): string

Query to filter operators on the server (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)
since(optional): integer

The starting point of the desired time interval, in milliseconds. The default is 0.
totalResults(optional): boolean

The total number of results suiting the request.
until(optional): integer

The finishing point of the desired time interval, in milliseconds. The default is 0.

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=collection

200 Response

Successfully processed.

Root Schema : Operator_receive_list

Type: object

Show Source

count: integer(int32)
hasMore: boolean
items: array items
limit: integer(int32)
links: array links

The set of API navigation links.
offset: integer(int32)

{
    "properties":{
        "count":{
            "format":"int32",
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "items":{
                "properties":{
                    "description":{
                        "description":"Description about the operator",
                        "type":"string"
                    },
                    "email":{
                        "description":"The email address of the operator. IDCS user will be created if value is provided",
                        "type":"string"
                    },
                    "extId":{
                        "description":"The external identifier representing the external operator imported",
                        "type":"string"
                    },
                    "factory":{
                        "description":"The factory this operator belongs to",
                        "type":"string"
                    },
                    "integrationId":{
                        "description":"The integration identifier that imported the operator",
                        "type":"string"
                    },
                    "lastModifiedBy":{
                        "description":"Name of the user who last modified the definition of the operator",
                        "type":"string"
                    },
                    "lastModifiedTime":{
                        "description":"The time when the operator definition was last updated as an epoch milliseconds",
                        "type":"integer"
                    },
                    "lastModifiedTimeAsString":{
                        "description":"The time when the operator definition was last updated as an ISO-8601 formatted string",
                        "type":"integer"
                    },
                    "properties":{
                        "additionalProperties":{
                            "description":"A map of the following type: Map&lt;String, String&gt;",
                            "type":"string"
                        },
                        "description":"The machine's external entity properties as key, value pairs.",
                        "properties":{
                        },
                        "type":"object"
                    },
                    "registeredBy":{
                        "description":"Name of the user who registered this operator",
                        "type":"string"
                    },
                    "registrationTime":{
                        "description":"The time when the operator was registered with the app as an epoch milliseconds",
                        "type":"integer"
                    },
                    "registrationTimeAsString":{
                        "description":"The time when the operator was registered with the app as an ISO-8601 formatted string",
                        "type":"integer"
                    },
                    "state":{
                        "description":"State of the operatorOne of [NOT_AVAILABLE, WORKING, IDLE, UNKNOWN].",
                        "type":"string"
                    },
                    "type":{
                        "description":"Type of the operator",
                        "type":"string"
                    },
                    "username":{
                        "description":"Username of the operator",
                        "type":"string"
                    }
                },
                "required":[
                    "username",
                    "state",
                    "factory",
                    "email",
                    "description",
                    "type",
                    "extId",
                    "properties",
                    "registrationTime",
                    "registrationTimeAsString",
                    "registeredBy",
                    "lastModifiedTime",
                    "lastModifiedTimeAsString",
                    "lastModifiedBy",
                    "integrationId"
                ],
                "type":"object"
            },
            "type":"array"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "links":{
            "description":"The set of API navigation links.",
            "items":{
                "properties":{
                    "href":{
                        "description":"The target resource URI",
                        "example":"https://iotserver/iot/api/vX/some/API/path",
                        "type":"string"
                    },
                    "rel":{
                        "description":"Relation type",
                        "example":"canonical",
                        "type":"string"
                    }
                },
                "type":"object"
            },
            "type":"array"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        }
    },
    "required":[
        "items",
        "links",
        "limit",
        "offset",
        "count",
        "hasMore"
    ],
    "type":"object"
}

Nested Schema : items

Type: array

Show Source

Array of: object items

{
    "items":{
        "properties":{
            "description":{
                "description":"Description about the operator",
                "type":"string"
            },
            "email":{
                "description":"The email address of the operator. IDCS user will be created if value is provided",
                "type":"string"
            },
            "extId":{
                "description":"The external identifier representing the external operator imported",
                "type":"string"
            },
            "factory":{
                "description":"The factory this operator belongs to",
                "type":"string"
            },
            "integrationId":{
                "description":"The integration identifier that imported the operator",
                "type":"string"
            },
            "lastModifiedBy":{
                "description":"Name of the user who last modified the definition of the operator",
                "type":"string"
            },
            "lastModifiedTime":{
                "description":"The time when the operator definition was last updated as an epoch milliseconds",
                "type":"integer"
            },
            "lastModifiedTimeAsString":{
                "description":"The time when the operator definition was last updated as an ISO-8601 formatted string",
                "type":"integer"
            },
            "properties":{
                "additionalProperties":{
                    "description":"A map of the following type: Map&lt;String, String&gt;",
                    "type":"string"
                },
                "description":"The machine's external entity properties as key, value pairs.",
                "properties":{
                },
                "type":"object"
            },
            "registeredBy":{
                "description":"Name of the user who registered this operator",
                "type":"string"
            },
            "registrationTime":{
                "description":"The time when the operator was registered with the app as an epoch milliseconds",
                "type":"integer"
            },
            "registrationTimeAsString":{
                "description":"The time when the operator was registered with the app as an ISO-8601 formatted string",
                "type":"integer"
            },
            "state":{
                "description":"State of the operatorOne of [NOT_AVAILABLE, WORKING, IDLE, UNKNOWN].",
                "type":"string"
            },
            "type":{
                "description":"Type of the operator",
                "type":"string"
            },
            "username":{
                "description":"Username of the operator",
                "type":"string"
            }
        },
        "required":[
            "username",
            "state",
            "factory",
            "email",
            "description",
            "type",
            "extId",
            "properties",
            "registrationTime",
            "registrationTimeAsString",
            "registeredBy",
            "lastModifiedTime",
            "lastModifiedTimeAsString",
            "lastModifiedBy",
            "integrationId"
        ],
        "type":"object"
    },
    "type":"array"
}

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

Array of: object items

{
    "description":"The set of API navigation links.",
    "items":{
        "properties":{
            "href":{
                "description":"The target resource URI",
                "example":"https://iotserver/iot/api/vX/some/API/path",
                "type":"string"
            },
            "rel":{
                "description":"Relation type",
                "example":"canonical",
                "type":"string"
            }
        },
        "type":"object"
    },
    "type":"array"
}

Nested Schema : items

Type: object

Show Source

description: string

Description about the operator
email: string

The email address of the operator. IDCS user will be created if value is provided
extId: string

The external identifier representing the external operator imported
factory: string

The factory this operator belongs to
integrationId: string

The integration identifier that imported the operator
lastModifiedBy: string

Name of the user who last modified the definition of the operator
lastModifiedTime: integer

The time when the operator definition was last updated as an epoch milliseconds
lastModifiedTimeAsString: integer

The time when the operator definition was last updated as an ISO-8601 formatted string
properties: object properties

Additional Properties Allowed: additionalProperties

The machine's external entity properties as key, value pairs.
registeredBy: string

Name of the user who registered this operator
registrationTime: integer

The time when the operator was registered with the app as an epoch milliseconds
registrationTimeAsString: integer

The time when the operator was registered with the app as an ISO-8601 formatted string
state: string

State of the operatorOne of [NOT_AVAILABLE, WORKING, IDLE, UNKNOWN].
type: string

Type of the operator
username: string

Username of the operator

{
    "properties":{
        "description":{
            "description":"Description about the operator",
            "type":"string"
        },
        "email":{
            "description":"The email address of the operator. IDCS user will be created if value is provided",
            "type":"string"
        },
        "extId":{
            "description":"The external identifier representing the external operator imported",
            "type":"string"
        },
        "factory":{
            "description":"The factory this operator belongs to",
            "type":"string"
        },
        "integrationId":{
            "description":"The integration identifier that imported the operator",
            "type":"string"
        },
        "lastModifiedBy":{
            "description":"Name of the user who last modified the definition of the operator",
            "type":"string"
        },
        "lastModifiedTime":{
            "description":"The time when the operator definition was last updated as an epoch milliseconds",
            "type":"integer"
        },
        "lastModifiedTimeAsString":{
            "description":"The time when the operator definition was last updated as an ISO-8601 formatted string",
            "type":"integer"
        },
        "properties":{
            "additionalProperties":{
                "description":"A map of the following type: Map&lt;String, String&gt;",
                "type":"string"
            },
            "description":"The machine's external entity properties as key, value pairs.",
            "properties":{
            },
            "type":"object"
        },
        "registeredBy":{
            "description":"Name of the user who registered this operator",
            "type":"string"
        },
        "registrationTime":{
            "description":"The time when the operator was registered with the app as an epoch milliseconds",
            "type":"integer"
        },
        "registrationTimeAsString":{
            "description":"The time when the operator was registered with the app as an ISO-8601 formatted string",
            "type":"integer"
        },
        "state":{
            "description":"State of the operatorOne of [NOT_AVAILABLE, WORKING, IDLE, UNKNOWN].",
            "type":"string"
        },
        "type":{
            "description":"Type of the operator",
            "type":"string"
        },
        "username":{
            "description":"Username of the operator",
            "type":"string"
        }
    },
    "required":[
        "username",
        "state",
        "factory",
        "email",
        "description",
        "type",
        "extId",
        "properties",
        "registrationTime",
        "registrationTimeAsString",
        "registeredBy",
        "lastModifiedTime",
        "lastModifiedTimeAsString",
        "lastModifiedBy",
        "integrationId"
    ],
    "type":"object"
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

A map of the following type: Map<String, String>

{
    "additionalProperties":{
        "description":"A map of the following type: Map&lt;String, String&gt;",
        "type":"string"
    },
    "description":"The machine's external entity properties as key, value pairs.",
    "properties":{
    },
    "type":"object"
}

The machine's external entity properties as key, value pairs.

Show Source

{
    "additionalProperties":{
        "description":"A map of the following type: Map&lt;String, String&gt;",
        "type":"string"
    },
    "description":"The machine's external entity properties as key, value pairs.",
    "properties":{
    },
    "type":"object"
}

Nested Schema : items

Type: object

Show Source

href(optional): string

The target resource URI

Example: https://iotserver/iot/api/vX/some/API/path
rel(optional): string

Relation type

Example: canonical

{
    "properties":{
        "href":{
            "description":"The target resource URI",
            "example":"https://iotserver/iot/api/vX/some/API/path",
            "type":"string"
        },
        "rel":{
            "description":"Relation type",
            "example":"canonical",
            "type":"string"
        }
    },
    "type":"object"
}

401 Response

Unauthorized. The request requires user authentication.

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/operators

Example of Response Body

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


{
    "count":2,
    "hasMore":false,
    "items":[
        {
            "description":"Description about the operator",
            "email":"The email address of the operator. IDCS user will be created if value is provided",
            "extId":"646cb25457e-40ba",
            "factory":"The factory this operator belongs to",
            "integrationId":"586b91b2406-55bc",
            "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"
        },
        {
            "description":"Description about the operator",
            "email":"The email address of the operator. IDCS user will be created if value is provided",
            "extId":"7d5c1df1118-293f",
            "factory":"The factory this operator belongs to",
            "integrationId":"24a973a36189-231c",
            "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"
        }
    ],
    "limit":10,
    "links":[
        {
            "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
            "rel":"self"
        },
        {
            "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
            "rel":"canonical"
        }
    ],
    "offset":0
}

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

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.