1. REST API for Oracle IoT Production Monitoring Cloud Service
  2. Tasks
  3. Work Orders

Retrieve work order operation by ID

get

/productionMonitoring/clientapi/v2/workOrders/{workOrder-id}/operations/{operation-id}

This operation returns information about a work order operation that is specified by its ID.

Request

Path Parameters
Query Parameters
  • The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
  • The comma-separated list of fields to be shown in response. By default all response object fields will be present.
Header Parameters
  • To allow targeting requests to different organizations. The header value should contain the organization identifier
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : WorkOrderOperation_receive
Type: object
Show Source
Nested Schema : outputs
Type: object
The list of output products
Show Source
Nested Schema : tasks
Type: object
The list of operation tasks are used to process the operation
Show Source

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.
Back to Top

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/productionMonitoring/clientapi/v2/workOrders/{workOrder-id}/operations/{operation-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,
    "createdBy":"Name of the user who registered this work order operation",
    "createdTime":1469184297746,
    "createdTimeAsString":1469184297746,
    "description":"Description of the work order operation",
    "externalId":"669291b4bed-207e",
    "id":"24663a44eb8-37d5",
    "kind":"The operation kind",
    "lastModifiedBy":"Name of the user who last modified the definition of the work order operation",
    "lastModifiedTime":1469184297746,
    "lastModifiedTimeAsString":1469184297746,
    "name":"The name of the operation",
    "outputs":{
        "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,
    "plannedStartTime":1469184297746,
    "plannedStartTimeAsString":1469184297746,
    "sequenceNumber":12345,
    "state":"The state of the operation. This field represents the state of the operation during its life cycle. One of [UNKNOWN, NOT_STARTED, STARTED, COMPLETED]",
    "tasks":{
        "links":[
            {
                "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
                "rel":"self"
            },
            {
                "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
                "rel":"canonical"
            }
        ]
    },
    "workOrder":"The work order this operation belongs 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/workOrders/{workOrder-id}/operations/53a581979c2-22be



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