Retrieve Out-of-Box Factory Dashboard metrics
get
/productionMonitoring/clientapi/v2/factories/{factory-id}/dashboard
by factory 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
-
factory-id: string
The unique identifier of the factory from which to retrieve Out-of-Box Factory Dashboard metrics.
Query Parameters
-
limit(optional): integer
The maximum number of entries to return to the end user.
-
offset(optional): integer
The number that the first record of results is starting from.
-
since(optional): integer
The starting point of the desired time interval, in milliseconds. The default is 0.
-
totalResults(optional): boolean
The total number of results suiting the request.
-
until(optional): integer
The finishing point of the desired time interval, in milliseconds. The default is 0.
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.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=collection
200 Response
Successfully processed.
Root Schema : MetricValue_receive
Type:
Show Source
object
-
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
-
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: additionalPropertiesProperty 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: additionalPropertiesProperty description was not set
-
stringValue(optional):
string
Property description was not set
-
type:
string
One of [KPI, PREDICTION, ANOMALY, TREND_NELSON, TREND, SENSOR].
Nested Schema : GeoPosition_receive
Type:
Show Source
object
-
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
Nested Schema : metadata
Type:
object
Additional Properties Allowed
Show Source
-
string
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
-
string
A map of the following type: Map<String, String>
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.
Examples
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/productionMonitoring/clientapi/v2/factories/{factory-id}/dashboard
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"booleanValue":false,
"computedTime":1469184297746,
"confidenceLevel":12345,
"entityId":"410727d038e6-5def",
"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":"1c5d70876ff5-72de",
"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/factories/750a362b6ac-722/dashboard
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.