Skip to main content

Bulk Update Business Metadata

PUT 
/catalog/v1/entity/businessmetadata

Generally Available

Bulk API to update multiple business metadata.

Request​

Responses​

The business metadata. Errored business metadata will have an additional error property.

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


        Bulk API to update multiple business metadata.'
      operationId: updateBusinessMetadata
      tags:
      - Entity (v1)
      requestBody:
        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
                type: object
                title: BusinessMetadata
              type: array
        description: The business metadata
      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. Errored business metadata will have an additional error
            property.
        '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
      jsonRequestBodyExample:
      - typeName: string
        attributes: {}
        entityType: string
        entityName: string