Atlan API documentation

Delete asset by GUID

DELETE /api/meta/entity/guid/{guid}

Remove an asset (table, schema, etc) by its GUID. By default the asset will be soft-deleted (archived). Such assets can be recovered.

Path parameters

guid string(uuid) Required

Unique identifier of the entity to delete.

Query parameters

deleteType string

When SOFT (default), will soft-delete (archive) the asset. When HARD, will permanently remove the asset (cannot be recovered). Soft-deleted assets cannot be hard-deleted, they must first be restored to active.

Values are SOFT or HARD. Default value is SOFT.

Responses

• 200 object

Entity in its deleted state.

Note: if the entity has already been deleted, or does not exist, an empty body will be returned but still a 200 code.
- mutatedEntities object | null
  
  Assets that were deleted.
  DELETE array[object]
  
  Instance of an asset in Atlan, with its detailed information.
  
  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.
  
  Additional properties: string
  
  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.
  
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  displayName string | null
  
  Name used for display purposes (in user interfaces).
  
  description string | null
  
  Description of the asset, as crawled from a source.
  
  userDescription string | null
  
  Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.
  
  tenantId string
  
  Name of the Atlan workspace in which the table exists.
  
  certificateStatus string | null
  
  Status of the asset's certification.
  
  Values are VERIFIED, DRAFT, or DEPRECATED.
  
  certificateStatusMessage string | null
  
  Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.
  
  announcementTitle string | null
  
  Brief title for the announcement on this asset. Required when announcementType is specified.
  
  announcementMessage string | null
  
  Detailed message to include in the announcement on this asset.
  
  announcementType string | null
  
  Type of announcement on the asset.
  
  Values are information, warning, or issue.
  
  ownerUsers array[string] | null
  
  List of users who own the asset.
  
  ownerGroups array[string] | null
  
  List of groups who own the asset.
  
  adminUsers array[string] | null
  
  List of users who administer the asset. (This is only used for Connection assets?)
  
  adminGroups array[string] | null
  
  List of groups who administer the asset. (This is only used for Connection assets?)
  
  viewerUsers array[string] | null
  
  viewerGroups array[string] | null
  
  connectorName string | null
  
  Name of the connector through which this asset is accessible.
  
  connectionName string | null Deprecated
  
  Unused.
  
  connectionQualifiedName string | null
  
  Unique name of the connection through which this asset is accessible.
  
  isDiscoverable boolean
  
  isEditable boolean
  
  subType object | null
  
  viewScore number | null
  
  popularityScore number | null
  
  sourceOwners array[string] | null
  
  sourceURL string | null
  
  lastSyncWorkflowName string | null
  
  Name of the crawler that last synchronized this asset.
  
  lastSyncRunAt integer | null
  
  Time (epoch) at which the table was last crawled, in milliseconds.
  
  lastSyncRun string | null
  
  Name of the last run of the crawler that last synchronized this asset.
  
  certificateUpdatedBy string | null
  
  Name of the user who last updated the certificateStatus.
  
  certificateUpdatedAt integer | null
  
  Time (epoch) at which the certificateStatus was last updated, in milliseconds.
  
  announcementUpdatedAt integer | null
  
  Time (epoch) at which the announcement was last updated, in milliseconds.
  
  announcementUpdatedBy string | null
  
  User who last updated the announcement.
  
  sourceCreatedBy string | null
  
  sourceCreatedAt integer | null
  
  sourceUpdatedAt integer | null
  
  sourceUpdatedBy string | null
  
  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).
  
  typeName string
  
  Should always be Link.
  
  guid string | null
  
  Unique identifier of the related link. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related link. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related link. Note that this is a generated unique name which is not visible in the UI.
  
  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.
  
  qualifiedName string
  
  Unique name of the related readme.
  
  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.
  
  deleteHandler string
  
  Handler used for the deletion of the asset.
  
  Values are DEFAULT, SOFT, or HARD.

DELETE /api/meta/entity/guid/{guid}

curl \
 -X DELETE https://tenant.atlan.com/api/meta/entity/guid/c47d2400-0c21-4c0d-b9fb-1d53440a75ae \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response example (200)

{
  "mutatedEntities": {
    "DELETE": [
      {
        "typeName": "AtlasGlossaryTerm",
        "attributes": {
          "popularityScore": 1.17549435e-38,
          "viewerUsers": [],
          "sourceCreatedAt": 0,
          "lastSyncRunAt": 0,
          "certificateStatus": "VERIFIED",
          "userDescription": "The average amount spent in order to acquire a customer.",
          "adminRoles": [],
          "adminGroups": [],
          "qualifiedName": "u1qWdBZPF9vfEHXFcgEER@FzCMyPR2LxkPFgr8eNGrq",
          "adminUsers": [],
          "ownerGroups": [],
          "certificateUpdatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
          "isEditable": true,
          "sourceUpdatedAt": 0,
          "announcementUpdatedAt": 0,
          "name": "Customer Acquisition Cost",
          "certificateUpdatedAt": 1657039477745,
          "isDiscoverable": true,
          "viewerGroups": [],
          "ownerUsers": []
        },
        "guid": "c47d2400-0c21-4c0d-b9fb-1d53440a75ae",
        "status": "DELETED",
        "displayText": "Customer Acquisition Cost",
        "classificationNames": [
          "GeiqD5GfQoJ8oVzhspjQdo"
        ],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": [],
        "createdBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "updatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "createTime": 1657039477745,
        "updateTime": 1657039571112,
        "deleteHandler": "DEFAULT"
      }
    ]
  }
}