Create and Delete Tag Assignments
put
/paas/api/v1.1/tags/{identityDomainId}/assignments
Creates and deletes tag assignments in the same request.
Set the ?createTagsIfNeeded
query parameter to true
to create new tags if the tag assignments in the payload contain tags that do not yet exist.
Set the optional ?force
query parameter to true
to force the request to complete even if any specified tags, service resources, or tag assignments are not found.
Request
Supported Media Types
- application/json
Path Parameters
-
identityDomainId: string
Identity domain ID for the Oracle Data Hub Cloud Service account.
Query Parameters
-
createTagsIfNeeded(optional): boolean
Flag that specifies whether to allow (
true
) or not allow (false
) tags to be created. -
force(optional): boolean
Flag that specifies whether to allow (
true
) or not allow (false
) the request to complete.
The request body defines the tag assignments to create or delete, or create and delete.
Root Schema : createdeleteassignments-request
Type:
Show Source
object
-
createAssignmentsTo:
object createAssignmentsTo
Groups resources for tag assignments.
-
deleteAssignmentsFrom:
object deleteAssignmentsFrom
Groups resources for tag unassignments.
-
tagsToAssign:
array tagsToAssign
Groups details about the tags to assign. Each tag object is a key/value pair.
-
tagsToUnassign:
array tagsToUnassign
Groups details about the tags to unassign. Each tag object is a key/value pair.
Nested Schema : createAssignmentsTo
Type:
object
Groups resources for tag assignments.
Show Source
-
services:
array services
Groups details about the service resources to assign tags to.
Nested Schema : deleteAssignmentsFrom
Type:
object
Groups resources for tag unassignments.
Show Source
-
services:
array services
Groups details about the service resources to unassign tags from.
Nested Schema : services
Type:
array
Groups details about the service resources to assign tags to.
Show Source
-
[0]:
object serviceassignment-details
Each object describes a service resource.
Nested Schema : serviceassignment-details
Type:
object
Each object describes a service resource.
Show Source
-
serviceName:
string
Name of the service instance (to tag or tagged).
-
serviceType:
string
Type of service.
For example,
DHCS
for a Data Hub Cloud Service instance.
Nested Schema : services
Type:
array
Groups details about the service resources to unassign tags from.
Show Source
-
[0]:
object serviceassignment-details
Each object describes a service resource.
Response
Supported Media Types
- application/json
200 Response
OK.
The response body contains information about all tags and their assignments.
Nested Schema : serviceassignment-details
Type:
object
Each object describes a service resource.
Show Source
-
serviceName:
string
Name of the service instance (to tag or tagged).
-
serviceType:
string
Type of service.
For example,
DHCS
for a Data Hub Cloud Service instance.
400 Response
Bad request.