Retrieve a list of assets.
get
/assetMonitoring/clientapi/v2/assets
This operation returns the list of assets existing for your Oracle IoT Asset Monitoring Cloud Service instance.
Request
Query Parameters
-
expand(optional): string
The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
-
fields(optional): string
The comma-separated list of fields to be shown in response. By default all response object fields will be present.
-
includeDraft(optional): string
Entity description is undefined
-
isHidden(optional): boolean
Entity description is undefined
-
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.
-
orderBy(optional): string
Ordering criteria for the returned assets list
-
q(optional): string
Query to filter asset on the server (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)
-
showSimulation(optional): boolean
Show simulation details for SENSOR and ALERT attributes
-
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.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=collection
200 Response
Successfully processed.
Root Schema : AssetImpl_receive_list
Type:
Show Source
object
-
count:
integer(int32)
-
hasMore:
boolean
-
items:
array items
-
limit:
integer(int32)
-
links:
array links
The set of API navigation links.
-
offset:
integer(int32)
Nested Schema : items
Type:
Show Source
object
-
actions:
object actions
Property description was not set
-
assignedPlace:
object Place_receive
-
attributes:
array attributes
Property description was not set
-
checkedOutBy:
string
Property description was not set
-
checkedOutStatus:
boolean
Property description was not set
-
checkedOutTime:
integer
Property description was not set
-
checkedOutTimeAsString:
string
Property description was not set
-
classes:
array classes
Property description was not set
-
description:
string
Property description was not set
-
eamId:
string
Property description was not set
-
geoLocation:
string
Property description was not set
-
groupNames:
array groupNames
Property description was not set
-
groups:
object groups
Property description was not set
-
id:
string
Property description was not set
-
idBasedPaths:
array idBasedPaths
Property description was not set
-
isHidden:
boolean
Property description was not set
-
lastModifiedBy:
string
Property description was not set
-
lastModifiedTime:
integer
Property description was not set
-
lastModifiedTimeAsString:
integer
Property description was not set
-
lastReportedTime:
integer
Property description was not set
-
lastReportedTimeAsString:
integer
Property description was not set
-
location:
string
Property description was not set
-
metricSnapshot:
object MetricSnapshot_receive
-
name:
string
Property description was not set
-
nameBasedPaths:
array nameBasedPaths
Property description was not set
-
organizationId:
string
Property description was not set
-
parentId:
string
Property description was not set
-
queryGroups:
object queryGroups
Property description was not set
-
registeredBy:
string
Property description was not set
-
registrationTime:
integer
Property description was not set
-
registrationTimeAsString:
integer
Property description was not set
-
status:
string
One of [DRAFT, ACTIVE, INACTIVE].
-
storagePlaces:
array storagePlaces
Property description was not set
-
tags:
array tags
Property description was not set
-
type:
string
Property description was not set
-
typeBasedPaths:
array typeBasedPaths
Property description was not set
-
typeId:
string
Property description was not set
Nested Schema : actions
Type:
object
Property description was not set
Show Source
-
links(optional):
array links
The set of API navigation links.
Nested Schema : Place_receive
Type:
Show Source
object
-
description:
string
Property description was not set
-
floorplan:
object FloorPlan_receive
-
geoFences:
array geoFences
Property description was not set
-
id:
string
Property description was not set
-
name:
string
Property description was not set
-
organizationId:
string
Property description was not set
-
parent:
string
Property description was not set
-
places:
object places
Property description was not set
-
tags:
array tags
Property description was not set
-
type:
string
Property description was not set
Nested Schema : groups
Type:
object
Property description was not set
Show Source
-
links(optional):
array links
The set of API navigation links.
Nested Schema : MetricSnapshot_receive
Type:
Show Source
object
-
metricValues:
array metricValues
Property description was not set
Nested Schema : queryGroups
Type:
object
Property description was not set
Show Source
-
links(optional):
array links
The set of API navigation links.
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : FloorPlan_receive
Type:
Show Source
object
-
description:
string
Property description was not set
-
id:
string
Property description was not set
-
image:
object image
-
name:
string
Property description was not set
-
referencePoints:
object FloorPlanReferencePoints_receive
Nested Schema : places
Type:
object
Property description was not set
Show Source
-
links(optional):
array links
The set of API navigation links.
Nested Schema : image
Type:
Show Source
object
-
links(optional):
array links
The set of API navigation links.
Nested Schema : FloorPlanReferencePoints_receive
Type:
Show Source
object
-
imageP1:
string
Property description was not set
-
imageP2:
string
Property description was not set
-
mapP1:
string
Property description was not set
-
mapP2:
string
Property description was not set
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : AssetAttribute_receive
Type:
Show Source
object
-
binaryValue:
string
Property description was not set
-
booleanValue:
boolean
Property description was not set
-
dateValue:
string
Property description was not set
-
name:
string
Property description was not set
-
numberValue:
integer
Property description was not set
-
stringValue:
string
Property description was not set
-
type:
string
One of [STRING, NUMBER, BOOLEAN, DATE, BINARY, DEVICE, ASSET, URI, ALERT, SENSOR].
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested 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
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
401 Response
Unauthorized. The request requires user authentication.
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/assetMonitoring/clientapi/v2/assets
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"count":2,
"hasMore":false,
"items":[
{
"actions":{
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"assignedPlace":{
"description":"Property description was not set",
"floorplan":{
"description":"Property description was not set",
"id":"303342797373-53f6",
"image":{
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"name":"Property description was not set",
"referencePoints":{
"imageP1":"Property description was not set",
"imageP2":"Property description was not set",
"mapP1":"Property description was not set",
"mapP2":"Property description was not set"
}
},
"geoFences":[
"geoFences_1",
"geoFences_2",
"geoFences_3"
],
"id":"178766c15b0c-2e7e",
"name":"Property description was not set",
"organizationId":"3d319e453a7-5c58",
"parent":"Property description was not set",
"places":{
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"tags":[
"tags_1",
"tags_2",
"tags_3"
],
"type":"Property description was not set"
},
"attributes":[
{
"binaryValue":"Property description was not set",
"booleanValue":false,
"dateValue":"Property description was not set",
"name":"Property description was not set",
"numberValue":12345,
"stringValue":"Property description was not set",
"type":"One of [STRING, NUMBER, BOOLEAN, DATE, BINARY, DEVICE, ASSET, URI, ALERT, SENSOR]."
}
],
"checkedOutBy":"Property description was not set",
"checkedOutStatus":false,
"checkedOutTime":1469184297746,
"checkedOutTimeAsString":"2016-07-22T10:44:57.746Z",
"classes":[
"classes_1",
"classes_2",
"classes_3"
],
"description":"Property description was not set",
"eamId":"297119647a4b-3631",
"geoLocation":"Property description was not set",
"groupNames":[
"groupNames_1",
"groupNames_2",
"groupNames_3"
],
"groups":{
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"id":"57615a1b5366-4b93",
"idBasedPaths":[
"idBasedPaths_1",
"idBasedPaths_2",
"idBasedPaths_3"
],
"isHidden":false,
"lastModifiedBy":"Property description was not set",
"lastModifiedTime":1469184297746,
"lastModifiedTimeAsString":1469184297746,
"lastReportedTime":1469184297746,
"lastReportedTimeAsString":1469184297746,
"location":"Property description was not set",
"metricSnapshot":{
"metricValues":[
{
"booleanValue":false,
"computedTime":1469184297746,
"confidenceLevel":12345,
"entityId":"223e1a932f0a-252d",
"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":"753259f3452b-7eaa",
"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]."
}
]
},
"name":"Property description was not set",
"nameBasedPaths":[
"nameBasedPaths_1",
"nameBasedPaths_2",
"nameBasedPaths_3"
],
"organizationId":"62bb688a5a65-6a82",
"parentId":"514e2392a9e-5a0e",
"queryGroups":{
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"registeredBy":"Property description was not set",
"registrationTime":1469184297746,
"registrationTimeAsString":1469184297746,
"status":"One of [DRAFT, ACTIVE, INACTIVE].",
"storagePlaces":[
"storagePlaces_1",
"storagePlaces_2",
"storagePlaces_3"
],
"tags":[
"tags_1",
"tags_2",
"tags_3"
],
"type":"Property description was not set",
"typeBasedPaths":[
"typeBasedPaths_1",
"typeBasedPaths_2",
"typeBasedPaths_3"
],
"typeId":"10f7410259c-2e09"
},
{
"actions":{
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"assignedPlace":{
"description":"Property description was not set",
"floorplan":{
"description":"Property description was not set",
"id":"15792b06385-3e53",
"image":{
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"name":"Property description was not set",
"referencePoints":{
"imageP1":"Property description was not set",
"imageP2":"Property description was not set",
"mapP1":"Property description was not set",
"mapP2":"Property description was not set"
}
},
"geoFences":[
"geoFences_1",
"geoFences_2",
"geoFences_3"
],
"id":"263317447105-3b86",
"name":"Property description was not set",
"organizationId":"1df96eb543e-72aa",
"parent":"Property description was not set",
"places":{
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"tags":[
"tags_1",
"tags_2",
"tags_3"
],
"type":"Property description was not set"
},
"attributes":[
{
"binaryValue":"Property description was not set",
"booleanValue":false,
"dateValue":"Property description was not set",
"name":"Property description was not set",
"numberValue":12345,
"stringValue":"Property description was not set",
"type":"One of [STRING, NUMBER, BOOLEAN, DATE, BINARY, DEVICE, ASSET, URI, ALERT, SENSOR]."
}
],
"checkedOutBy":"Property description was not set",
"checkedOutStatus":false,
"checkedOutTime":1469184297746,
"checkedOutTimeAsString":"2016-07-22T10:44:57.746Z",
"classes":[
"classes_1",
"classes_2",
"classes_3"
],
"description":"Property description was not set",
"eamId":"6d8c21e157d2-6ef1",
"geoLocation":"Property description was not set",
"groupNames":[
"groupNames_1",
"groupNames_2",
"groupNames_3"
],
"groups":{
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"id":"36b21f35360-3a7c",
"idBasedPaths":[
"idBasedPaths_1",
"idBasedPaths_2",
"idBasedPaths_3"
],
"isHidden":false,
"lastModifiedBy":"Property description was not set",
"lastModifiedTime":1469184297746,
"lastModifiedTimeAsString":1469184297746,
"lastReportedTime":1469184297746,
"lastReportedTimeAsString":1469184297746,
"location":"Property description was not set",
"metricSnapshot":{
"metricValues":[
{
"booleanValue":false,
"computedTime":1469184297746,
"confidenceLevel":12345,
"entityId":"83a6f3c1c7a-4995",
"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":"396b7d273c93-69d9",
"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]."
}
]
},
"name":"Property description was not set",
"nameBasedPaths":[
"nameBasedPaths_1",
"nameBasedPaths_2",
"nameBasedPaths_3"
],
"organizationId":"6c3016cc1155-38c",
"parentId":"1e2233cc671e-51b8",
"queryGroups":{
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"registeredBy":"Property description was not set",
"registrationTime":1469184297746,
"registrationTimeAsString":1469184297746,
"status":"One of [DRAFT, ACTIVE, INACTIVE].",
"storagePlaces":[
"storagePlaces_1",
"storagePlaces_2",
"storagePlaces_3"
],
"tags":[
"tags_1",
"tags_2",
"tags_3"
],
"type":"Property description was not set",
"typeBasedPaths":[
"typeBasedPaths_1",
"typeBasedPaths_2",
"typeBasedPaths_3"
],
"typeId":"66383fd41901-3ecc"
}
],
"limit":10,
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
],
"offset":0
}
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/assetMonitoring/clientapi/v2/assets
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.