Jump to

• Request
• Response
• Examples

Retrieve machine contextual data for sensor graph

get

/productionMonitoring/clientapi/v2/machines/{machine-id}/contextData

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

• machine-id: string
  The unique identifier of the machine.

Query Parameters

• contextFields(optional): string
  Entity description is undefined
• since(optional): integer
  Entity description is undefined
• until(optional): integer
  Entity description is undefined

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 : MachineContext_receive

Type: object

Show Source

• productsManufactured: array productsManufactured
  Products change
• stateChanges: array stateChanges
  States change

{
    "properties":{
        "productsManufactured":{
            "description":"Products change",
            "items":{
                "$ref":"#/definitions/MachineContext$ProductChange_receive"
            },
            "type":"array"
        },
        "stateChanges":{
            "description":"States change",
            "items":{
                "$ref":"#/definitions/MachineContext$StateChange_receive"
            },
            "type":"array"
        }
    },
    "required":[
        "stateChanges",
        "productsManufactured"
    ],
    "type":"object"
}

Nested Schema : productsManufactured

Type: array

Products change

Show Source

• Array of: object MachineContext$ProductChange_receive

{
    "description":"Products change",
    "items":{
        "$ref":"#/definitions/MachineContext$ProductChange_receive"
    },
    "type":"array"
}

Nested Schema : stateChanges

Type: array

States change

Show Source

• Array of: object MachineContext$StateChange_receive

{
    "description":"States change",
    "items":{
        "$ref":"#/definitions/MachineContext$StateChange_receive"
    },
    "type":"array"
}

Nested Schema : MachineContext$ProductChange_receive

Type: object

Show Source

• endTime: integer
  end time
• products: array products
  products change
• startTime: integer
  start time

{
    "properties":{
        "endTime":{
            "description":"end time",
            "type":"integer"
        },
        "products":{
            "description":"products change",
            "items":{
                "$ref":"#/definitions/MachineContext$ProductChange$Product_receive"
            },
            "type":"array"
        },
        "startTime":{
            "description":"start time",
            "type":"integer"
        }
    },
    "required":[
        "startTime",
        "endTime",
        "products"
    ],
    "type":"object"
}

Nested Schema : products

Type: array

products change

Show Source

• Array of: object MachineContext$ProductChange$Product_receive

{
    "description":"products change",
    "items":{
        "$ref":"#/definitions/MachineContext$ProductChange$Product_receive"
    },
    "type":"array"
}

Nested Schema : MachineContext$ProductChange$Product_receive

Type: object

Show Source

• id: string
  product id
• name: string
  product name

{
    "properties":{
        "id":{
            "description":"product id",
            "type":"string"
        },
        "name":{
            "description":"product name",
            "type":"string"
        }
    },
    "required":[
        "id",
        "name"
    ],
    "type":"object"
}

Nested Schema : MachineContext$StateChange_receive

Type: object

Show Source

• eventTime: integer
  event time
• state: string
  state change

{
    "properties":{
        "eventTime":{
            "description":"event time",
            "type":"integer"
        },
        "state":{
            "description":"state change",
            "type":"string"
        }
    },
    "required":[
        "eventTime",
        "state"
    ],
    "type":"object"
}

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/machines/{machine-id}/contextData 

Example of Response Body

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

{
    "productsManufactured":[
        {
            "endTime":1469184297746,
            "products":[
                {
                    "id":"7afc6a383c67-11f",
                    "name":"product name"
                }
            ],
            "startTime":1469184297746
        }
    ],
    "stateChanges":[
        {
            "eventTime":1469184297746,
            "state":"state change"
        }
    ]
} 

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/machines/6804643a5105-6cf4/contextData 

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