1. REST API for Oracle IoT Asset Monitoring Cloud Service
  2. Tasks
  3. Assets Groups

List asset groups

get

/assetMonitoring/clientapi/v2/groups

This operation returns the list of existing asset groups for your Oracle IoT Asset Monitoring Cloud Service instance.

Request

Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : AssetGroupImpl_receive_list
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : assets
Type: object
Property description was not set
Show Source
Nested Schema : children
Type: array
Property description was not set
Show Source
Nested Schema : path
Type: array
Property description was not set
Show Source
Nested Schema : AssetGroup_receive
Type: object
Show Source
Nested Schema : assets
Type: object
Property description was not set
Show Source
Nested Schema : children
Type: array
Property description was not set
Show Source
Nested Schema : path
Type: array
Property description was not set
Show Source
Nested Schema : PathToOrgEntityType_receive
Type: object
Show Source
  • Property description was not set
  • Property description was not set
  • 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.

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/assetMonitoring/clientapi/v2/groups

Example of Response Body

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


{
    "count":2,
    "hasMore":false,
    "items":[
        {
            "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":"7b4a6fcf58a6-7a75",
                    "name":"Property description was not set",
                    "organizationId":"6e7f1793024-64f1",
                    "parentId":"1246a864c99-6dea",
                    "path":[
                        {
                            "id":"4f364161243b-401e",
                            "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":"50c27e2e12d8-2b94",
                    "query":"Property description was not set",
                    "restricted":false,
                    "type":"One of [STATIC, QUERY]."
                }
            ],
            "description":"Property description was not set",
            "id":"3a881c4f2a69-5dab",
            "name":"Property description was not set",
            "organizationId":"4473484f78d8-1047",
            "parentId":"1e7d58863ecf-2400",
            "path":[
                {
                    "id":"7ed62e18dd7-3b52",
                    "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":"62476ac846a2-2471",
            "query":"Property description was not set",
            "restricted":false,
            "type":"One of [STATIC, QUERY]."
        },
        {
            "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":"da25e117e2e-6cdf",
                    "name":"Property description was not set",
                    "organizationId":"47af30a85ae7-24ae",
                    "parentId":"2afe76613e6c-3fe2",
                    "path":[
                        {
                            "id":"563e1c1a1aa6-545e",
                            "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":"7e711c8a2aea-bdf",
                    "query":"Property description was not set",
                    "restricted":false,
                    "type":"One of [STATIC, QUERY]."
                }
            ],
            "description":"Property description was not set",
            "id":"7a6f12053065-5095",
            "name":"Property description was not set",
            "organizationId":"3f757d4749d-1bf5",
            "parentId":"f6a4f695eb2-4a36",
            "path":[
                {
                    "id":"333219ff11be-e75",
                    "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":"7c2b31ce5afe-4a9a",
            "query":"Property description was not set",
            "restricted":false,
            "type":"One of [STATIC, QUERY]."
        }
    ],
    "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/groups



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