OpenAPI definition (YAML)
paths:
/catalog/v1/types/tagdefs:
get:
description: '[](#section/Versioning/API-Lifecycle-Policy)
Bulk retrieval API for retrieving tag definitions.'
operationId: getAllTagDefs
parameters:
- name: prefix
in: query
description: The prefix of a tag definition name
schema:
type: string
tags:
- Types (v1)
responses:
'200':
description: The tag definitions
content:
application/json:
schema:
type: array
items:
type: object
properties:
category:
type: string
description: The category
enum:
- PRIMITIVE
- OBJECT_ID_TYPE
- ENUM
- STRUCT
- CLASSIFICATION
- ENTITY
- ARRAY
- MAP
- RELATIONSHIP
- BUSINESS_METADATA
guid:
type: string
description: The internal guid
createdBy:
type: string
description: The creator
updatedBy:
type: string
description: The updater
createTime:
type: integer
description: The create time
format: int64
updateTime:
type: integer
description: The update time
format: int64
version:
type: integer
description: The version
format: int32
name:
type: string
description: The name
description:
type: string
description: The description
typeVersion:
type: string
description: The type version
serviceType:
type: string
description: The service type
options:
type: object
description: The options
additionalProperties:
type: string
attributeDefs:
type: array
description: The attribute definitions
items:
type: object
properties:
name:
type: string
description: The name
typeName:
type: string
description: The type name
isOptional:
type: boolean
description: Whether is optional
cardinality:
type: string
description: The cardinality
enum:
- SINGLE
- LIST
- SET
valuesMinCount:
type: integer
description: The values min count
format: int32
valuesMaxCount:
type: integer
description: The values max count
format: int32
isUnique:
type: boolean
description: Whether is unique
isIndexable:
type: boolean
description: Whether is indexable
includeInNotification:
type: boolean
description: Whether to include in notifications
defaultValue:
type: string
description: The default value
description:
type: string
description: The description
searchWeight:
type: integer
description: The search weight
format: int32
indexType:
type: string
description: The index type
enum:
- DEFAULT
- STRING
constraints:
type: array
description: The constraints
items:
type: object
properties:
type:
type: string
description: The type
params:
type: object
description: The params
additionalProperties:
type: object
title: ConstraintDef
options:
type: object
description: The options
additionalProperties:
type: string
displayName:
type: string
description: The display name
title: AttributeDef
superTypes:
uniqueItems: true
type: array
description: The supertypes
items:
type: string
entityTypes:
uniqueItems: true
type: array
description: The entity types
items:
type: string
subTypes:
uniqueItems: true
type: array
description: The subtypes
items:
type: string
error:
type: object
properties:
error_code:
type: integer
description: The error code
format: int32
message:
type: string
description: The error message
description: Error message of this operation
title: ErrorMessage
title: TagDefResponse
'400':
description: Bad Request
'429':
description: Rate Limit Error
'500':
description: Internal Server Error
servers:
- url: https://psrc-00000.region.provider.confluent.cloud
description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud