Update users belonging to an asset group
post
/assetMonitoring/clientapi/v2/groups/{asset-group-id}/users
Update asset group content details with provided partial or complete asset group content definition, by given asset group id.
Request
Supported Media Types
- application/json
Path Parameters
-
asset-group-id: string
Asset Group id to be patched
Header Parameters
-
X-HTTP-Method-Override: string
To perform update of the asset group content, POST request should be orchestrated with method override set to PATCH
Root Schema : AssetGroupUsersModificationImpl_receive
Type:
Show Source
object
-
operation:
string
One of [INSERT, REMOVE, REPLACE].
-
userIds:
array userIds
Property description was not set
-
userNames:
array userNames
Property description was not set
Nested Schema : items
Type:
object
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Root Schema : UserImpl_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
-
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
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
400 Response
Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
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.
405 Response
Method Not Allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
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.
415 Response
Unsupported Media Type. The request entity has a media type which the server or resource does not support.
Examples
curl -X POST
-u <username>:<password>
-H 'Accept: application/json'
-H 'Content-Type: application/json'
--header "X-HTTP-Method-Override: PATCH"
https://iotserver/assetMonitoring/clientapi/v2/groups/{asset-group-id}/users
Example of Request Body
The following example shows the content of the request body in JSON format:
{
"operation":"One of [INSERT, REMOVE, REPLACE].",
"userIds":[
"userIds_1",
"userIds_2",
"userIds_3"
]
}
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"count":2,
"hasMore":false,
"items":[
{
"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":"1bdb7bfc7956-f18",
"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"
]
},
{
"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":"344157c77717-be9",
"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"
]
}
],
"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 POST
-u <username>:<password>
-H 'Accept: application/json'
-H 'Content-Type: application/json'
--header "X-HTTP-Method-Override: PATCH"
-d '{"operation":"One of [INSERT, REMOVE, REPLACE].","userIds":["userIds_1","userIds_2","userIds_3"]}'
https://iotserver/assetMonitoring/clientapi/v2/groups/{asset-group-id}/users
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.