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

Retrieve digital birth certificate

get

/productionMonitoring/clientapi/v2/products/digitalBirthCertificate

This operation returns information about a digital birth certificate that a product can track. 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

Query Parameters
Header Parameters
  • 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

200 Response

Successfully processed.
Body ()
Root Schema : CertificateContainer_receive
Type: object
Show Source
Nested Schema : timeWindows
Type: array
plan summary
Show Source
Nested Schema : CertificateContainer$TimeWindow_receive
Type: object
Show Source
Nested Schema : tasks
Type: array
task details of a plan
Show Source
Nested Schema : CertificateContainer$TimeWindow$TaskDetail_receive
Type: object
Show Source
Nested Schema : machines
Type: array
machine summary of a plan
Show Source
Nested Schema : operators
Type: array
operator summary of a plan
Show Source
Nested Schema : MachineSummary_receive
Type: object
Show Source
Nested Schema : sensorData
Type: array
list of attribute statistics
Show Source
Nested Schema : workOrderIds
Type: array
plan work order information
Show Source
Nested Schema : workOrderNumbers
Type: array
plan work order number information
Show Source
Nested Schema : MachineSummary$SensorData_receive
Type: object
Show Source
Nested Schema : boxPlot
Type: array
box plot of data
Show Source
Nested Schema : data
Type: array
raw data list for a sensor attribute
Show Source
Nested Schema : histogram
Type: array
histogram plot of data
Show Source
Nested Schema : MachineSummary$SensorData$Box_receive
Type: object
Show Source
Nested Schema : MachineSummary$SensorData$AggregatedDataPoint_receive
Type: object
Show Source
Nested Schema : MachineSummary$SensorData$Histogram_receive
Type: object
Show Source
Nested Schema : OperatorSummary_receive
Type: object
Show Source
Nested Schema : workOrderIds
Type: array
Plan work order information
Show Source
Nested Schema : workOrderNumbers
Type: array
Plan work order number information
Show Source

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/products/digitalBirthCertificate

Example of Response Body

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


{
    "endTime":1469184297746,
    "endTimeAsString":"2016-07-22T10:44:57.746Z",
    "factoryId":"3a5e21b7e87-4fa3",
    "factoryName":"factory name",
    "productId":"6d174ba432a2-70b6",
    "productName":"product name",
    "productionLineId":"904205d1f55-5301",
    "productionLineName":"line name",
    "startTime":1469184297746,
    "startTimeAsString":"2016-07-22T10:44:57.746Z",
    "timeWindows":[
        {
            "endTime":1469184297746,
            "endTimeAsString":"2016-07-22T10:44:57.746Z",
            "quantity":12345,
            "startTime":1469184297746,
            "startTimeAsString":"2016-07-22T10:44:57.746Z",
            "tasks":[
                {
                    "machines":[
                        {
                            "id":"138936732940-4f89",
                            "machineName":"Machine name",
                            "sensorData":[
                                {
                                    "average":0.0,
                                    "boxPlot":[
                                        {
                                            "endTime":1469184297746,
                                            "firstQuartile":0.0,
                                            "max":0.0,
                                            "median":0.0,
                                            "min":0.0,
                                            "startTime":1469184297746,
                                            "thirdQuartile":0.0
                                        }
                                    ],
                                    "data":[
                                        {
                                            "timestamp":12345,
                                            "value":0.0
                                        }
                                    ],
                                    "device":"Device Id",
                                    "format":"Message format",
                                    "histogram":[
                                        {
                                            "count":2,
                                            "lowerBound":0.0,
                                            "upperBound":0.0
                                        }
                                    ],
                                    "max":0.0,
                                    "median":0.0,
                                    "min":0.0,
                                    "sensorAttribute":"Attribute name"
                                }
                            ],
                            "workOrderIds":[
                                "workOrderIds_1",
                                "workOrderIds_2",
                                "workOrderIds_3"
                            ],
                            "workOrderNumbers":[
                                "workOrderNumbers_1",
                                "workOrderNumbers_2",
                                "workOrderNumbers_3"
                            ]
                        }
                    ],
                    "operators":[
                        {
                            "username":"Operator id of summary data",
                            "workOrderIds":[
                                "workOrderIds_1",
                                "workOrderIds_2",
                                "workOrderIds_3"
                            ],
                            "workOrderNumbers":[
                                "workOrderNumbers_1",
                                "workOrderNumbers_2",
                                "workOrderNumbers_3"
                            ]
                        }
                    ],
                    "taskId":"31f525942f2c-5067",
                    "taskName":"Task name of the production plan"
                }
            ]
        }
    ]
}



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/products/digitalBirthCertificate



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