Retrieve work order by ID
get
/productionMonitoring/clientapi/v2/workOrders/{workOrder-id}
This operation returns information about a work order that is specified by its ID.
Request
Path Parameters
-
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 : WorkOrder_receive
Type:
Show Source
object
-
actualEndTime:
integer
Actual finish date of the work order as an epoch milliseconds
-
actualEndTimeAsString:
integer
Actual finish date of the work order as an ISO-8601 formatted string
-
actualStartTime:
integer
Actual start date of the work order as an epoch milliseconds
-
actualStartTimeAsString:
integer
Actual start date of the work order as an ISO-8601 formatted string
-
batchQuantity:
integer
Batch quantity for the work order. Applicable only for Process Work Order
-
batchUOM:
string
Unit of measure of the batch quantity. Applicable only for Process Work Order
-
createdBy:
string
Name of the user who registered this work order
-
createdTime:
integer
The time when the work order was registered with the app as an epoch milliseconds
-
createdTimeAsString:
integer
The time when the work order was registered with the app as an ISO-8601 formatted string
-
description:
string
Description of the work order.
-
externalId:
string
External id representing value that uniquely identifies the work order in an external system
-
factory:
string
A factory this work order belongs to
-
id:
string
The unique identifier of the work order
-
integrationId:
string
The integration identifier that imported the work order
-
lastModifiedBy:
string
Name of the user who last modified the definition of the work order
-
lastModifiedTime:
integer
The time when the work order definition was last updated as an epoch milliseconds
-
lastModifiedTimeAsString:
integer
The time when the work order definition was last updated as an ISO-8601 formatted string
-
name:
string
Name that identifies the work order
-
operations:
object operations
The list of operations are used to process the work order
-
plannedEndTime:
integer
Scheduled date and time to finish the work order as an epoch milliseconds
-
plannedEndTimeAsString:
integer
Scheduled date and time to finish the work order as an ISO-8601 formatted string
-
plannedQuantity:
integer
Planned production quantity for the work order
-
plannedStartTime:
integer
Scheduled date and time to start the work order as an epoch milliseconds
-
plannedStartTimeAsString:
integer
Scheduled date and time to start the work order as an ISO-8601 formatted string
-
primaryUOM:
string
Unit of measure of the primary product. Applicable only for Process Work Order
-
product:
string
A product identifier that the work order creates
-
routing:
string
The production routing identifier
-
state:
string
The user-defined name for the work order state. The field contains the system value of the work order state by default.
-
systemState:
string
Name of the work order system state. This represents the state of the work order during its life cycle. One of [CREATED, PLANNED, UNRELEASED, RELEASED, IN_PROCESS, COMPLETED, CLOSED, CANCELLED].
-
type:
string
Type of the work order state. One of [STANDARD, NON_STANDARD, TRANSFORM, REWORK]. Default value is STANDARD.
-
workMethod:
string
The production method used in the work order, one of ['DISCRETE_MANUFACTURING', 'PROCESS_MANUFACTURING']
Nested Schema : operations
Type:
object
The list of operations are used to process the work order
Show Source
-
links(optional):
array links
The set of API navigation links.
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}
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"actualEndTime":1469184297746,
"actualEndTimeAsString":1469184297746,
"actualStartTime":1469184297746,
"actualStartTimeAsString":1469184297746,
"batchQuantity":12345,
"batchUOM":"Unit of measure of the batch quantity. Applicable only for Process Work Order",
"createdBy":"Name of the user who registered this work order",
"createdTime":1469184297746,
"createdTimeAsString":1469184297746,
"description":"Description of the work order.",
"externalId":"67ae5b32429c-1545",
"factory":"A factory this work order belongs to",
"id":"5d8f28613e4e-7461",
"integrationId":"1ff1367399b-5072",
"lastModifiedBy":"Name of the user who last modified the definition of the work order",
"lastModifiedTime":1469184297746,
"lastModifiedTimeAsString":1469184297746,
"name":"Name that identifies the work order",
"operations":{
"links":[
{
"href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"plannedEndTime":1469184297746,
"plannedEndTimeAsString":1469184297746,
"plannedQuantity":12345,
"plannedStartTime":1469184297746,
"plannedStartTimeAsString":1469184297746,
"primaryUOM":"Unit of measure of the primary product. Applicable only for Process Work Order",
"product":"A product identifier that the work order creates",
"routing":"The production routing identifier",
"state":"The user-defined name for the work order state. The field contains the system value of the work order state by default.",
"systemState":"Name of the work order system state. This represents the state of the work order during its life cycle. One of [CREATED, PLANNED, UNRELEASED, RELEASED, IN_PROCESS, COMPLETED, CLOSED, CANCELLED].",
"type":"Type of the work order state. One of [STANDARD, NON_STANDARD, TRANSFORM, REWORK]. Default value is STANDARD.",
"workMethod":"'DISCRETE_MANUFACTURING'"
}
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}
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.