Retrieve operation task by ID
get
/productionMonitoring/clientapi/v2/workOrders/{workOrder-id}/operations/{operation-id}/tasks/{task-id}
This operation returns information about an operation task that is specified by its ID.
Request
Path Parameters
-
operation-id: string
The unique identifier of the work order operation
-
task-id: string
The unique identifier of the operation task
-
workOrder-id: string
The unique identifier of the work order
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.
Header Parameters
-
X-ORACLE-IOT-ORG: string
To allow targeting requests to different organizations. The header value should contain the organization identifier
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Root Schema : WorkOrderTask_receive
Type:
Show Source
object
-
createdBy:
string
Name of the user who registered this operation task
-
createdTime:
integer
The time when the operation task was registered with the app as an epoch milliseconds
-
createdTimeAsString:
integer
The time when the operation task was registered with the app as an ISO-8601 formatted string
-
description:
string
The description of the operation task
-
externalId:
string
External id representing value that uniquely identifies the operation task in an external system
-
id:
string
The unique identifier of the operation task
-
idealCycleTime:
integer
The fastest cycle time (in milliseconds) to complete this operation task
-
lastModifiedBy:
string
Name of the user who last modified the definition of the operation task
-
lastModifiedTime:
integer
The time when the operation task definition was last updated as an epoch milliseconds
-
lastModifiedTimeAsString:
integer
The time when the operation task definition was last updated as an ISO-8601 formatted string
-
machines:
array machines
The list of identifiers of machines assigned to the operation task
-
machineTypes:
array machineTypes
The equipment resources assigned to the operation task
-
name:
string
The name of the operation task
-
operation:
string
The operation identifier this task belongs to
-
operators:
array operators
The list of identifiers of operators assigned to the operation task
-
operatorTypes:
array operatorTypes
The labor resources assigned to the operation task
-
resourceInstances:
object resourceInstances
Property description was not set
-
routingTask:
string
The routing task identifier
-
sequenceNumber:
integer
The sequence number in which the operation task is performed in the operation
-
state:
string
The name of the operation task state. This represents the state of the operation task during its life cycle. One of [UNKNOWN, NOT_STARTED, STARTED, COMPLETED]
-
stateModifiedTime:
integer
The time when the task state was last updated as an epoch milliseconds
-
stateModifiedTimeAsString:
integer
The time when the task state was last updated as an ISO-8601 formatted string
Nested Schema : machines
Type:
array
The list of identifiers of machines assigned to the operation task
Show Source
Nested Schema : machineTypes
Type:
array
The equipment resources assigned to the operation task
Show Source
Nested Schema : operators
Type:
array
The list of identifiers of operators assigned to the operation task
Show Source
Nested Schema : operatorTypes
Type:
array
The labor resources assigned to the operation task
Show Source
Nested Schema : resourceInstances
Type:
object
Property description was not set
Show Source
-
links(optional):
array links
The set of API navigation links.
Nested Schema : WorkOrderResourceType_receive
Type:
Show Source
object
-
idealCycleTime:
integer
The fastest cycle time (in milliseconds) to complete this routing task
-
principal:
boolean
Principal flag
-
type:
string
Value that uniquely identifies the machine or operator type
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
401 Response
Unauthorized. The request requires user authentication.
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.
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/workOrders/{workOrder-id}/operations/{operation-id}/tasks/{task-id}
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"createdBy":"Name of the user who registered this operation task",
"createdTime":1469184297746,
"createdTimeAsString":1469184297746,
"description":"The description of the operation task",
"externalId":"57df403d31dd-2dc6",
"id":"6e943f02615-537a",
"idealCycleTime":1469184297746,
"lastModifiedBy":"Name of the user who last modified the definition of the operation task",
"lastModifiedTime":1469184297746,
"lastModifiedTimeAsString":1469184297746,
"machineTypes":[
{
"idealCycleTime":1469184297746,
"principal":false,
"type":"Value that uniquely identifies the machine or operator type"
}
],
"machines":[
"machines_1",
"machines_2",
"machines_3"
],
"name":"The name of the operation task",
"operation":"The operation identifier this task belongs to",
"operatorTypes":[
{
"idealCycleTime":1469184297746,
"principal":false,
"type":"Value that uniquely identifies the machine or operator type"
}
],
"operators":[
"operators_1",
"operators_2",
"operators_3"
],
"resourceInstances":{
"links":[
{
"href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"routingTask":"The routing task identifier",
"sequenceNumber":12345,
"state":"The name of the operation task state. This represents the state of the operation task during its life cycle. One of [UNKNOWN, NOT_STARTED, STARTED, COMPLETED]",
"stateModifiedTime":1469184297746,
"stateModifiedTimeAsString":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/workOrders/{workOrder-id}/operations/29e4268e6aab-6c86/tasks/29e4268e6aab-6c86
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.