Jump to

• Request
• Response
• Examples

Retrieve routing task by ID

get

/productionMonitoring/clientapi/v2/routingTasks/{task-id}

This operation retrieves information for the specified routing task.

Request

Path Parameters

• task-id: string
  The unique identifier of the routing task

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.

Back to Top

Response

Supported Media Types

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

200 Response

Successfully processed.

Body ()

Root Schema : RoutingTask_receive

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

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/routingTasks/{task-id} 

Example of Response Body

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

{
    "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":"d6227917dc5-692a",
    "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."
} 

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/1cb22fd132e6-1730 

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