REST API for Oracle IoT Production Monitoring Cloud Service

Retrieve all routing tasks

get

/productionMonitoring/clientapi/v2/routingTasks

This operation retrieves information for all routing tasks.

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

The ordering criteria for the returned routing task list.
q(optional): string

The query to filter routing tasks 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.

Response

Supported Media Types

application/json
application/vnd.oracle.resource+json;type=singular

200 Response

Successfully processed.

Root Schema : RoutingTask_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":{
                    "attributes":{
                        "description":"The custom attributes provided by the user as {name, type, value} tuples. Can contain any information about the raw material requirements, standard processing times,min-max requirements, capacity, expected throughput, etc.",
                        "items":{
                            "$ref":"#/definitions/Attribute_receive"
                        },
                        "type":"array"
                    },
                    "description":{
                        "description":"The description about the routing task.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The unique identifier of the routing task",
                        "type":"string"
                    },
                    "idealCycleTime":{
                        "description":"The fastest cycle time (in milliseconds) to complete this routing task for the given product under optimal circumstances.",
                        "type":"number"
                    },
                    "machines":{
                        "description":"The list of identifiers of machines qualified for the routing task.",
                        "items":{
                            "type":"string"
                        },
                        "type":"array"
                    },
                    "name":{
                        "description":"The name of the routing task (For example: drilling, cutting etc).",
                        "type":"string"
                    },
                    "orderNumber":{
                        "description":"The order number of the routing task, starting from 1.",
                        "type":"integer"
                    },
                    "product":{
                        "description":"The identifier of the product the routing task is related to.",
                        "type":"string"
                    }
                },
                "required":[
                    "id",
                    "name",
                    "description",
                    "product",
                    "orderNumber",
                    "idealCycleTime",
                    "attributes",
                    "machines"
                ],
                "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":{
            "attributes":{
                "description":"The custom attributes provided by the user as {name, type, value} tuples. Can contain any information about the raw material requirements, standard processing times,min-max requirements, capacity, expected throughput, etc.",
                "items":{
                    "$ref":"#/definitions/Attribute_receive"
                },
                "type":"array"
            },
            "description":{
                "description":"The description about the routing task.",
                "type":"string"
            },
            "id":{
                "description":"The unique identifier of the routing task",
                "type":"string"
            },
            "idealCycleTime":{
                "description":"The fastest cycle time (in milliseconds) to complete this routing task for the given product under optimal circumstances.",
                "type":"number"
            },
            "machines":{
                "description":"The list of identifiers of machines qualified for the routing task.",
                "items":{
                    "type":"string"
                },
                "type":"array"
            },
            "name":{
                "description":"The name of the routing task (For example: drilling, cutting etc).",
                "type":"string"
            },
            "orderNumber":{
                "description":"The order number of the routing task, starting from 1.",
                "type":"integer"
            },
            "product":{
                "description":"The identifier of the product the routing task is related to.",
                "type":"string"
            }
        },
        "required":[
            "id",
            "name",
            "description",
            "product",
            "orderNumber",
            "idealCycleTime",
            "attributes",
            "machines"
        ],
        "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

attributes: array attributes

The custom attributes provided by the user as {name, type, value} tuples. Can contain any information about the raw material requirements, standard processing times,min-max requirements, capacity, expected throughput, etc.
description: string

The description about the routing task.
id: string

The unique identifier of the routing task
idealCycleTime: number

The fastest cycle time (in milliseconds) to complete this routing task for the given product under optimal circumstances.
machines: array machines

The list of identifiers of machines qualified for the routing task.
name: string

The name of the routing task (For example: drilling, cutting etc).
orderNumber: integer

The order number of the routing task, starting from 1.
product: string

The identifier of the product the routing task is related to.

{
    "properties":{
        "attributes":{
            "description":"The custom attributes provided by the user as {name, type, value} tuples. Can contain any information about the raw material requirements, standard processing times,min-max requirements, capacity, expected throughput, etc.",
            "items":{
                "$ref":"#/definitions/Attribute_receive"
            },
            "type":"array"
        },
        "description":{
            "description":"The description about the routing task.",
            "type":"string"
        },
        "id":{
            "description":"The unique identifier of the routing task",
            "type":"string"
        },
        "idealCycleTime":{
            "description":"The fastest cycle time (in milliseconds) to complete this routing task for the given product under optimal circumstances.",
            "type":"number"
        },
        "machines":{
            "description":"The list of identifiers of machines qualified for the routing task.",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "name":{
            "description":"The name of the routing task (For example: drilling, cutting etc).",
            "type":"string"
        },
        "orderNumber":{
            "description":"The order number of the routing task, starting from 1.",
            "type":"integer"
        },
        "product":{
            "description":"The identifier of the product the routing task is related to.",
            "type":"string"
        }
    },
    "required":[
        "id",
        "name",
        "description",
        "product",
        "orderNumber",
        "idealCycleTime",
        "attributes",
        "machines"
    ],
    "type":"object"
}

Nested Schema : attributes

Type: array

The custom attributes provided by the user as {name, type, value} tuples. Can contain any information about the raw material requirements, standard processing times,min-max requirements, capacity, expected throughput, etc.

Show Source

Array of: object Attribute_receive

{
    "description":"The custom attributes provided by the user as {name, type, value} tuples. Can contain any information about the raw material requirements, standard processing times,min-max requirements, capacity, expected throughput, etc.",
    "items":{
        "$ref":"#/definitions/Attribute_receive"
    },
    "type":"array"
}

Nested Schema : machines

Type: array

The list of identifiers of machines qualified for the routing task.

Show Source

Array of: string

{
    "description":"The list of identifiers of machines qualified for the routing task.",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : Attribute_receive

Type: object

Show Source

deviceModel: string

The device model URN, applicable and must be specified when attribute type is 'device', 'sensor', 'alert'.
name: string

The name of the attribute.
type: string

The type of the attribute. One of [STRING, NUMBER, BOOLEAN, DATE, BINARY, DEVICE, SENSOR, ALERT].

{
    "properties":{
        "deviceModel":{
            "description":"The device model URN, applicable and must be specified when attribute type is 'device', 'sensor', 'alert'.",
            "type":"string"
        },
        "name":{
            "description":"The name of the attribute.",
            "type":"string"
        },
        "type":{
            "description":"The type of the attribute. One of [STRING, NUMBER, BOOLEAN, DATE, BINARY, DEVICE, SENSOR, ALERT].",
            "type":"string"
        }
    },
    "required":[
        "deviceModel",
        "name",
        "type"
    ],
    "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/routingTasks

Example of Response Body

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


{
    "count":2,
    "hasMore":false,
    "items":[
        {
            "attributes":[
                {
                    "deviceModel":"The device model URN, applicable and must be specified when attribute type is 'device', 'sensor', 'alert'.",
                    "name":"The name of the attribute.",
                    "type":"The type of the attribute. One of [STRING, NUMBER, BOOLEAN, DATE, BINARY, DEVICE, SENSOR, ALERT]."
                }
            ],
            "description":"The description about the routing task.",
            "id":"559562b05e1a-6f35",
            "idealCycleTime":0.0,
            "machines":[
                "machines_1",
                "machines_2",
                "machines_3"
            ],
            "name":"The name of the routing task (For example: drilling, cutting etc).",
            "orderNumber":12345,
            "product":"The identifier of the product the routing task is related to."
        },
        {
            "attributes":[
                {
                    "deviceModel":"The device model URN, applicable and must be specified when attribute type is 'device', 'sensor', 'alert'.",
                    "name":"The name of the attribute.",
                    "type":"The type of the attribute. One of [STRING, NUMBER, BOOLEAN, DATE, BINARY, DEVICE, SENSOR, ALERT]."
                }
            ],
            "description":"The description about the routing task.",
            "id":"15e4110c75ed-2a4f",
            "idealCycleTime":0.0,
            "machines":[
                "machines_1",
                "machines_2",
                "machines_3"
            ],
            "name":"The name of the routing task (For example: drilling, cutting etc).",
            "orderNumber":12345,
            "product":"The identifier of the product the routing task is related to."
        }
    ],
    "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/routingTasks

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.