REST API for Oracle IoT Production Monitoring Cloud Service

Get all operator types

get

/productionMonitoring/clientapi/v2/operatorTypes

This operation retrieves information for all the operator types. 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

orderBy
q(optional): string

q (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=singular

200 Response

Successfully processed.

Root Schema : OperatorType_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":"The description for the given operator type",
                        "type":"string"
                    },
                    "extId":{
                        "description":"The external identifier representing the external operator type imported",
                        "type":"string"
                    },
                    "icon":{
                        "description":"Binary object representing operator type icon.",
                        "properties":{
                            "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"
                            }
                        },
                        "type":"object"
                    },
                    "id":{
                        "description":"Identifier created by the Oracle IoT Cloud Service for the operator type",
                        "type":"string"
                    },
                    "integrationId":{
                        "description":"The integration identifier that imported the operator type",
                        "type":"string"
                    },
                    "lastModifiedTime":{
                        "description":"The time when the operator type definition was last updated as an epoch milliseconds",
                        "type":"integer"
                    },
                    "lastModifiedTimeAsString":{
                        "description":"The time when the operator type definition was last updated as an ISO-8601 formatted string",
                        "type":"integer"
                    },
                    "modifiedBy":{
                        "description":"The name of the user who last modified the definition of the operator type",
                        "type":"string"
                    },
                    "name":{
                        "description":"User-defined unique name for the operator type",
                        "type":"string"
                    },
                    "properties":{
                        "additionalProperties":{
                            "description":"A map of the following type: Map&lt;String, String&gt;",
                            "type":"string"
                        },
                        "description":"The operator type's external entity properties as key, value pairs.",
                        "properties":{
                        },
                        "type":"object"
                    },
                    "registeredBy":{
                        "description":"The name of the user who registered this operator type",
                        "type":"string"
                    },
                    "registrationTime":{
                        "description":"The time when the operator type was registered with the app as an epoch milliseconds",
                        "type":"integer"
                    },
                    "registrationTimeAsString":{
                        "description":"The time when the operator type was registered with the app as an ISO-8601 formatted string",
                        "type":"integer"
                    }
                },
                "required":[
                    "id",
                    "name",
                    "description",
                    "icon",
                    "extId",
                    "integrationId",
                    "properties",
                    "registrationTime",
                    "registrationTimeAsString",
                    "registeredBy",
                    "lastModifiedTime",
                    "lastModifiedTimeAsString",
                    "modifiedBy"
                ],
                "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":"The description for the given operator type",
                "type":"string"
            },
            "extId":{
                "description":"The external identifier representing the external operator type imported",
                "type":"string"
            },
            "icon":{
                "description":"Binary object representing operator type icon.",
                "properties":{
                    "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"
                    }
                },
                "type":"object"
            },
            "id":{
                "description":"Identifier created by the Oracle IoT Cloud Service for the operator type",
                "type":"string"
            },
            "integrationId":{
                "description":"The integration identifier that imported the operator type",
                "type":"string"
            },
            "lastModifiedTime":{
                "description":"The time when the operator type definition was last updated as an epoch milliseconds",
                "type":"integer"
            },
            "lastModifiedTimeAsString":{
                "description":"The time when the operator type definition was last updated as an ISO-8601 formatted string",
                "type":"integer"
            },
            "modifiedBy":{
                "description":"The name of the user who last modified the definition of the operator type",
                "type":"string"
            },
            "name":{
                "description":"User-defined unique name for the operator type",
                "type":"string"
            },
            "properties":{
                "additionalProperties":{
                    "description":"A map of the following type: Map&lt;String, String&gt;",
                    "type":"string"
                },
                "description":"The operator type's external entity properties as key, value pairs.",
                "properties":{
                },
                "type":"object"
            },
            "registeredBy":{
                "description":"The name of the user who registered this operator type",
                "type":"string"
            },
            "registrationTime":{
                "description":"The time when the operator type was registered with the app as an epoch milliseconds",
                "type":"integer"
            },
            "registrationTimeAsString":{
                "description":"The time when the operator type was registered with the app as an ISO-8601 formatted string",
                "type":"integer"
            }
        },
        "required":[
            "id",
            "name",
            "description",
            "icon",
            "extId",
            "integrationId",
            "properties",
            "registrationTime",
            "registrationTimeAsString",
            "registeredBy",
            "lastModifiedTime",
            "lastModifiedTimeAsString",
            "modifiedBy"
        ],
        "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

The description for the given operator type
extId: string

The external identifier representing the external operator type imported
icon: object icon

Binary object representing operator type icon.
id: string

Identifier created by the Oracle IoT Cloud Service for the operator type
integrationId: string

The integration identifier that imported the operator type
lastModifiedTime: integer

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

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

The name of the user who last modified the definition of the operator type
name: string

User-defined unique name for the operator type
properties: object properties

Additional Properties Allowed: additionalProperties

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

The name of the user who registered this operator type
registrationTime: integer

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

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

{
    "properties":{
        "description":{
            "description":"The description for the given operator type",
            "type":"string"
        },
        "extId":{
            "description":"The external identifier representing the external operator type imported",
            "type":"string"
        },
        "icon":{
            "description":"Binary object representing operator type icon.",
            "properties":{
                "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"
                }
            },
            "type":"object"
        },
        "id":{
            "description":"Identifier created by the Oracle IoT Cloud Service for the operator type",
            "type":"string"
        },
        "integrationId":{
            "description":"The integration identifier that imported the operator type",
            "type":"string"
        },
        "lastModifiedTime":{
            "description":"The time when the operator type definition was last updated as an epoch milliseconds",
            "type":"integer"
        },
        "lastModifiedTimeAsString":{
            "description":"The time when the operator type definition was last updated as an ISO-8601 formatted string",
            "type":"integer"
        },
        "modifiedBy":{
            "description":"The name of the user who last modified the definition of the operator type",
            "type":"string"
        },
        "name":{
            "description":"User-defined unique name for the operator type",
            "type":"string"
        },
        "properties":{
            "additionalProperties":{
                "description":"A map of the following type: Map&lt;String, String&gt;",
                "type":"string"
            },
            "description":"The operator type's external entity properties as key, value pairs.",
            "properties":{
            },
            "type":"object"
        },
        "registeredBy":{
            "description":"The name of the user who registered this operator type",
            "type":"string"
        },
        "registrationTime":{
            "description":"The time when the operator type was registered with the app as an epoch milliseconds",
            "type":"integer"
        },
        "registrationTimeAsString":{
            "description":"The time when the operator type was registered with the app as an ISO-8601 formatted string",
            "type":"integer"
        }
    },
    "required":[
        "id",
        "name",
        "description",
        "icon",
        "extId",
        "integrationId",
        "properties",
        "registrationTime",
        "registrationTimeAsString",
        "registeredBy",
        "lastModifiedTime",
        "lastModifiedTimeAsString",
        "modifiedBy"
    ],
    "type":"object"
}

Nested Schema : icon

Type: object

Binary object representing operator type icon.

Show Source

links(optional): array links

The set of API navigation links.

{
    "description":"Binary object representing operator type icon.",
    "properties":{
        "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"
        }
    },
    "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 operator type's external entity properties as key, value pairs.",
    "properties":{
    },
    "type":"object"
}

The operator type'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 operator type's external entity properties as key, value pairs.",
    "properties":{
    },
    "type":"object"
}

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

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"
}

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.

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.

Examples

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

Example of Response Body

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


{
    "count":2,
    "hasMore":false,
    "items":[
        {
            "description":"The description for the given operator type",
            "extId":"94f1dda7579-588d",
            "icon":{
                "links":[
                    {
                        "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
                        "rel":"self"
                    },
                    {
                        "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
                        "rel":"canonical"
                    }
                ]
            },
            "id":"791534f1645c-ad8",
            "integrationId":"66c44145ada-7e3c",
            "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
        },
        {
            "description":"The description for the given operator type",
            "extId":"397a7983325e-7450",
            "icon":{
                "links":[
                    {
                        "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
                        "rel":"self"
                    },
                    {
                        "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
                        "rel":"canonical"
                    }
                ]
            },
            "id":"6eae42c2784d-37ac",
            "integrationId":"7650a0bb76-387",
            "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
        }
    ],
    "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/operatorTypes

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.