Get asset by GUID

GET /api/meta/entity/guid/{guid}

Retrieve details of an asset (table, schema, etc) by its GUID. By default the full details of the asset are returned, including: attributes, relationships, and classifications.

Path parameters

  • guid string(uuid) Required

    Unique identifier of the entity to retrieve.

Query parameters

  • ignoreRelationships boolean

    When true, will not retrieve details about the asset's relationships.

  • minExtInfo boolean

    When true, will minimize the extra details retrieved about an asset.

Responses

  • • 200 object

    Entity in its current state.

    • entity object

      Instance of an entity in Atlan, with its detailed information.

      • typeName string

        Name of the type definition that defines this instance.

      • attributes object | null

        Will be further documented in sub-types of EntityHeader.

      • classifications array[object] | null

        Instance of a classification in Atlan, with its detailed information.

        • typeName string

          Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.

        • entityGuid string

          Unique identifier of the entity to which this classification is attached.

        • propagate boolean | null

          Whether to propagate this classification to other entities related to the entity to which the classification is attached.

        • removePropagationsOnEntityDelete boolean | null

          Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.

        • entityStatus string | null

          Status of the entity to which this classification is attached.

          Values are ACTIVE or DELETED.

      • displayText string | null

        Human-readable name of the entity.

      • guid string

        Unique identifier of the entity instance.

      • isIncomplete boolean | null

        Default value is false.

      • businessAttributes object | null

        Map of custom metadata attributes and values defined on the entity.

      • relationshipAttributes object

        Map of relationships for the entity. The specific keys of this map will vary by type, so are described in the sub-types of this schema.

      • 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.

      • classificationNames array[string] | null

        List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.

      • labels array[string] | null

        Internal use only.

      • status string

        Status of the entity, either ACTIVE or DELETED.

        Values are ACTIVE or DELETED.

      • customAttributes object | null

        Internal use only.

      • pendingTasks array[string] | null

        Internal use only.

    • referredEntities object

      Map of related entities keyed by the GUID of the related entity. The values will be the detailed entity object of the related entity.

    • typeName string

      Name of the type definition that defines this instance.

    • attributes object | null

      Attributes that can exist across all assets in Atlan.

    • classifications array[object] | null

      Instance of a classification in Atlan.

      • typeName string

        Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.

      • entityGuid string

        Unique identifier of the entity to which this classification is attached.

      • propagate boolean | null

        Whether to propagate this classification to other entities related to the entity to which the classification is attached.

      • removePropagationsOnEntityDelete boolean | null

        Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.

    • displayText string | null

      Human-readable name of the entity.

    • guid string

      Unique identifier of the entity instance.

    • isIncomplete boolean | null

      Default value is false.

    • businessAttributes object | null

      Map of custom metadata attributes and values defined on the entity.

    • relationshipAttributes object | null

      Map of the relationships to this asset.

      • links array[object]

        Details to use within an asset when referring to a link (resource).

      • readme object

        Details to use within an asset when referring to a readme.

        • typeName string

          Should always be Readme.

        • guid string | null

          Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.

        • uniqueAttributes object | null

          Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.

      • meanings array[object]

        Details to use within an asset when referring to a term.

        • typeName string

          Should always be AtlasnGlossaryTerm.

        • guid string | null

          Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.

        • uniqueAttributes object | null

          Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.

          • qualifiedName string

            Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

  • • 404 object

    Entity does not exist, or is deleted.

    • errorCode string

      Unique code for the type of error that occurred.

    • errorMessage string

      Human-readable description of the error that occurred.

GET /api/meta/entity/guid/{guid} 
curl \
 -X GET https://tenant.atlan.com/api/meta/entity/guid/75403887-4241-45ab-8e0e-1508e61d75e4 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200) 
{
  "referredEntities": {},
  "entity": {
    "typeName": "Column",
    "attributes": {
      "popularityScore": 1.17549435e-38,
      "lastSyncRunAt": 1646904481260,
      "databaseName": "ATLAN_SAMPLE_DATA",
      "defaultValue": null,
      "precision": 0,
      "__hasLineage": null,
      "lastSyncRun": "atlan-snowflake-default-snowflake-1646904424-ghj5h",
      "queryCountUpdatedAt": 0,
      "schemaName": "FOOD_BEVERAGE",
      "adminUsers": [],
      "tableName": "INSTACART_BEVERAGES_ORDER_CUSTOMER",
      "sourceURL": null,
      "queryUserCount": 0,
      "view": null,
      "isEditable": true,
      "sourceUpdatedAt": 0,
      "viewName": null,
      "isPartition": false,
      "announcementUpdatedAt": 0,
      "announcementTitle": null,
      "subDataType": null,
      "links": [],
      "validations": null,
      "order": 3,
      "certificateStatusMessage": null,
      "sourceCreatedAt": 0,
      "isIndexed": false,
      "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_BEVERAGES_ORDER_CUSTOMER/user_id",
      "dataType": "NUMBER",
      "pinnedBy": null,
      "isClustered": false,
      "isNullable": true,
      "name": "user_id",
      "certificateUpdatedAt": 0,
      "connectorName": "snowflake",
      "subType": null,
      "announcementUpdatedBy": null,
      "connectionName": null,
      "numericScale": 0,
      "maxLength": 0,
      "ownerUsers": [],
      "lastSyncWorkflowName": "dev-crawler",
      "isSort": false,
      "certificateStatus": null,
      "connectionQualifiedName": "default/snowflake/1646904424",
      "sourceCreatedBy": null,
      "replicatedFrom": null,
      "displayName": null,
      "isForeign": false,
      "description": "The unique ID for each customer",
      "queryCount": 0,
      "pinnedAt": 0,
      "isDist": false,
      "ownerGroups": [],
      "certificateUpdatedBy": null,
      "isPrimary": false,
      "isDiscoverable": true,
      "announcementType": null,
      "table": {
        "guid": "85d141c2-d383-4b4f-93a5-c3eed20988b9",
        "typeName": "Table"
      },
      "schemaQualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE",
      "viewerUsers": [],
      "viewScore": 1.17549435e-38,
      "sourceOwners": null,
      "materialisedView": null,
      "replicatedTo": null,
      "userDescription": null,
      "adminGroups": [],
      "isPinned": false,
      "databaseQualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA",
      "viewQualifiedName": null,
      "readme": null,
      "queryUserMap": null,
      "queries": [],
      "sourceUpdatedBy": null,
      "tenantId": "default",
      "tableQualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_BEVERAGES_ORDER_CUSTOMER",
      "partitionOrder": 0,
      "tablePartition": null,
      "announcementMessage": null,
      "viewerGroups": []
    },
    "guid": "75403887-4241-45ab-8e0e-1508e61d75e4",
    "isIncomplete": false,
    "status": "ACTIVE",
    "createdBy": "service-account-apikey-9471cf12-f45c-4275-b280-3e01d26f57e8",
    "updatedBy": "admin",
    "createTime": 1646904631984,
    "updateTime": 1651675109912,
    "version": 0,
    "relationshipAttributes": {
      "inputToProcesses": [],
      "view": null,
      "materialisedView": null,
      "tablePartition": null,
      "links": [],
      "readme": null,
      "queries": [],
      "meanings": [],
      "table": {
        "guid": "85d141c2-d383-4b4f-93a5-c3eed20988b9",
        "typeName": "Table",
        "entityStatus": "ACTIVE",
        "displayText": "INSTACART_BEVERAGES_ORDER_CUSTOMER",
        "relationshipType": "table_columns",
        "relationshipGuid": "080815af-5dc6-49b4-a5ec-4523096f1bae",
        "relationshipStatus": "ACTIVE",
        "relationshipAttributes": {
          "typeName": "table_columns"
        },
        "outputFromProcesses": []
      }
    },
    "classifications": [
      {
        "typeName": "J5q2QzErHG4unHTA0C5GE0",
        "entityGuid": "af6a32d4-936b-4a59-9917-7082c56ba443",
        "entityStatus": "ACTIVE",
        "propagate": true,
        "removePropagationsOnEntityDelete": true
      }
    ],
    "customAttributes": {
      "character_octet_length": "",
      "is_auto_increment": "NO",
      "is_generated": "NO",
      "extra_info": "",
      "buffer_length": "",
      "column_size": "38",
      "is_self_referencing": "NO"
    },
    "labels": []
  }
}
Response example (404) 
{
  "errorCode": "ATLAS-404-00-005",
  "errorMessage": "Given instance guid abc123 is invalid/not found\n"
}