Jump to

• Request
• Response
• Examples

Retrieve production plan information

get

/productionMonitoring/clientapi/v2/productionPlans/{plan-id}

This operation retrieves production plan by id. This method supports the request header with name 'X-ORACLE-IOT-ORG', which allows targeting requests to different organizations. The value of this request header should contain the organization identifier.

Request

Path Parameters

• plan-id: string
  The identifier created by the Oracle IoT Cloud Service for the production plan.

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
  This method supports the request header with name 'X-ORACLE-IOT-ORG', which allows targeting requests to different organizations. The value of this request header should contain the organization identifier.

Back to Top

Response

Supported Media Types

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

200 Response

Successfully processed.

Body ()

Root Schema : ProductionPlan_receive

Type: object

Show Source

• actualQuantity: number
  The actual quantity of the product.
• endTime: integer
  The end time for the plan item as an an epoch milliseconds.
• endTimeAsString: string
  The end time for the plan item as an ISO-8601 formatted string.
• expectedQuantity: number
  The expected quantity of the product.
• externalId: string
  Property description was not set
• factory: string
  The identifier of the factory the production plan is created for.
• id: string
  The identifier created by the Oracle IoT Cloud Service for the production plan.
• idealCycleTime: number
  The minimum cycle time (in milliseconds) to complete this machine for the given product under optimal conditions.
• machine: string
  The identifier of the machine the production plan is created for.
• operator: string
  The identifier of the operator the production plan is created for.
• product: string
  The identifier of the product the production plan is created for.
• productionLine: string
  The identifier of the production line the production plan is created for.
• rejectQuantity: number
  The rejected quantity of the product.
• routingTask: string
  The identifier of the routing task the production plan is created for.
• scrapQuantity: number
  The scrap quantity of the product.
• startTime: integer
  The start time for the plan item as an epoch milliseconds.
• startTimeAsString: string
  The start time for the plan item as an ISO-8601 formatted string.
• type: string
  The type of the production plan. The type must be one of [FACTORY, FACTORY_LINE, MACHINE_TASK].One of [FACTORY, FACTORY_LINE, MACHINE_TASK, OPERATOR_TASK].
• workOrder: string
  The identifier of the work order the production plan is created for.
• workOrderNumber: string
  The work order number for the production plan. It is unique within a factory.

{
    "properties":{
        "actualQuantity":{
            "description":"The actual quantity of the product.",
            "type":"number"
        },
        "endTime":{
            "description":"The end time for the plan item as an an epoch milliseconds.",
            "type":"integer"
        },
        "endTimeAsString":{
            "description":"The end time for the plan item as an ISO-8601 formatted string.",
            "type":"string"
        },
        "expectedQuantity":{
            "description":"The expected quantity of the product.",
            "type":"number"
        },
        "externalId":{
            "description":"Property description was not set",
            "type":"string"
        },
        "factory":{
            "description":"The identifier of the factory the production plan is created for.",
            "type":"string"
        },
        "id":{
            "description":"The identifier created by the Oracle IoT Cloud Service for the production plan.",
            "type":"string"
        },
        "idealCycleTime":{
            "description":"The minimum cycle time (in milliseconds) to complete this machine for the given product under optimal conditions.",
            "type":"number"
        },
        "machine":{
            "description":"The identifier of the machine the production plan is created for.",
            "type":"string"
        },
        "operator":{
            "description":"The identifier of the operator the production plan is created for.",
            "type":"string"
        },
        "product":{
            "description":"The identifier of the product the production plan is created for.",
            "type":"string"
        },
        "productionLine":{
            "description":"The identifier of the production line the production plan is created for.",
            "type":"string"
        },
        "rejectQuantity":{
            "description":"The rejected quantity of the product.",
            "type":"number"
        },
        "routingTask":{
            "description":"The identifier of the routing task the production plan is created for.",
            "type":"string"
        },
        "scrapQuantity":{
            "description":"The scrap quantity of the product.",
            "type":"number"
        },
        "startTime":{
            "description":"The start time for the plan item as an epoch milliseconds.",
            "type":"integer"
        },
        "startTimeAsString":{
            "description":"The start time for the plan item as an ISO-8601 formatted string.",
            "type":"string"
        },
        "type":{
            "description":"The type of the production plan. The type must be one of [FACTORY, FACTORY_LINE, MACHINE_TASK].One of [FACTORY, FACTORY_LINE, MACHINE_TASK, OPERATOR_TASK].",
            "type":"string"
        },
        "workOrder":{
            "description":"The identifier of the work order the production plan is created for.",
            "type":"string"
        },
        "workOrderNumber":{
            "description":"The work order number for the production plan. It is unique within a factory.",
            "type":"string"
        }
    },
    "required":[
        "id",
        "type",
        "product",
        "factory",
        "productionLine",
        "routingTask",
        "machine",
        "operator",
        "startTime",
        "startTimeAsString",
        "endTime",
        "endTimeAsString",
        "expectedQuantity",
        "actualQuantity",
        "rejectQuantity",
        "scrapQuantity",
        "idealCycleTime",
        "workOrder",
        "workOrderNumber",
        "externalId"
    ],
    "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/productionPlans/{plan-id} 

Example of Response Body

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

{
    "actualQuantity":0.0,
    "endTime":1469184297746,
    "endTimeAsString":"2016-07-22T10:44:57.746Z",
    "expectedQuantity":0.0,
    "externalId":"24c9580346bb-5154",
    "factory":"The identifier of the factory the production plan is created for.",
    "id":"634e27a76164-662",
    "idealCycleTime":0.0,
    "machine":"The identifier of the machine the production plan is created for.",
    "operator":"The identifier of the operator the production plan is created for.",
    "product":"The identifier of the product the production plan is created for.",
    "productionLine":"The identifier of the production line the production plan is created for.",
    "rejectQuantity":0.0,
    "routingTask":"The identifier of the routing task the production plan is created for.",
    "scrapQuantity":0.0,
    "startTime":1469184297746,
    "startTimeAsString":"2016-07-22T10:44:57.746Z",
    "type":"FACTORY",
    "workOrder":"The identifier of the work order the production plan is created for.",
    "workOrderNumber":"The work order number for the production plan. It is unique within a factory."
} 

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/productionPlans/6aaa7d657ac-170 

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