List classification definitions

GET /api/meta/types/typedefs#classifications

List all classifications defined in the environment.

Query parameters

  • type string(token) Required

    The type of type definitions you'd like to retrieve.

    Value is classification.

Responses

  • • 200 object

    List of the requested type definitions. The classification definitions will be in the classificationDefs array of the response.

    • classificationDefs array[object]

      Maintenance details that apply to almost all objects.

      • category string | null

        Should always be CLASSIFICATION.

      • guid string | null

        Unique identifier that represents the type definition.

      • name string

        Static-hashed unique name of the classification type. This is used internally for representing the classification type, and allows the human-readable name to be changed without impacting any existing metadata. This hashed unique name must currently be used for the generic bulk entity update API endpoint.

      • description string | null

        Description of the type definition.

      • typeVersion string | null

        Internal use only.

      • options object | null

        Additional options that can be set on the type definition.

        • color string

          Color for a classification.

          Values are Red, Yellow, or Green.

      • serviceType string | null

        Internal use only.

      • displayName string

        Human-readable name of the classification type. This is used in the UI and for creation, and on a specific API endpoint for updates.

      • attributeDefs array[object] | null Deprecated

        Unused.

        Default value is [] (empty).

      • entityTypes array[string]

        A list of the entity types that this classification can be used against. (This should be Asset to allow classification of any asset in Atlan.)

      • superTypes array[string]

        List of the super-types that this type definition should extend. (This is intended for internal use only, and should not be used without specific guidance.)

        Default value is [] (empty).

      • subTypes array[string]

        List of the sub-types that extend from this type definition. Generally this is not specified in any request, but is only supplied in responses. (This is intended for internal use only, and should not be used without specific guidance.)

        Default value is [] (empty).

      • createdBy string | null

        Username of the user who created the object.

      • updatedBy string | null

        Username of the user who last updated the object.

      • createTime integer | null

        Time (epoch) at which this object was created, in milliseconds.

      • updateTime integer | null

        Time (epoch) at which this object was last updated, in milliseconds.

      • version integer | null

        Version of this object.

    • enumDefs array[object] | null

      Enumeration (options) types (empty).

    • structDefs array[object] | null

      Structured types (empty).

    • entityDefs array[object] | null

      Entity types (empty).

    • relationshipDefs array[object] | null

      Relationship types (empty).

    • businessMetadataDefs array[object] | null

      Custom metadata types (empty).

GET /api/meta/types/typedefs#classifications 
curl \
 -X GET https://tenant.atlan.com/api/meta/types/typedefs#classifications?type=classification \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200) 
{
  "classificationDefs": [
    {
      "category": "CLASSIFICATION",
      "guid": "917ffec9-fa84-4c59-8e6c-c7b114d04be3",
      "name": "jiCHJUpgaGSNPVlb6qFKem",
      "description": "Information that can be used to identify a natural person, directly or indirectly.",
      "typeVersion": "1.0",
      "options": {
        "color": "Yellow"
      },
      "serviceType": "atlan",
      "displayName": "PII",
      "attributeDefs": [],
      "entityTypes": [
        "Asset"
      ],
      "superTypes": [],
      "subTypes": [],
      "createdBy": "jsmith",
      "updatedBy": "jsmith",
      "createTime": 1648852296555,
      "updateTime": 1649172284333,
      "version": 2
    }
  ],
  "enumDefs": [
    {}
  ],
  "structDefs": [
    {}
  ],
  "entityDefs": [
    {}
  ],
  "relationshipDefs": [
    {}
  ],
  "businessMetadataDefs": [
    {}
  ]
}