Retrieve asset group details by ID
get
/assetMonitoring/clientapi/v2/groups/{asset-group-id}
This operation returns the asset group details of the given asset group ID.
Request
Path Parameters
-
asset-group-id: string
ID of asset group to be retrieved from Oracle IoT Asset Monitoring Cloud Service.
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.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Root Schema : AssetGroupImpl_receive
Type:
Show Source
object
-
assets:
object assets
Property description was not set
-
assetsCount:
integer
Property description was not set
-
children:
array children
Property description was not set
-
description:
string
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
-
parentId:
string
Property description was not set
-
path:
array path
Property description was not set
-
placeId:
string
Property description was not set
-
query:
string
Property description was not set
-
restricted:
boolean
Property description was not set
-
type:
string
One of [STATIC, QUERY].
Nested Schema : assets
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 : AssetGroup_receive
Type:
Show Source
object
-
assets:
object assets
Property description was not set
-
assetsCount:
integer
Property description was not set
-
children:
array children
Property description was not set
-
description:
string
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
-
parentId:
string
Property description was not set
-
path:
array path
Property description was not set
-
placeId:
string
Property description was not set
-
query:
string
Property description was not set
-
restricted:
boolean
Property description was not set
-
type:
string
One of [STATIC, QUERY].
Nested Schema : assets
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 : PathToOrgEntityType_receive
Type:
Show Source
object
-
id:
string
Property description was not set
-
name:
string
Property description was not set
-
type:
string
One of [TRIP, TRIP_TEMPLATE, SHIPMENT, VEHICLE, DRIVER, ASSET, GROUP, FACILITY, LOAD, ORG, TRANSACTION_LOG, SHIP_UNIT, SHIP_ITEM, EQUIPMENT].
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/assetMonitoring/clientapi/v2/groups/{asset-group-id}
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"assets":{
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"assetsCount":12345,
"children":[
{
"assets":{
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"assetsCount":12345,
"description":"Property description was not set",
"id":"198313e91ad4-35d7",
"name":"Property description was not set",
"organizationId":"581a3e6e38ca-131f",
"parentId":"10a34ebd236f-47c0",
"path":[
{
"id":"5c256200375e-5326",
"name":"Property description was not set",
"type":"One of [TRIP, TRIP_TEMPLATE, SHIPMENT, VEHICLE, DRIVER, ASSET, GROUP, FACILITY, LOAD, ORG, TRANSACTION_LOG, SHIP_UNIT, SHIP_ITEM, EQUIPMENT]."
}
],
"placeId":"7b34649f79b1-35a0",
"query":"Property description was not set",
"restricted":false,
"type":"One of [STATIC, QUERY]."
}
],
"description":"Property description was not set",
"id":"745043d56c98-5625",
"name":"Property description was not set",
"organizationId":"5bd4123c626-2256",
"parentId":"547c19da734-6563",
"path":[
{
"id":"3acf6744595e-6f45",
"name":"Property description was not set",
"type":"One of [TRIP, TRIP_TEMPLATE, SHIPMENT, VEHICLE, DRIVER, ASSET, GROUP, FACILITY, LOAD, ORG, TRANSACTION_LOG, SHIP_UNIT, SHIP_ITEM, EQUIPMENT]."
}
],
"placeId":"192847936b48-1e7f",
"query":"Property description was not set",
"restricted":false,
"type":"One of [STATIC, QUERY]."
}
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/groups/{asset-group-id}
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.