Skip to main content

Read Business Metadata for an Entity

GET 
/catalog/v1/entity/type/:typeName/name/:qualifiedName/businessmetadata

Generally Available

Gets the list of business metadata for a given entity represented by a qualified name.

Request​

Responses​

The business metadata

OpenAPI definition (YAML) 
paths:
  /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata:
    get:
      description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)


        Gets the list of business metadata for a given entity represented

        by a qualified name.'
      operationId: getBusinessMetadata
      tags:
      - Entity (v1)
      parameters:
      - description: The type of the entity
        explode: false
        in: path
        name: typeName
        required: true
        schema:
          type: string
        style: simple
      - description: The qualified name of the entity
        explode: false
        in: path
        name: qualifiedName
        required: true
        schema:
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  properties:
                    typeName:
                      type: string
                      description: The business metadata name
                    attributes:
                      type: object
                      description: The business metadata attributes
                    entityType:
                      type: string
                      description: The entity type
                    entityName:
                      type: string
                      description: The qualified name of the entity
                    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
                  type: object
                  title: BusinessMetadataResponse
                type: array
          description: The business metadata
        '400':
          description: Bad Request
        '404':
          description: Entity 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