Microsoft Purview · Capability

Microsoft Purview Data Map API — Entity

Microsoft Purview Data Map API — Entity. 15 operations. Lead operation: Microsoft Purview Create or update an entity. Self-contained Naftiko capability covering one Microsoft Purview business surface.

Run with Naftiko Microsoft PurviewEntity

What You Can Do

POST
Entitycreateorupdate — Microsoft Purview Create or update an entity
/v1/api/atlas/v2/entity
GET
Entitylistbyguids — Microsoft Purview List entities by GUIDs
/v1/api/atlas/v2/entity/bulk
POST
Entitybulkcreateorupdate — Microsoft Purview Bulk create or update entities
/v1/api/atlas/v2/entity/bulk
DELETE
Entitybulkdelete — Microsoft Purview Bulk delete entities
/v1/api/atlas/v2/entity/bulk
POST
Entitymovetocollection — Microsoft Purview Move entities to collection
/v1/api/atlas/v2/entity/bulk/collection/{collectionid}
GET
Entitygetbyguid — Microsoft Purview Get entity by GUID
/v1/api/atlas/v2/entity/guid/{guid}
DELETE
Entitydelete — Microsoft Purview Delete an entity
/v1/api/atlas/v2/entity/guid/{guid}
POST
Entityaddorupdatebusinessmetadata — Microsoft Purview Add or update business metadata
/v1/api/atlas/v2/entity/guid/{guid}/businessmetadata
DELETE
Entityremovebusinessmetadata — Microsoft Purview Remove business metadata
/v1/api/atlas/v2/entity/guid/{guid}/businessmetadata
POST
Entityaddclassifications — Microsoft Purview Add classifications to entity
/v1/api/atlas/v2/entity/guid/{guid}/classifications
GET
Entitygetclassifications — Microsoft Purview List classifications for entity
/v1/api/atlas/v2/entity/guid/{guid}/classifications
GET
Entitygetheader — Microsoft Purview Get entity header
/v1/api/atlas/v2/entity/guid/{guid}/header
POST
Entityaddlabels — Microsoft Purview Add labels to entity
/v1/api/atlas/v2/entity/guid/{guid}/labels
PUT
Entitysetlabels — Microsoft Purview Set labels on entity
/v1/api/atlas/v2/entity/guid/{guid}/labels
DELETE
Entityremovelabels — Microsoft Purview Remove labels from entity
/v1/api/atlas/v2/entity/guid/{guid}/labels

MCP Tools

microsoft-purview-create-update-entity

Microsoft Purview Create or update an entity

microsoft-purview-list-entities-guids

Microsoft Purview List entities by GUIDs

read-only idempotent
microsoft-purview-bulk-create-update

Microsoft Purview Bulk create or update entities

microsoft-purview-bulk-delete-entities

Microsoft Purview Bulk delete entities

idempotent
microsoft-purview-move-entities-collection

Microsoft Purview Move entities to collection

microsoft-purview-get-entity-guid

Microsoft Purview Get entity by GUID

read-only idempotent
microsoft-purview-delete-entity

Microsoft Purview Delete an entity

idempotent
microsoft-purview-add-update-business

Microsoft Purview Add or update business metadata

microsoft-purview-remove-business-metadata

Microsoft Purview Remove business metadata

idempotent
microsoft-purview-add-classifications-entity

Microsoft Purview Add classifications to entity

microsoft-purview-list-classifications-entity

Microsoft Purview List classifications for entity

read-only idempotent
microsoft-purview-get-entity-header

Microsoft Purview Get entity header

read-only idempotent
microsoft-purview-add-labels-entity

Microsoft Purview Add labels to entity

microsoft-purview-set-labels-entity

Microsoft Purview Set labels on entity

idempotent
microsoft-purview-remove-labels-entity

Microsoft Purview Remove labels from entity

idempotent

Capability Spec

data-map-entity.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: Microsoft Purview Data Map API — Entity
  description: 'Microsoft Purview Data Map API — Entity. 15 operations. Lead operation: Microsoft Purview Create or update
    an entity. Self-contained Naftiko capability covering one Microsoft Purview business surface.'
  tags:
  - Microsoft Purview
  - Entity
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_PURVIEW_API_KEY: MICROSOFT_PURVIEW_API_KEY
capability:
  consumes:
  - type: http
    namespace: data-map-entity
    baseUri: https://{accountName}.purview.azure.com/datamap
    description: Microsoft Purview Data Map API — Entity business capability. Self-contained, no shared references.
    resources:
    - name: api-atlas-v2-entity
      path: /api/atlas/v2/entity
      operations:
      - name: entitycreateorupdate
        method: POST
        description: Microsoft Purview Create or update an entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-atlas-v2-entity-bulk
      path: /api/atlas/v2/entity/bulk
      operations:
      - name: entitylistbyguids
        method: GET
        description: Microsoft Purview List entities by GUIDs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: query
          type: array
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: minExtInfo
          in: query
          type: boolean
        - name: ignoreRelationships
          in: query
          type: boolean
      - name: entitybulkcreateorupdate
        method: POST
        description: Microsoft Purview Bulk create or update entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: entitybulkdelete
        method: DELETE
        description: Microsoft Purview Bulk delete entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: query
          type: array
          required: true
        - name: api-version
          in: query
          type: string
          required: true
    - name: api-atlas-v2-entity-bulk-collection-collectionId
      path: /api/atlas/v2/entity/bulk/collection/{collectionId}
      operations:
      - name: entitymovetocollection
        method: POST
        description: Microsoft Purview Move entities to collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collectionId
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-atlas-v2-entity-guid-guid
      path: /api/atlas/v2/entity/guid/{guid}
      operations:
      - name: entitygetbyguid
        method: GET
        description: Microsoft Purview Get entity by GUID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: minExtInfo
          in: query
          type: boolean
        - name: ignoreRelationships
          in: query
          type: boolean
      - name: entitydelete
        method: DELETE
        description: Microsoft Purview Delete an entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
    - name: api-atlas-v2-entity-guid-guid-businessmetadata
      path: /api/atlas/v2/entity/guid/{guid}/businessmetadata
      operations:
      - name: entityaddorupdatebusinessmetadata
        method: POST
        description: Microsoft Purview Add or update business metadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: isOverwrite
          in: query
          type: boolean
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: entityremovebusinessmetadata
        method: DELETE
        description: Microsoft Purview Remove business metadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-atlas-v2-entity-guid-guid-classifications
      path: /api/atlas/v2/entity/guid/{guid}/classifications
      operations:
      - name: entityaddclassifications
        method: POST
        description: Microsoft Purview Add classifications to entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: entitygetclassifications
        method: GET
        description: Microsoft Purview List classifications for entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
    - name: api-atlas-v2-entity-guid-guid-header
      path: /api/atlas/v2/entity/guid/{guid}/header
      operations:
      - name: entitygetheader
        method: GET
        description: Microsoft Purview Get entity header
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
    - name: api-atlas-v2-entity-guid-guid-labels
      path: /api/atlas/v2/entity/guid/{guid}/labels
      operations:
      - name: entityaddlabels
        method: POST
        description: Microsoft Purview Add labels to entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: entitysetlabels
        method: PUT
        description: Microsoft Purview Set labels on entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: entityremovelabels
        method: DELETE
        description: Microsoft Purview Remove labels from entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.MICROSOFT_PURVIEW_API_KEY}}'
  exposes:
  - type: rest
    namespace: data-map-entity-rest
    port: 8080
    description: REST adapter for Microsoft Purview Data Map API — Entity. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/atlas/v2/entity
      name: api-atlas-v2-entity
      description: REST surface for api-atlas-v2-entity.
      operations:
      - method: POST
        name: entitycreateorupdate
        description: Microsoft Purview Create or update an entity
        call: data-map-entity.entitycreateorupdate
        with:
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/entity/bulk
      name: api-atlas-v2-entity-bulk
      description: REST surface for api-atlas-v2-entity-bulk.
      operations:
      - method: GET
        name: entitylistbyguids
        description: Microsoft Purview List entities by GUIDs
        call: data-map-entity.entitylistbyguids
        with:
          guid: rest.guid
          api-version: rest.api-version
          minExtInfo: rest.minExtInfo
          ignoreRelationships: rest.ignoreRelationships
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: entitybulkcreateorupdate
        description: Microsoft Purview Bulk create or update entities
        call: data-map-entity.entitybulkcreateorupdate
        with:
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: entitybulkdelete
        description: Microsoft Purview Bulk delete entities
        call: data-map-entity.entitybulkdelete
        with:
          guid: rest.guid
          api-version: rest.api-version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/entity/bulk/collection/{collectionid}
      name: api-atlas-v2-entity-bulk-collection-collectionid
      description: REST surface for api-atlas-v2-entity-bulk-collection-collectionId.
      operations:
      - method: POST
        name: entitymovetocollection
        description: Microsoft Purview Move entities to collection
        call: data-map-entity.entitymovetocollection
        with:
          collectionId: rest.collectionId
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/entity/guid/{guid}
      name: api-atlas-v2-entity-guid-guid
      description: REST surface for api-atlas-v2-entity-guid-guid.
      operations:
      - method: GET
        name: entitygetbyguid
        description: Microsoft Purview Get entity by GUID
        call: data-map-entity.entitygetbyguid
        with:
          guid: rest.guid
          api-version: rest.api-version
          minExtInfo: rest.minExtInfo
          ignoreRelationships: rest.ignoreRelationships
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: entitydelete
        description: Microsoft Purview Delete an entity
        call: data-map-entity.entitydelete
        with:
          guid: rest.guid
          api-version: rest.api-version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/entity/guid/{guid}/businessmetadata
      name: api-atlas-v2-entity-guid-guid-businessmetadata
      description: REST surface for api-atlas-v2-entity-guid-guid-businessmetadata.
      operations:
      - method: POST
        name: entityaddorupdatebusinessmetadata
        description: Microsoft Purview Add or update business metadata
        call: data-map-entity.entityaddorupdatebusinessmetadata
        with:
          guid: rest.guid
          api-version: rest.api-version
          isOverwrite: rest.isOverwrite
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: entityremovebusinessmetadata
        description: Microsoft Purview Remove business metadata
        call: data-map-entity.entityremovebusinessmetadata
        with:
          guid: rest.guid
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/entity/guid/{guid}/classifications
      name: api-atlas-v2-entity-guid-guid-classifications
      description: REST surface for api-atlas-v2-entity-guid-guid-classifications.
      operations:
      - method: POST
        name: entityaddclassifications
        description: Microsoft Purview Add classifications to entity
        call: data-map-entity.entityaddclassifications
        with:
          guid: rest.guid
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: entitygetclassifications
        description: Microsoft Purview List classifications for entity
        call: data-map-entity.entitygetclassifications
        with:
          guid: rest.guid
          api-version: rest.api-version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/entity/guid/{guid}/header
      name: api-atlas-v2-entity-guid-guid-header
      description: REST surface for api-atlas-v2-entity-guid-guid-header.
      operations:
      - method: GET
        name: entitygetheader
        description: Microsoft Purview Get entity header
        call: data-map-entity.entitygetheader
        with:
          guid: rest.guid
          api-version: rest.api-version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/entity/guid/{guid}/labels
      name: api-atlas-v2-entity-guid-guid-labels
      description: REST surface for api-atlas-v2-entity-guid-guid-labels.
      operations:
      - method: POST
        name: entityaddlabels
        description: Microsoft Purview Add labels to entity
        call: data-map-entity.entityaddlabels
        with:
          guid: rest.guid
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: entitysetlabels
        description: Microsoft Purview Set labels on entity
        call: data-map-entity.entitysetlabels
        with:
          guid: rest.guid
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: entityremovelabels
        description: Microsoft Purview Remove labels from entity
        call: data-map-entity.entityremovelabels
        with:
          guid: rest.guid
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: data-map-entity-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Purview Data Map API — Entity. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: microsoft-purview-create-update-entity
      description: Microsoft Purview Create or update an entity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: data-map-entity.entitycreateorupdate
      with:
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-list-entities-guids
      description: Microsoft Purview List entities by GUIDs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: data-map-entity.entitylistbyguids
      with:
        guid: tools.guid
        api-version: tools.api-version
        minExtInfo: tools.minExtInfo
        ignoreRelationships: tools.ignoreRelationships
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-bulk-create-update
      description: Microsoft Purview Bulk create or update entities
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: data-map-entity.entitybulkcreateorupdate
      with:
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-bulk-delete-entities
      description: Microsoft Purview Bulk delete entities
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: data-map-entity.entitybulkdelete
      with:
        guid: tools.guid
        api-version: tools.api-version
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-move-entities-collection
      description: Microsoft Purview Move entities to collection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: data-map-entity.entitymovetocollection
      with:
        collectionId: tools.collectionId
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-get-entity-guid
      description: Microsoft Purview Get entity by GUID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: data-map-entity.entitygetbyguid
      with:
        guid: tools.guid
        api-version: tools.api-version
        minExtInfo: tools.minExtInfo
        ignoreRelationships: tools.ignoreRelationships
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-delete-entity
      description: Microsoft Purview Delete an entity
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: data-map-entity.entitydelete
      with:
        guid: tools.guid
        api-version: tools.api-version
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-add-update-business
      description: Microsoft Purview Add or update business metadata
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: data-map-entity.entityaddorupdatebusinessmetadata
      with:
        guid: tools.guid
        api-version: tools.api-version
        isOverwrite: tools.isOverwrite
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-remove-business-metadata
      description: Microsoft Purview Remove business metadata
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: data-map-entity.entityremovebusinessmetadata
      with:
        guid: tools.guid
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-add-classifications-entity
      description: Microsoft Purview Add classifications to entity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: data-map-entity.entityaddclassifications
      with:
        guid: tools.guid
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-list-classifications-entity
      description: Microsoft Purview List classifications for entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: data-map-entity.entitygetclassifications
      with:
        guid: tools.guid
        api-version: tools.api-version
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-get-entity-header
      description: Microsoft Purview Get entity header
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: data-map-entity.entitygetheader
      with:
        guid: tools.guid
        api-version: tools.api-version
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-add-labels-entity
      description: Microsoft Purview Add labels to entity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: data-map-entity.entityaddlabels
      with:
        guid: tools.guid
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-set-labels-entity
      description: Microsoft Purview Set labels on entity
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: data-map-entity.entitysetlabels
      with:
        guid: tools.guid
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-remove-labels-entity
      description: Microsoft Purview Remove labels from entity
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: data-map-entity.entityremovelabels
      with:
        guid: tools.guid
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.