REST API for Oracle IoT Fleet Monitoring Cloud Service

Retrieve shipment metrics

get

/fleetMonitoring/clientapi/v2/shipments/{id}/metrics

This operation returns the metrics of a shipment specified by its ID.

Request

Path Parameters

id: string

Shipment ID

Header Parameters

X-ORACLE-IOT-ORG(optional): string

To allow targeting requests to different organizations. The header value should contain the organization identifier(orgId). This header is optional, if not provided orgId will be ORA_DEFAULT_ORG

Response

Supported Media Types

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

200 Response

Successfully processed.

Root Schema : MetricSnapshot_receive

Type: object

Show Source

metricValues: array metricValues

The metric values of an entity

{
    "properties":{
        "metricValues":{
            "description":"The metric values of an entity",
            "items":{
                "$ref":"#/definitions/MetricValue_receive"
            },
            "type":"array"
        }
    },
    "required":[
        "metricValues"
    ],
    "type":"object"
}

Nested Schema : metricValues

Type: array

The metric values of an entity

Show Source

Array of: object MetricValue_receive

{
    "description":"The metric values of an entity",
    "items":{
        "$ref":"#/definitions/MetricValue_receive"
    },
    "type":"array"
}

Nested Schema : MetricValue_receive

Type: object

Show Source

booleanValue(optional): boolean

Property description was not set
computedTime: integer

Property description was not set
confidenceLevel(optional): integer

Property description was not set
entityId: string

Property description was not set
entityType: string

Property description was not set
esAdditionalData: object esAdditionalData

Additional Properties Allowed: additionalProperties

Property description was not set
esRelationType: object EsJoinFieldValue_receive
eventTime: integer

Property description was not set
eventTimeAsString: string

Property description was not set
geoLocationValue(optional): object GeoPosition_receive
id: string

Property description was not set
interval: string

One of [DYNAMIC, CURRENT, EVERY2MINUTE, HOURLY, DAILY, NEXT24HOURS, WEEKLY, BIWEEKLY, NEXT7DAYS, NEXT30DAYS, MONTHLY, DAYS90, STATIC].
lastKnown: boolean

Property description was not set
metadata: object metadata

Additional Properties Allowed: additionalProperties

Property description was not set
name: string

Property description was not set
numericValue(optional): integer

Property description was not set
params: object params

Additional Properties Allowed: additionalProperties

Property description was not set
stringValue(optional): string

Property description was not set
type: string

One of [KPI, PREDICTION, ANOMALY, TREND_NELSON, TREND, SENSOR, CORRELATION, CLUSTERING].

{
    "properties":{
        "booleanValue":{
            "description":"Property description was not set",
            "type":"boolean"
        },
        "computedTime":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "confidenceLevel":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "entityId":{
            "description":"Property description was not set",
            "type":"string"
        },
        "entityType":{
            "description":"Property description was not set",
            "type":"string"
        },
        "esAdditionalData":{
            "additionalProperties":{
                "description":"A map of the following type: Map&lt;String, String&gt;",
                "type":"string"
            },
            "description":"Property description was not set",
            "properties":{
            },
            "type":"object"
        },
        "esRelationType":{
            "$ref":"#/definitions/EsJoinFieldValue_receive"
        },
        "eventTime":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "eventTimeAsString":{
            "description":"Property description was not set",
            "type":"string"
        },
        "geoLocationValue":{
            "$ref":"#/definitions/GeoPosition_receive"
        },
        "id":{
            "description":"Property description was not set",
            "type":"string"
        },
        "interval":{
            "description":"One of [DYNAMIC, CURRENT, EVERY2MINUTE, HOURLY, DAILY, NEXT24HOURS, WEEKLY, BIWEEKLY, NEXT7DAYS, NEXT30DAYS, MONTHLY, DAYS90, STATIC].",
            "type":"string"
        },
        "lastKnown":{
            "description":"Property description was not set",
            "type":"boolean"
        },
        "metadata":{
            "additionalProperties":{
                "description":"A map of the following type: Map&lt;String, String&gt;",
                "type":"string"
            },
            "description":"Property description was not set",
            "properties":{
            },
            "type":"object"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "numericValue":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "params":{
            "additionalProperties":{
                "description":"A map of the following type: Map&lt;String, String&gt;",
                "type":"string"
            },
            "description":"Property description was not set",
            "properties":{
            },
            "type":"object"
        },
        "stringValue":{
            "description":"Property description was not set",
            "type":"string"
        },
        "type":{
            "description":"One of [KPI, PREDICTION, ANOMALY, TREND_NELSON, TREND, SENSOR, CORRELATION, CLUSTERING].",
            "type":"string"
        }
    },
    "required":[
        "id",
        "name",
        "entityType",
        "eventTime",
        "computedTime",
        "eventTimeAsString",
        "interval",
        "entityId",
        "type",
        "lastKnown",
        "params",
        "metadata",
        "esRelationType",
        "esAdditionalData"
    ],
    "type":"object"
}

Nested Schema : esAdditionalData

Type: object

Additional Properties Allowed

Show Source

string

A map of the following type: Map<String, String>

{
    "additionalProperties":{
        "description":"A map of the following type: Map&lt;String, String&gt;",
        "type":"string"
    },
    "description":"Property description was not set",
    "properties":{
    },
    "type":"object"
}

Property description was not set

Show Source

{
    "additionalProperties":{
        "description":"A map of the following type: Map&lt;String, String&gt;",
        "type":"string"
    },
    "description":"Property description was not set",
    "properties":{
    },
    "type":"object"
}

Nested Schema : EsJoinFieldValue_receive

Type: object

Show Source

name: string

Property description was not set
parent: string

Property description was not set

{
    "properties":{
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "parent":{
            "description":"Property description was not set",
            "type":"string"
        }
    },
    "required":[
        "name",
        "parent"
    ],
    "type":"object"
}

Nested Schema : GeoPosition_receive

Type: object

Show Source

additionalElements: array additionalElements

Property description was not set
altitude: number

Property description was not set
latitude: number

Property description was not set
longitude: number

Property description was not set
valid: boolean

Property description was not set

{
    "properties":{
        "additionalElements":{
            "description":"Property description was not set",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "altitude":{
            "description":"Property description was not set",
            "type":"number"
        },
        "latitude":{
            "description":"Property description was not set",
            "type":"number"
        },
        "longitude":{
            "description":"Property description was not set",
            "type":"number"
        },
        "valid":{
            "description":"Property description was not set",
            "type":"boolean"
        }
    },
    "required":[
        "additionalElements",
        "latitude",
        "longitude",
        "altitude",
        "valid"
    ],
    "type":"object"
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

string

A map of the following type: Map<String, String>

{
    "additionalProperties":{
        "description":"A map of the following type: Map&lt;String, String&gt;",
        "type":"string"
    },
    "description":"Property description was not set",
    "properties":{
    },
    "type":"object"
}

Property description was not set

Show Source

{
    "additionalProperties":{
        "description":"A map of the following type: Map&lt;String, String&gt;",
        "type":"string"
    },
    "description":"Property description was not set",
    "properties":{
    },
    "type":"object"
}

Nested Schema : params

Type: object

Additional Properties Allowed

Show Source

string

A map of the following type: Map<String, String>

{
    "additionalProperties":{
        "description":"A map of the following type: Map&lt;String, String&gt;",
        "type":"string"
    },
    "description":"Property description was not set",
    "properties":{
    },
    "type":"object"
}

Property description was not set

Show Source

{
    "additionalProperties":{
        "description":"A map of the following type: Map&lt;String, String&gt;",
        "type":"string"
    },
    "description":"Property description was not set",
    "properties":{
    },
    "type":"object"
}

Nested Schema : additionalElements

Type: array

Property description was not set

Show Source

Array of: string

{
    "description":"Property description was not set",
    "items":{
        "type":"string"
    },
    "type":"array"
}

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.

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/shipments/{id}/metrics

Example of Response Body

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

{
    "metrics": {
        "sys_untraceableStatus": {
            "value": false,
            "time": 1524043840611,
            "timeAsString": "2018-04-18T09:30:40Z"
        },
        "sys_geoLocation": {
            "value": "37.80327, -122.47421, 0.0",
            "time": 1524043840604,
            "timeAsString": "2018-04-18T09:30:40Z"
        }
    }
}

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/fleetMonitoring/clientapi/v2/shipments/3be71c8f1402-691e/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.