Jump to

• Request
• Response

List All Tags

get

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

Returns all tags and tag assignments in the specified identity domain ID.

Use the optional ?services query parameter to list tags for one or more specific service instances.

Use the optional ?tagFilter query parameter to provide a search criteria based on tags.

Request

Path Parameters

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

Query Parameters

• services(optional): string
  When set to a specific service type and service name in the format service_type.instance_name, the response includes tags and assignments for the specified instance only. Use a comma separated list to get information for two or more service instances.

  For example:

  • DHCS.ExampleInstance
  • DHCS.ExampleInstance,DHCS.MyInstance01

• tagFilter(optional): string
  An expression using tag keys and values for filtering search results. Only results that satisfy the expression are returned in a search.

  When creating your filter expression:

  • Use the percent sign (%) to match multiple characters.
  • Use the underscore character (_) to match a single character.
  • Precede a literal character by a backslash character (\) if a key or value contains a literal percent sign (%), apostrophe or single quote ('), or underscore (_).

  Valid expressions include:

  • 'foo':'bar' - Finds all tags and assignments that have a key of 'foo' and a value of 'bar'
  • 'ora\_%':'%prod%' - Finds all tags and assignments that have a key starting with 'ora_' and a value containing 'prod'.
  • 'haMode' - Finds all tags and assignments that have a tag key of 'haMode'
  • 'ora\_%' - Finds all tags and assignments that a tag key starting with 'ora_'
  • 'site':'pe_r' - Uses the underscore wildcard to wildcard-match only a single character. For example, site=pear or site=peer is a match. site=pepper is not a match.
  • 'foo':'' - Finds all tags and assignments that have a tag key of 'foo' and an empty string as the value.
  • 'accuracy':'100\%' - Uses the literal percent sign in a value, so that it is not interpreted as a wildcard match.
  • 'type':'Abe\'s test' - Uses the apostrophe (single quote) in a key or value.
  • 'key\_contains\_underscores':'value\_does\_too' - Uses underscores in a key or value, so that they are not interpreted as single-character wildcards.

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."
        }
    }
}