Skip to main content

Read an Entity

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

Generally Available

Fetch complete definition of an entity given its type and unique attribute.

Request​

Responses​

The entity

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


        Fetch complete definition of an entity given its type and unique attribute.'
      operationId: getByUniqueAttributes
      parameters:
      - name: typeName
        in: path
        description: The type of the entity
        required: true
        schema:
          type: string
      - name: qualifiedName
        in: path
        description: The qualified name of the entity
        required: true
        schema:
          type: string
      - name: minExtInfo
        in: query
        description: Whether to populate on header and schema attributes
        schema:
          type: boolean
          default: false
      - name: ignoreRelationships
        in: query
        description: Whether to ignore relationships
        schema:
          type: boolean
          default: false
      tags:
      - Entity (v1)
      responses:
        '200':
          description: The entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  referredEntities:
                    type: object
                    description: The referred entities
                    additionalProperties:
                      type: object
                      description: The entity
                      properties:
                        typeName:
                          type: string
                          description: The type name
                        attributes:
                          type: object
                          description: The type attributes
                        guid:
                          type: string
                          description: The internal guid
                        homeId:
                          type: string
                          description: The home id
                        isProxy:
                          type: boolean
                          description: Whether is a proxy
                          writeOnly: true
                        isIncomplete:
                          type: boolean
                          description: Whether is incomplete
                        provenanceType:
                          type: integer
                          description: The provenance type
                          format: int32
                        status:
                          type: string
                          description: The status
                          enum:
                          - ACTIVE
                          - DELETED
                          - PURGED
                        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
                        relationshipAttributes:
                          type: object
                          description: The relationship attributes
                        classifications:
                          type: array
                          description: The classifications (tags)
                          items:
                            type: object
                            properties:
                              typeName:
                                type: string
                                description: The tag name
                              attributes:
                                type: object
                                description: The tag attributes
                                additionalProperties:
                                  type: object
                              entityGuid:
                                type: string
                                description: The internal entity guid
                              entityStatus:
                                type: string
                                description: The entity status
                                enum:
                                - ACTIVE
                                - DELETED
                                - PURGED
                              propagate:
                                type: boolean
                                description: Whether to propagate the tag
                              validityPeriods:
                                type: array
                                description: The validity periods
                                items:
                                  type: object
                                  properties:
                                    startTime:
                                      type: string
                                      description: The start time of format yyyy/MM/dd HH:mm:ss
                                    endTime:
                                      type: string
                                      description: The end time of format yyyy/MM/dd HH:mm:ss
                                    timeZone:
                                      type: string
                                      description: The time zone (see java.util.TimeZone)
                                  title: TimeBoundary
                              removePropagationsOnEntityDelete:
                                type: boolean
                                description: Whether to remove propagations on entity delete
                            title: Classification
                        meanings:
                          type: array
                          description: The meanings
                          items:
                            type: object
                            properties:
                              termGuid:
                                type: string
                                description: The term guid
                              relationGuid:
                                type: string
                                description: The relation guid
                              description:
                                type: string
                                description: The description
                              displayText:
                                type: string
                                description: The display text
                              expression:
                                type: string
                                description: The expression
                              createdBy:
                                type: string
                                description: The creator
                              steward:
                                type: string
                                description: The steward
                              source:
                                type: string
                                description: The source
                              confidence:
                                type: integer
                                description: The confidence
                                format: int32
                              status:
                                type: string
                                description: The status
                                enum:
                                - DISCOVERED
                                - PROPOSED
                                - IMPORTED
                                - VALIDATED
                                - DEPRECATED
                                - OBSOLETE
                                - OTHER
                            title: TermAssignmentHeader
                        customAttributes:
                          type: object
                          description: The custom attributes
                          additionalProperties:
                            type: string
                        businessAttributes:
                          type: object
                          description: The business attributes
                          additionalProperties:
                            type: object
                        labels:
                          uniqueItems: true
                          type: array
                          description: The labels
                          items:
                            type: string
                        proxy:
                          type: boolean
                          description: Whether is a proxy
                      title: Entity
                  entity:
                    type: object
                    description: The entity
                    properties:
                      typeName:
                        type: string
                        description: The type name
                      attributes:
                        type: object
                        description: The type attributes
                      guid:
                        type: string
                        description: The internal guid
                      homeId:
                        type: string
                        description: The home id
                      isProxy:
                        type: boolean
                        description: Whether is a proxy
                        writeOnly: true
                      isIncomplete:
                        type: boolean
                        description: Whether is incomplete
                      provenanceType:
                        type: integer
                        description: The provenance type
                        format: int32
                      status:
                        type: string
                        description: The status
                        enum:
                        - ACTIVE
                        - DELETED
                        - PURGED
                      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
                      relationshipAttributes:
                        type: object
                        description: The relationship attributes
                      classifications:
                        type: array
                        description: The classifications (tags)
                        items:
                          type: object
                          properties:
                            typeName:
                              type: string
                              description: The tag name
                            attributes:
                              type: object
                              description: The tag attributes
                              additionalProperties:
                                type: object
                            entityGuid:
                              type: string
                              description: The internal entity guid
                            entityStatus:
                              type: string
                              description: The entity status
                              enum:
                              - ACTIVE
                              - DELETED
                              - PURGED
                            propagate:
                              type: boolean
                              description: Whether to propagate the tag
                            validityPeriods:
                              type: array
                              description: The validity periods
                              items:
                                type: object
                                properties:
                                  startTime:
                                    type: string
                                    description: The start time of format yyyy/MM/dd HH:mm:ss
                                  endTime:
                                    type: string
                                    description: The end time of format yyyy/MM/dd HH:mm:ss
                                  timeZone:
                                    type: string
                                    description: The time zone (see java.util.TimeZone)
                                title: TimeBoundary
                            removePropagationsOnEntityDelete:
                              type: boolean
                              description: Whether to remove propagations on entity delete
                          title: Classification
                      meanings:
                        type: array
                        description: The meanings
                        items:
                          type: object
                          properties:
                            termGuid:
                              type: string
                              description: The term guid
                            relationGuid:
                              type: string
                              description: The relation guid
                            description:
                              type: string
                              description: The description
                            displayText:
                              type: string
                              description: The display text
                            expression:
                              type: string
                              description: The expression
                            createdBy:
                              type: string
                              description: The creator
                            steward:
                              type: string
                              description: The steward
                            source:
                              type: string
                              description: The source
                            confidence:
                              type: integer
                              description: The confidence
                              format: int32
                            status:
                              type: string
                              description: The status
                              enum:
                              - DISCOVERED
                              - PROPOSED
                              - IMPORTED
                              - VALIDATED
                              - DEPRECATED
                              - OBSOLETE
                              - OTHER
                          title: TermAssignmentHeader
                      customAttributes:
                        type: object
                        description: The custom attributes
                        additionalProperties:
                          type: string
                      businessAttributes:
                        type: object
                        description: The business attributes
                        additionalProperties:
                          type: object
                      labels:
                        uniqueItems: true
                        type: array
                        description: The labels
                        items:
                          type: string
                      proxy:
                        type: boolean
                        description: Whether is a proxy
                    title: Entity
                title: EntityWithExtInfo
        '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