Entity - Get Classifications

List classifications for a given entity represented by a GUID.

GET {endpoint}/datamap/api/atlas/v2/entity/guid/{guid}/classifications

URI Parameters

Name In Required Type Description
endpoint
path True

string

guid
path True

string

The globally unique identifier of the entity.

Responses

Name Type Description
200 OK

AtlasClassifications

The request has succeeded.

Other Status Codes

AtlasErrorResponse

An unexpected error response.

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://purview.azure.net/.default

Examples

Entity_GetClassifications

Sample request

GET {endpoint}/datamap/api/atlas/v2/entity/guid/67d26de6-771d-1a2d-cb2b-dec4dbd2a9bd/classifications

Sample response

{
  "list": [
    {
      "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER",
      "entityGuid": "67d26de6-771d-1a2d-cb2b-dec4dbd2a9bd"
    }
  ],
  "startIndex": 0,
  "pageSize": 1,
  "totalCount": 1,
  "sortType": "NONE"
}

Definitions

Name Description
AtlasClassifications

REST serialization friendly list.

AtlasErrorResponse

An error response from the service

SortType

Type for sorting

AtlasClassifications

REST serialization friendly list.

Name Type Description
list

List[]

An array of objects.

pageSize

integer

The size of the page.

sortBy

string

The sorted by field.

sortType

SortType

to specify whether the result should be sorted? If yes, whether asc or desc.

startIndex

integer

The start index of the page.

totalCount

integer

The total count of items.

AtlasErrorResponse

An error response from the service

Name Type Description
errorCode

string

The error code.

errorMessage

string

The error message.

requestId

string

The request ID.

SortType

Type for sorting

Name Type Description
ASC

string

Use ascending order for sorting

DESC

string

Use descending order for sorting

NONE

string

No sorting order