OpenAPI definition (YAML)
paths:
/catalog/v1/types/businessmetadatadefs/{bmName}:
get:
description: '[](#section/Versioning/API-Lifecycle-Policy)
Get the business metadata definition with the given name.'
operationId: getBusinessMetadataDefByName
tags:
- Types (v1)
parameters:
- description: The name of the business metadata definition
explode: false
in: path
name: bmName
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
properties:
category:
enum:
- PRIMITIVE
- OBJECT_ID_TYPE
- ENUM
- STRUCT
- CLASSIFICATION
- ENTITY
- ARRAY
- MAP
- RELATIONSHIP
- BUSINESS_METADATA
type: string
description: The category
guid:
type: string
description: The internal guid
createdBy:
type: string
description: The creator
updatedBy:
type: string
description: The updater
createTime:
format: int64
type: integer
description: The create time
updateTime:
format: int64
type: integer
description: The update time
version:
format: int32
type: integer
description: The version
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:
additionalProperties:
type: string
type: object
description: The options
attributeDefs:
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
type: array
description: The attribute definitions
type: object
title: BusinessMetadataDef
description: The business metadata definition
'400':
description: Bad Request
'404':
description: Business metadata definition not found
'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