Jump to

• Request
• Response

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.

Body ()

The request body defines the tag assignments to create or delete, or create and delete.

Root Schema : createdeleteassignments-request

Type: object

Show Source

• 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.

{
    "properties":{
        "createAssignmentsTo":{
            "type":"object",
            "description":"Groups resources for tag assignments.",
            "properties":{
                "services":{
                    "type":"array",
                    "description":"Groups details about the service resources to assign tags to.",
                    "items":{
                        "$ref":"#/definitions/serviceassignment-details"
                    }
                }
            }
        },
        "tagsToAssign":{
            "type":"array",
            "description":"Groups details about the tags to assign. Each tag object is a key/value pair.",
            "items":{
                "$ref":"#/definitions/tagscreate-request"
            }
        },
        "deleteAssignmentsFrom":{
            "type":"object",
            "description":"Groups resources for tag unassignments.",
            "properties":{
                "services":{
                    "type":"array",
                    "description":"Groups details about the service resources to unassign tags from.",
                    "items":{
                        "$ref":"#/definitions/serviceassignment-details"
                    }
                }
            }
        },
        "tagsToUnassign":{
            "type":"array",
            "description":"Groups details about the tags to unassign. Each tag object is a key/value pair.",
            "items":{
                "$ref":"#/definitions/tagsdelete-request"
            }
        }
    },
    "required":[
        "tagsToAssign"
    ]
}

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.

{
    "type":"object",
    "description":"Groups resources for tag assignments.",
    "properties":{
        "services":{
            "type":"array",
            "description":"Groups details about the service resources to assign tags to.",
            "items":{
                "$ref":"#/definitions/serviceassignment-details"
            }
        }
    }
}

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.

{
    "type":"object",
    "description":"Groups resources for tag unassignments.",
    "properties":{
        "services":{
            "type":"array",
            "description":"Groups details about the service resources to unassign tags from.",
            "items":{
                "$ref":"#/definitions/serviceassignment-details"
            }
        }
    }
}

Nested Schema : tagsToAssign

Type: array

Groups details about the tags to assign. Each tag object is a key/value pair.

Show Source

• [0]: object tagscreate-request
  Each tag is a key/value pair.

{
    "type":"array",
    "description":"Groups details about the tags to assign. Each tag object is a key/value pair.",
    "items":{
        "$ref":"#/definitions/tagscreate-request"
    }
}

Nested Schema : tagsToUnassign

Type: array

Groups details about the tags to unassign. Each tag object is a key/value pair.

Show Source

• [0]: object tagsdelete-request

{
    "type":"array",
    "description":"Groups details about the tags to unassign. Each tag object is a key/value pair.",
    "items":{
        "$ref":"#/definitions/tagsdelete-request"
    }
}

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.

{
    "type":"array",
    "description":"Groups details about the service resources to assign tags to.",
    "items":{
        "$ref":"#/definitions/serviceassignment-details"
    }
}

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.

{
    "description":"Each object describes a service resource.",
    "properties":{
        "serviceName":{
            "type":"string",
            "description":"Name of the service instance (to tag or tagged)."
        },
        "serviceType":{
            "type":"string",
            "description":"Type of service. <p>For example, <code>DHCS</code> 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.

{
    "type":"array",
    "description":"Groups details about the service resources to unassign tags from.",
    "items":{
        "$ref":"#/definitions/serviceassignment-details"
    }
}

Nested Schema : tagscreate-request

Type: object

Each tag is a key/value pair.

Show Source

• key: string
  Specify the key for this tag. A tag key can contain letters, numbers, dashes (-), and underscores ( _ ), and it can contain up to 128 characters.
• value: string
  Specify the value for this tag. A tag value can contain up to 256 characters and is case-sensitive.

  Default value is an empty string (if you do not provide a specific value).

{
    "description":"Each tag is a key/value pair.",
    "properties":{
        "key":{
            "type":"string",
            "description":"Specify the key for this tag. A tag key can contain letters, numbers, dashes (-), and underscores ( _ ), and it can contain up to 128 characters."
        },
        "value":{
            "type":"string",
            "description":"Specify the value for this tag. A tag value can contain up to 256 characters and is case-sensitive.<p>Default value is an empty string (if you do not provide a specific value)."
        }
    },
    "required":[
        "key"
    ]
}

Nested Schema : tagsdelete-request

Type: object

Show Source

• key: string
  Key for this tag.
• value: string
  Value for this tag.

  Default value is an empty string (if you do not provide a specific value).

{
    "properties":{
        "key":{
            "type":"string",
            "description":"Key for this tag."
        },
        "value":{
            "type":"string",
            "description":"Value for this tag.<p>Default value is an empty string (if you do not provide a specific value)."
        }
    },
    "required":[
        "key"
    ]
}

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

The response body contains information about all tags and their assignments.

Root Schema : tagsassignments-response

Type: array

The response body contains information about all tags and their assignments.

Show Source

• [0]: object tagsassignments-details
  Each object describes a tag and its assignments.

{
    "description":"The response body contains information about all tags and their assignments.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/tagsassignments-details"
    }
}

Nested Schema : tagsassignments-details

Type: object

Each object describes a tag and its assignments.

Show Source

• assignments: object assignments
  Groups assignment details for this tag.
• key: string
  Tag key.
• value: string
  Tag value.

{
    "description":"Each object describes a tag and its assignments.",
    "properties":{
        "key":{
            "type":"string",
            "description":"Tag key."
        },
        "value":{
            "type":"string",
            "description":"Tag value."
        },
        "assignments":{
            "type":"object",
            "description":"Groups assignment details for this tag.",
            "properties":{
                "services":{
                    "type":"array",
                    "description":"Groups details about the service resources assigned with this tag.",
                    "items":{
                        "$ref":"#/definitions/serviceassignment-details"
                    }
                }
            }
        }
    }
}

Nested Schema : assignments

Type: object

Groups assignment details for this tag.

Show Source

• services: array services
  Groups details about the service resources assigned with this tag.

{
    "type":"object",
    "description":"Groups assignment details for this tag.",
    "properties":{
        "services":{
            "type":"array",
            "description":"Groups details about the service resources assigned with this tag.",
            "items":{
                "$ref":"#/definitions/serviceassignment-details"
            }
        }
    }
}

Nested Schema : services

Type: array

Groups details about the service resources assigned with this tag.

Show Source

• [0]: object serviceassignment-details
  Each object describes a service resource.

{
    "type":"array",
    "description":"Groups details about the service resources assigned with this tag.",
    "items":{
        "$ref":"#/definitions/serviceassignment-details"
    }
}

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.

{
    "description":"Each object describes a service resource.",
    "properties":{
        "serviceName":{
            "type":"string",
            "description":"Name of the service instance (to tag or tagged)."
        },
        "serviceType":{
            "type":"string",
            "description":"Type of service. <p>For example, <code>DHCS</code> for a Data Hub Cloud Service instance."
        }
    }
}

400 Response

Bad request.