Developer Documentation
Detach Tag From Multiple Objects Tag Association
Released in v6.5Detaches the given tag from the input objects. If a tag is already removed from the object, then the individual operation is a no-op and an error will not be added to TagAssociation.BatchResult.error-messages. To invoke this operation, you need the attach tag privilege on the tag and the read privilege on each object.
Request
URLURL
https://{api_host}/rest/com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=detach-tag-from-multiple-objects
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag. |
Request Body
Request Body
Contains
DetachTagFromMultipleObjectsRequestBody
of type application/json
(required)
{}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | object_ids | array of Std_DynamicID |
The identifiers of the input objects. |
Response
Response
Response BodyResponse Body
200 OK returns
DetachTagFromMultipleObjectsResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: The outcome of the batch operation and the list of error messages (TagAssociation.BatchResult.error-messages) describing detachment failures.
{
"value": {
"success": false
}
}| Property Name | Type | Description |
|---|---|---|
| value | TagAssociationBatchResult |
The outcome of the batch operation and the list of error messages (TagAssociation.BatchResult.error-messages) describing detachment failures. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthorized : if you do not have the attach tag privilege on the tag. | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.not_found : if the tag for the given tag does not exist in the system. |
| default | Error | Not available |
