Jump to

• Request
• Response

Create and Assign Tags

post

/paas/api/v1.1/tags/{identityDomainId}/tags

Creates tags and assigns them to existing resources in the same request.

You can also create tags without creating assignments.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Data Hub Cloud Service account.

Body ()

The request body defines the tags to create and the services to assign the tags to.

Root Schema : createassigntags-request

Type: object

Show Source

• assignments: object assignments
  Groups details about the tag assignments to create.
• tags: array tags
  Groups details about the tags to create. Each tag object is a key/value pair.

{
    "properties":{
        "assignments":{
            "type":"object",
            "description":"Groups details about the tag assignments to create.",
            "properties":{
                "services":{
                    "type":"array",
                    "description":"Groups details about the service resources to tag. Each new tag created is assigned to each service resource.",
                    "items":{
                        "$ref":"#/definitions/serviceassignment-details"
                    }
                }
            }
        },
        "tags":{
            "type":"array",
            "description":"Groups details about the tags to create. Each tag object is a key/value pair.",
            "items":{
                "$ref":"#/definitions/tagscreate-request"
            }
        }
    },
    "required":[
        "tags"
    ]
}

Nested Schema : assignments

Type: object

Groups details about the tag assignments to create.

Show Source

• services: array services
  Groups details about the service resources to tag. Each new tag created is assigned to each service resource.

{
    "type":"object",
    "description":"Groups details about the tag assignments to create.",
    "properties":{
        "services":{
            "type":"array",
            "description":"Groups details about the service resources to tag. Each new tag created is assigned to each service resource.",
            "items":{
                "$ref":"#/definitions/serviceassignment-details"
            }
        }
    }
}

Nested Schema : tags

Type: array

Groups details about the tags to create. 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 create. Each tag object is a key/value pair.",
    "items":{
        "$ref":"#/definitions/tagscreate-request"
    }
}

Nested Schema : services

Type: array

Groups details about the service resources to tag. Each new tag created is assigned to each service resource.

Show Source

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

{
    "type":"array",
    "description":"Groups details about the service resources to tag. Each new tag created is assigned to each service resource.",
    "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 : 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"
    ]
}

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.