Retrieve static asset groups by asset
get
/assetMonitoring/clientapi/v2/assets/{asset-name}/groups
This operation returns the list the groups for which the given asset name is a member.
Request
Path Parameters
-
asset-name: string
Name of asset to be retrieved from Oracle IoT Cloud Service
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.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Root Schema : UserImpl_receive
Type:
Show Source
object
-
email:
string
Property description was not set
-
emailAddresses:
array emailAddresses
Property description was not set
-
firstName:
string
Property description was not set
-
id:
string
Property description was not set
-
internalUser:
boolean
Property description was not set
-
lastName:
string
Property description was not set
-
name:
string
Property description was not set
-
phoneNumbers:
array phoneNumbers
Property description was not set
-
roles:
array roles
Property description was not set
Nested Schema : EmailContact_receive
Type:
Show Source
object
-
primary:
boolean
Property description was not set
-
type:
string
One of [WORK, HOME, RECOVERY, OTHER].
-
value:
string
Property description was not set
-
verified:
boolean
Property description was not set
Nested Schema : PhoneContact_receive
Type:
Show Source
object
-
primary:
boolean
Property description was not set
-
type:
string
One of [WORK, HOME, RECOVERY, OTHER, MOBILE, FAX, PAGER].
-
value:
string
Property description was not set
-
verified:
boolean
Property description was not set
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/assets/{asset-name}/groups
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"email":"Property description was not set",
"emailAddresses":[
{
"primary":false,
"type":"One of [WORK, HOME, RECOVERY, OTHER].",
"value":"Property description was not set",
"verified":false
}
],
"firstName":"Property description was not set",
"id":"3e146f6152ae-2123",
"internalUser":false,
"lastName":"Property description was not set",
"name":"Property description was not set",
"phoneNumbers":[
{
"primary":false,
"type":"One of [WORK, HOME, RECOVERY, OTHER, MOBILE, FAX, PAGER].",
"value":"Property description was not set",
"verified":false
}
],
"roles":[
"roles_1",
"roles_2",
"roles_3"
]
}
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/{asset-name}/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.