Microsoft Azure · Capability

Microsoft Azure Purview Catalog Service REST API Document — Entity

Microsoft Azure Purview Catalog Service REST API Document — Entity. 34 operations. Lead operation: Microsoft Azure Post Atlas Entity. Self-contained Naftiko capability covering one Microsoft Azure business surface.

Run with Naftiko Microsoft AzureEntity

What You Can Do

POST
Microsoftazureentitycreateorupdate — Microsoft Azure Post Atlas Entity
/v1/atlas/v2/entity
GET
Microsoftazureentitylistbyguids — Microsoft Azure Get Atlas Entity Bulk
/v1/atlas/v2/entity/bulk
POST
Microsoftazureentitycreateorupdateentities — Microsoft Azure Post Atlas Entity Bulk
/v1/atlas/v2/entity/bulk
DELETE
Microsoftazureentitydeletebyguids — Microsoft Azure Delete Atlas Entity Bulk
/v1/atlas/v2/entity/bulk
POST
Microsoftazureentityaddclassification — Microsoft Azure Post Atlas Entity Bulk Classification
/v1/atlas/v2/entity/bulk/classification
POST
Microsoftazureentitysetclassifications — Microsoft Azure Post Atlas Entity Bulk Setclassifications
/v1/atlas/v2/entity/bulk/setclassifications
GET
Microsoftazureentitygetentitiesbyuniqueattributes — Microsoft Azure Get Atlas Entity Bulk Uniqueattribute Type Typename
/v1/atlas/v2/entity/bulk/uniqueattribute/type/{typename}
POST
Microsoftazureentityimportbusinessmetadata — Microsoft Azure Post Atlas Entity Businessmetadata Import
/v1/atlas/v2/entity/businessmetadata/import
GET
Microsoftazureentitygetsamplebusinessmetadatatemplate — Microsoft Azure Get Atlas Entity Businessmetadata Import Template
/v1/atlas/v2/entity/businessmetadata/import/template
GET
Microsoftazureentitygetbyguid — Microsoft Azure Get Atlas Entity Guid Guid
/v1/atlas/v2/entity/guid/{guid}
PUT
Microsoftazureentitypartialupdateentityattributebyguid — Microsoft Azure Put Atlas Entity Guid Guid
/v1/atlas/v2/entity/guid/{guid}
DELETE
Microsoftazureentitydeletebyguid — Microsoft Azure Delete Atlas Entity Guid Guid
/v1/atlas/v2/entity/guid/{guid}
DELETE
Microsoftazureentitydeletebusinessmetadata — Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata
/v1/atlas/v2/entity/guid/{guid}/businessmetadata
POST
Microsoftazureentityaddorupdatebusinessmetadata — Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata
/v1/atlas/v2/entity/guid/{guid}/businessmetadata
DELETE
Microsoftazureentitydeletebusinessmetadataattributes — Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata Bmname
/v1/atlas/v2/entity/guid/{guid}/businessmetadata/{bmname}
POST
Microsoftazureentityaddorupdatebusinessmetadataattributes — Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata Bmname
/v1/atlas/v2/entity/guid/{guid}/businessmetadata/{bmname}
GET
Microsoftazureentitygetclassification — Microsoft Azure Get Atlas Entity Guid Guid Classification Classificationname
/v1/atlas/v2/entity/guid/{guid}/classification/{classificationname}
DELETE
Microsoftazureentitydeleteclassification — Microsoft Azure Delete Atlas Entity Guid Guid Classification Classificationname
/v1/atlas/v2/entity/guid/{guid}/classification/{classificationname}
GET
Microsoftazureentitygetclassifications — Microsoft Azure Get Atlas Entity Guid Guid Classifications
/v1/atlas/v2/entity/guid/{guid}/classifications
POST
Microsoftazureentityaddclassifications — Microsoft Azure Post Atlas Entity Guid Guid Classifications
/v1/atlas/v2/entity/guid/{guid}/classifications
PUT
Microsoftazureentityupdateclassifications — Microsoft Azure Put Atlas Entity Guid Guid Classifications
/v1/atlas/v2/entity/guid/{guid}/classifications
GET
Microsoftazureentitygetheader — Microsoft Azure Get Atlas Entity Guid Guid Header
/v1/atlas/v2/entity/guid/{guid}/header
DELETE
Microsoftazureentitydeletelabels — Microsoft Azure Delete Atlas Entity Guid Guid Labels
/v1/atlas/v2/entity/guid/{guid}/labels
POST
Microsoftazureentitysetlabels — Microsoft Azure Post Atlas Entity Guid Guid Labels
/v1/atlas/v2/entity/guid/{guid}/labels
PUT
Microsoftazureentityaddlabel — Microsoft Azure Put Atlas Entity Guid Guid Labels
/v1/atlas/v2/entity/guid/{guid}/labels
GET
Microsoftazureentitygetbyuniqueattributes — Microsoft Azure Get Atlas Entity Uniqueattribute Type Typename
/v1/atlas/v2/entity/uniqueattribute/type/{typename}
PUT
Microsoftazureentitypartialupdateentitybyuniqueattributes — Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename
/v1/atlas/v2/entity/uniqueattribute/type/{typename}
DELETE
Microsoftazureentitydeletebyuniqueattribute — Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename
/v1/atlas/v2/entity/uniqueattribute/type/{typename}
DELETE
Microsoftazureentitydeleteclassificationbyuniqueattribute — Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename Classification Classificationname
/v1/atlas/v2/entity/uniqueattribute/type/{typename}/classification/{classificationname}
POST
Microsoftazureentityaddclassificationsbyuniqueattribute — Microsoft Azure Post Atlas Entity Uniqueattribute Type Typename Classifications
/v1/atlas/v2/entity/uniqueattribute/type/{typename}/classifications
PUT
Microsoftazureentityupdateclassificationsbyuniqueattribute — Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename Classifications
/v1/atlas/v2/entity/uniqueattribute/type/{typename}/classifications
DELETE
Microsoftazureentitydeletelabelsbyuniqueattribute — Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename Labels
/v1/atlas/v2/entity/uniqueattribute/type/{typename}/labels
POST
Microsoftazureentitysetlabelsbyuniqueattribute — Microsoft Azure Post Atlas Entity Uniqueattribute Type Typename Labels
/v1/atlas/v2/entity/uniqueattribute/type/{typename}/labels
PUT
Microsoftazureentityaddlabelsbyuniqueattribute — Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename Labels
/v1/atlas/v2/entity/uniqueattribute/type/{typename}/labels

MCP Tools

microsoft-azure-post-atlas-entity

Microsoft Azure Post Atlas Entity

microsoft-azure-get-atlas-entity

Microsoft Azure Get Atlas Entity Bulk

read-only idempotent
microsoft-azure-post-atlas-entity-2

Microsoft Azure Post Atlas Entity Bulk

microsoft-azure-delete-atlas-entity

Microsoft Azure Delete Atlas Entity Bulk

idempotent
microsoft-azure-post-atlas-entity-3

Microsoft Azure Post Atlas Entity Bulk Classification

microsoft-azure-post-atlas-entity-4

Microsoft Azure Post Atlas Entity Bulk Setclassifications

microsoft-azure-get-atlas-entity-2

Microsoft Azure Get Atlas Entity Bulk Uniqueattribute Type Typename

read-only idempotent
microsoft-azure-post-atlas-entity-5

Microsoft Azure Post Atlas Entity Businessmetadata Import

microsoft-azure-get-atlas-entity-3

Microsoft Azure Get Atlas Entity Businessmetadata Import Template

read-only idempotent
microsoft-azure-get-atlas-entity-4

Microsoft Azure Get Atlas Entity Guid Guid

read-only idempotent
microsoft-azure-put-atlas-entity

Microsoft Azure Put Atlas Entity Guid Guid

idempotent
microsoft-azure-delete-atlas-entity-2

Microsoft Azure Delete Atlas Entity Guid Guid

idempotent
microsoft-azure-delete-atlas-entity-3

Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata

idempotent
microsoft-azure-post-atlas-entity-6

Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata

microsoft-azure-delete-atlas-entity-4

Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata Bmname

idempotent
microsoft-azure-post-atlas-entity-7

Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata Bmname

microsoft-azure-get-atlas-entity-5

Microsoft Azure Get Atlas Entity Guid Guid Classification Classificationname

read-only idempotent
microsoft-azure-delete-atlas-entity-5

Microsoft Azure Delete Atlas Entity Guid Guid Classification Classificationname

idempotent
microsoft-azure-get-atlas-entity-6

Microsoft Azure Get Atlas Entity Guid Guid Classifications

read-only idempotent
microsoft-azure-post-atlas-entity-8

Microsoft Azure Post Atlas Entity Guid Guid Classifications

microsoft-azure-put-atlas-entity-2

Microsoft Azure Put Atlas Entity Guid Guid Classifications

idempotent
microsoft-azure-get-atlas-entity-7

Microsoft Azure Get Atlas Entity Guid Guid Header

read-only idempotent
microsoft-azure-delete-atlas-entity-6

Microsoft Azure Delete Atlas Entity Guid Guid Labels

idempotent
microsoft-azure-post-atlas-entity-9

Microsoft Azure Post Atlas Entity Guid Guid Labels

microsoft-azure-put-atlas-entity-3

Microsoft Azure Put Atlas Entity Guid Guid Labels

idempotent
microsoft-azure-get-atlas-entity-8

Microsoft Azure Get Atlas Entity Uniqueattribute Type Typename

read-only idempotent
microsoft-azure-put-atlas-entity-4

Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename

idempotent
microsoft-azure-delete-atlas-entity-7

Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename

idempotent
microsoft-azure-delete-atlas-entity-8

Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename Classification Classificationname

idempotent
microsoft-azure-post-atlas-entity-10

Microsoft Azure Post Atlas Entity Uniqueattribute Type Typename Classifications

microsoft-azure-put-atlas-entity-5

Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename Classifications

idempotent
microsoft-azure-delete-atlas-entity-9

Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename Labels

idempotent
microsoft-azure-post-atlas-entity-11

Microsoft Azure Post Atlas Entity Uniqueattribute Type Typename Labels

microsoft-azure-put-atlas-entity-6

Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename Labels

idempotent

Capability Spec

purview-catalog-service-rest-api-document-entity.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure Purview Catalog Service REST API Document — Entity
  description: 'Microsoft Azure Purview Catalog Service REST API Document — Entity. 34 operations. Lead operation: Microsoft
    Azure Post Atlas Entity. Self-contained Naftiko capability covering one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - Entity
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: purview-catalog-service-rest-api-document-entity
    baseUri: ''
    description: Microsoft Azure Purview Catalog Service REST API Document — Entity business capability. Self-contained, no
      shared references.
    resources:
    - name: atlas-v2-entity
      path: /atlas/v2/entity
      operations:
      - name: microsoftazureentitycreateorupdate
        method: POST
        description: Microsoft Azure Post Atlas Entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: entity
          in: body
          type: string
          description: Atlas entity with extended information.
          required: true
    - name: atlas-v2-entity-bulk
      path: /atlas/v2/entity/bulk
      operations:
      - name: microsoftazureentitylistbyguids
        method: GET
        description: Microsoft Azure Get Atlas Entity Bulk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: query
          type: array
          description: An array of GUIDs of entities to list.
          required: true
      - name: microsoftazureentitycreateorupdateentities
        method: POST
        description: Microsoft Azure Post Atlas Entity Bulk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: entities
          in: body
          type: string
          description: An array of entities to create or update.
          required: true
      - name: microsoftazureentitydeletebyguids
        method: DELETE
        description: Microsoft Azure Delete Atlas Entity Bulk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: query
          type: array
          description: An array of GUIDs of entities to delete.
          required: true
    - name: atlas-v2-entity-bulk-classification
      path: /atlas/v2/entity/bulk/classification
      operations:
      - name: microsoftazureentityaddclassification
        method: POST
        description: Microsoft Azure Post Atlas Entity Bulk Classification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: request
          in: body
          type: string
          description: The request to associate a classification to multiple entities.
          required: true
    - name: atlas-v2-entity-bulk-setClassifications
      path: /atlas/v2/entity/bulk/setClassifications
      operations:
      - name: microsoftazureentitysetclassifications
        method: POST
        description: Microsoft Azure Post Atlas Entity Bulk Setclassifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: entityHeaders
          in: body
          type: string
          description: Atlas entity headers.
          required: true
    - name: atlas-v2-entity-bulk-uniqueAttribute-type-typeName
      path: /atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}
      operations:
      - name: microsoftazureentitygetentitiesbyuniqueattributes
        method: GET
        description: Microsoft Azure Get Atlas Entity Bulk Uniqueattribute Type Typename
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attr_N:qualifiedName
          in: query
          type: string
          description: Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1.
            (This is only an example. qualifie
    - name: atlas-v2-entity-businessmetadata-import
      path: /atlas/v2/entity/businessmetadata/import
      operations:
      - name: microsoftazureentityimportbusinessmetadata
        method: POST
        description: Microsoft Azure Post Atlas Entity Businessmetadata Import
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: uploadedInputStream
          in: formData
          type: file
          description: InputStream of file
    - name: atlas-v2-entity-businessmetadata-import-template
      path: /atlas/v2/entity/businessmetadata/import/template
      operations:
      - name: microsoftazureentitygetsamplebusinessmetadatatemplate
        method: GET
        description: Microsoft Azure Get Atlas Entity Businessmetadata Import Template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: atlas-v2-entity-guid-guid
      path: /atlas/v2/entity/guid/{guid}
      operations:
      - name: microsoftazureentitygetbyguid
        method: GET
        description: Microsoft Azure Get Atlas Entity Guid Guid
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: microsoftazureentitypartialupdateentityattributebyguid
        method: PUT
        description: Microsoft Azure Put Atlas Entity Guid Guid
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: The name of the attribute.
          required: true
        - name: body
          in: body
          type: object
          description: The value of the attribute.
          required: true
      - name: microsoftazureentitydeletebyguid
        method: DELETE
        description: Microsoft Azure Delete Atlas Entity Guid Guid
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: atlas-v2-entity-guid-guid-businessmetadata
      path: /atlas/v2/entity/guid/{guid}/businessmetadata
      operations:
      - name: microsoftazureentitydeletebusinessmetadata
        method: DELETE
        description: Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: BusinessMetadata
      - name: microsoftazureentityaddorupdatebusinessmetadata
        method: POST
        description: Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: isOverwrite
          in: query
          type: boolean
          description: Whether to overwrite the existing business metadata on the entity or not, default is false.
        - name: body
          in: body
          type: object
          description: Business Metadata
    - name: atlas-v2-entity-guid-guid-businessmetadata-bmName
      path: /atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}
      operations:
      - name: microsoftazureentitydeletebusinessmetadataattributes
        method: DELETE
        description: Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata Bmname
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: bmName
          in: path
          type: string
          description: BusinessMetadata name
          required: true
        - name: body
          in: body
          type: object
          description: BusinessMetadataAttributes
      - name: microsoftazureentityaddorupdatebusinessmetadataattributes
        method: POST
        description: Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata Bmname
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: bmName
          in: path
          type: string
          description: BusinessMetadata name
          required: true
        - name: body
          in: body
          type: object
          description: BusinessMetadataAttributes
    - name: atlas-v2-entity-guid-guid-classification-classificationName
      path: /atlas/v2/entity/guid/{guid}/classification/{classificationName}
      operations:
      - name: microsoftazureentitygetclassification
        method: GET
        description: Microsoft Azure Get Atlas Entity Guid Guid Classification Classificationname
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: microsoftazureentitydeleteclassification
        method: DELETE
        description: Microsoft Azure Delete Atlas Entity Guid Guid Classification Classificationname
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: atlas-v2-entity-guid-guid-classifications
      path: /atlas/v2/entity/guid/{guid}/classifications
      operations:
      - name: microsoftazureentitygetclassifications
        method: GET
        description: Microsoft Azure Get Atlas Entity Guid Guid Classifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: microsoftazureentityaddclassifications
        method: POST
        description: Microsoft Azure Post Atlas Entity Guid Guid Classifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: classifications
          in: body
          type: array
          description: An array of classifications to be added.
          required: true
      - name: microsoftazureentityupdateclassifications
        method: PUT
        description: Microsoft Azure Put Atlas Entity Guid Guid Classifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: classifications
          in: body
          type: array
          description: An array of classifications to be updated.
          required: true
    - name: atlas-v2-entity-guid-guid-header
      path: /atlas/v2/entity/guid/{guid}/header
      operations:
      - name: microsoftazureentitygetheader
        method: GET
        description: Microsoft Azure Get Atlas Entity Guid Guid Header
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: atlas-v2-entity-guid-guid-labels
      path: /atlas/v2/entity/guid/{guid}/labels
      operations:
      - name: microsoftazureentitydeletelabels
        method: DELETE
        description: Microsoft Azure Delete Atlas Entity Guid Guid Labels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: array
          description: set of labels to be deleted
      - name: microsoftazureentitysetlabels
        method: POST
        description: Microsoft Azure Post Atlas Entity Guid Guid Labels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: array
          description: set of labels to be set to the entity
      - name: microsoftazureentityaddlabel
        method: PUT
        description: Microsoft Azure Put Atlas Entity Guid Guid Labels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: array
          description: set of labels to be added
    - name: atlas-v2-entity-uniqueAttribute-type-typeName
      path: /atlas/v2/entity/uniqueAttribute/type/{typeName}
      operations:
      - name: microsoftazureentitygetbyuniqueattributes
        method: GET
        description: Microsoft Azure Get Atlas Entity Uniqueattribute Type Typename
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attr:qualifiedName
          in: query
          type: string
          description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique
            attributes)
      - name: microsoftazureentitypartialupdateentitybyuniqueattributes
        method: PUT
        description: Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attr:qualifiedName
          in: query
          type: string
          description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique
            attributes)
        - name: atlasEntityWithExtInfo
          in: body
          type: string
          description: Atlas entity with extended information.
          required: true
      - name: microsoftazureentitydeletebyuniqueattribute
        method: DELETE
        description: Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attr:qualifiedName
          in: query
          type: string
          description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique
            attributes)
    - name: atlas-v2-entity-uniqueAttribute-type-typeName-classification-classificationName
      path: /atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}
      operations:
      - name: microsoftazureentitydeleteclassificationbyuniqueattribute
        method: DELETE
        description: Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename Classification Classificationname
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attr:qualifiedName
          in: query
          type: string
          description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique
            attributes)
    - name: atlas-v2-entity-uniqueAttribute-type-typeName-classifications
      path: /atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications
      operations:
      - name: microsoftazureentityaddclassificationsbyuniqueattribute
        method: POST
        description: Microsoft Azure Post Atlas Entity Uniqueattribute Type Typename Classifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attr:qualifiedName
          in: query
          type: string
          description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique
            attributes)
        - name: atlasClassificationArray
          in: body
          type: array
          description: An array of classification to be added.
          required: true
      - name: microsoftazureentityupdateclassificationsbyuniqueattribute
        method: PUT
        description: Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename Classifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attr:qualifiedName
          in: query
          type: string
          description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique
            attributes)
        - name: atlasClassificationArray
          in: body
          type: array
          description: An array of classification to be updated.
          required: true
    - name: atlas-v2-entity-uniqueAttribute-type-typeName-labels
      path: /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels
      operations:
      - name: microsoftazureentitydeletelabelsbyuniqueattribute
        method: DELETE
        description: Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename Labels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attr:qualifiedName
          in: query
          type: string
          description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique
            attributes)
        - name: body
          in: body
          type: array
          description: set of labels to be deleted
      - name: microsoftazureentitysetlabelsbyuniqueattribute
        method: POST
        description: Microsoft Azure Post Atlas Entity Uniqueattribute Type Typename Labels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attr:qualifiedName
          in: query
          type: string
          description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique
            attributes)
        - name: body
          in: body
          type: array
          description: set of labels to be set
      - name: microsoftazureentityaddlabelsbyuniqueattribute
        method: PUT
        description: Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename Labels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attr:qualifiedName
          in: query
          type: string
          description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique
            attributes)
        - name: body
          in: body
          type: array
          description: set of labels to be added
  exposes:
  - type: rest
    namespace: purview-catalog-service-rest-api-document-entity-rest
    port: 8080
    description: REST adapter for Microsoft Azure Purview Catalog Service REST API Document — Entity. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/atlas/v2/entity
      name: atlas-v2-entity
      description: REST surface for atlas-v2-entity.
      operations:
      - method: POST
        name: microsoftazureentitycreateorupdate
        description: Microsoft Azure Post Atlas Entity
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitycreateorupdate
        with:
          entity: rest.entity
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/bulk
      name: atlas-v2-entity-bulk
      description: REST surface for atlas-v2-entity-bulk.
      operations:
      - method: GET
        name: microsoftazureentitylistbyguids
        description: Microsoft Azure Get Atlas Entity Bulk
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitylistbyguids
        with:
          guid: rest.guid
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: microsoftazureentitycreateorupdateentities
        description: Microsoft Azure Post Atlas Entity Bulk
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitycreateorupdateentities
        with:
          entities: rest.entities
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: microsoftazureentitydeletebyguids
        description: Microsoft Azure Delete Atlas Entity Bulk
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitydeletebyguids
        with:
          guid: rest.guid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/bulk/classification
      name: atlas-v2-entity-bulk-classification
      description: REST surface for atlas-v2-entity-bulk-classification.
      operations:
      - method: POST
        name: microsoftazureentityaddclassification
        description: Microsoft Azure Post Atlas Entity Bulk Classification
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentityaddclassification
        with:
          request: rest.request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/bulk/setclassifications
      name: atlas-v2-entity-bulk-setclassifications
      description: REST surface for atlas-v2-entity-bulk-setClassifications.
      operations:
      - method: POST
        name: microsoftazureentitysetclassifications
        description: Microsoft Azure Post Atlas Entity Bulk Setclassifications
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitysetclassifications
        with:
          entityHeaders: rest.entityHeaders
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/bulk/uniqueattribute/type/{typename}
      name: atlas-v2-entity-bulk-uniqueattribute-type-typename
      description: REST surface for atlas-v2-entity-bulk-uniqueAttribute-type-typeName.
      operations:
      - method: GET
        name: microsoftazureentitygetentitiesbyuniqueattributes
        description: Microsoft Azure Get Atlas Entity Bulk Uniqueattribute Type Typename
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitygetentitiesbyuniqueattributes
        with:
          attr_N:qualifiedName: rest.attr_N:qualifiedName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/businessmetadata/import
      name: atlas-v2-entity-businessmetadata-import
      description: REST surface for atlas-v2-entity-businessmetadata-import.
      operations:
      - method: POST
        name: microsoftazureentityimportbusinessmetadata
        description: Microsoft Azure Post Atlas Entity Businessmetadata Import
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentityimportbusinessmetadata
        with:
          uploadedInputStream: rest.uploadedInputStream
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/businessmetadata/import/template
      name: atlas-v2-entity-businessmetadata-import-template
      description: REST surface for atlas-v2-entity-businessmetadata-import-template.
      operations:
      - method: GET
        name: microsoftazureentitygetsamplebusinessmetadatatemplate
        description: Microsoft Azure Get Atlas Entity Businessmetadata Import Template
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitygetsamplebusinessmetadatatemplate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/guid/{guid}
      name: atlas-v2-entity-guid-guid
      description: REST surface for atlas-v2-entity-guid-guid.
      operations:
      - method: GET
        name: microsoftazureentitygetbyguid
        description: Microsoft Azure Get Atlas Entity Guid Guid
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitygetbyguid
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: microsoftazureentitypartialupdateentityattributebyguid
        description: Microsoft Azure Put Atlas Entity Guid Guid
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitypartialupdateentityattributebyguid
        with:
          name: rest.name
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: microsoftazureentitydeletebyguid
        description: Microsoft Azure Delete Atlas Entity Guid Guid
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitydeletebyguid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/guid/{guid}/businessmetadata
      name: atlas-v2-entity-guid-guid-businessmetadata
      description: REST surface for atlas-v2-entity-guid-guid-businessmetadata.
      operations:
      - method: DELETE
        name: microsoftazureentitydeletebusinessmetadata
        description: Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitydeletebusinessmetadata
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: microsoftazureentityaddorupdatebusinessmetadata
        description: Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentityaddorupdatebusinessmetadata
        with:
          isOverwrite: rest.isOverwrite
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/guid/{guid}/businessmetadata/{bmname}
      name: atlas-v2-entity-guid-guid-businessmetadata-bmname
      description: REST surface for atlas-v2-entity-guid-guid-businessmetadata-bmName.
      operations:
      - method: DELETE
        name: microsoftazureentitydeletebusinessmetadataattributes
        description: Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata Bmname
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitydeletebusinessmetadataattributes
        with:
          bmName: rest.bmName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: microsoftazureentityaddorupdatebusinessmetadataattributes
        description: Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata Bmname
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentityaddorupdatebusinessmetadataattributes
        with:
          bmName: rest.bmName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/guid/{guid}/classification/{classificationname}
      name: atlas-v2-entity-guid-guid-classification-classificationname
      description: REST surface for atlas-v2-entity-guid-guid-classification-classificationName.
      operations:
      - method: GET
        name: microsoftazureentitygetclassification
        description: Microsoft Azure Get Atlas Entity Guid Guid Classification Classificationname
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitygetclassification
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: microsoftazureentitydeleteclassification
        description: Microsoft Azure Delete Atlas Entity Guid Guid Classification Classificationname
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitydeleteclassification
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/guid/{guid}/classifications
      name: atlas-v2-entity-guid-guid-classifications
      description: REST surface for atlas-v2-entity-guid-guid-classifications.
      operations:
      - method: GET
        name: microsoftazureentitygetclassifications
        description: Microsoft Azure Get Atlas Entity Guid Guid Classifications
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitygetclassifications
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: microsoftazureentityaddclassifications
        description: Microsoft Azure Post Atlas Entity Guid Guid Classifications
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentityaddclassifications
        with:
          classifications: rest.classifications
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: microsoftazureentityupdateclassifications
        description: Microsoft Azure Put Atlas Entity Guid Guid Classifications
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentityupdateclassifications
        with:
          classifications: rest.classifications
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/guid/{guid}/header
      name: atlas-v2-entity-guid-guid-header
      description: REST surface for atlas-v2-entity-guid-guid-header.
      operations:
      - method: GET
        name: microsoftazureentitygetheader
        description: Microsoft Azure Get Atlas Entity Guid Guid Header
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitygetheader
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/guid/{guid}/labels
      name: atlas-v2-entity-guid-guid-labels
      description: REST surface for atlas-v2-entity-guid-guid-labels.
      operations:
      - method: DELETE
        name: microsoftazureentitydeletelabels
        description: Microsoft Azure Delete Atlas Entity Guid Guid Labels
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitydeletelabels
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: microsoftazureentitysetlabels
        description: Microsoft Azure Post Atlas Entity Guid Guid Labels
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitysetlabels
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: microsoftazureentityaddlabel
        description: Microsoft Azure Put Atlas Entity Guid Guid Labels
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentityaddlabel
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/atlas/v2/entity/uniqueattribute/type/{typename}
      name: atlas-v2-entity-uniqueattribute-type-typename
      description: REST surface for atlas-v2-entity-uniqueAttribute-type-typeName.
      operations:
      - method: GET
        name: microsoftazureentitygetbyuniqueattributes
        description: Microsoft Azure Get Atlas Entity Uniqueattribute Type Typename
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitygetbyuniqueattributes
        with:
          attr:qualifiedName: rest.attr:qualifiedName
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: microsoftazureentitypartialupdateentitybyuniqueattributes
        description: Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename
        call: purview-catalog-service-rest-api-document-entity.microsoftazureentitypartialupdateentitybyuniqueattributes
        with:
          attr:qualifiedName: rest.attr:qualifiedName
        

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/capabilities/purview-catalog-service-rest-api-document-entity.yaml