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

Retrieve machine metrics by ID

get

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

Retrieve machine metrics by machine 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
  • The unique identifier of the machine to get metrics from Oracle IoT Cloud Service
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 : MetricValue_receive
Type: object
Show Source
Nested Schema : GeoPosition_receive
Type: object
Show Source
Nested Schema : metadata
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : params
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : additionalElements
Type: array
Property description was not set
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/machines/{machine-id}/metrics

Example of Response Body

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


{
    "booleanValue":false,
    "computedTime":1469184297746,
    "confidenceLevel":12345,
    "entityId":"16ec614e710f-7eeb",
    "entityType":"Property description was not set",
    "eventTime":1469184297746,
    "eventTimeAsString":"2016-07-22T10:44:57.746Z",
    "geoLocationValue":{
        "additionalElements":[
            "additionalElements_1",
            "additionalElements_2",
            "additionalElements_3"
        ],
        "altitude":0.0,
        "latitude":0.0,
        "longitude":0.0,
        "valid":false
    },
    "id":"6ca87f1710be-345e",
    "interval":"One of [DYNAMIC, CURRENT, EVERY2MINUTE, HOURLY, DAILY, NEXT24HOURS, WEEKLY, BIWEEKLY, NEXT7DAYS, NEXT30DAYS, MONTHLY, DAYS90, STATIC].",
    "lastKnown":false,
    "metadata":{
        "metadata_key1":"metadata_value1",
        "metadata_key2":"metadata_value2",
        "metadata_key3":"metadata_value3"
    },
    "name":"Property description was not set",
    "numericValue":12345,
    "params":{
        "params_key1":"params_value1",
        "params_key2":"params_value2",
        "params_key3":"params_value3"
    },
    "stringValue":"Property description was not set",
    "type":"One of [KPI, PREDICTION, ANOMALY, TREND_NELSON, TREND, SENSOR]."
}



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/5c51379b43a0-35ad/metrics



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