Restore columns
POST
/api/meta/entity/bulk#restoreColumns
Restore one or more soft-deleted (archived) columns.
The restoration relies on matches being found for the provided qualifiedName
s. If the this does not exactly match (case-sensitive) a soft-deleted column's qualifiedName
, the request will fail.
Note that the guid
is also required to avoid accidentally creating a new column. If the qualifiedName
does not match an existing column, and no guid
is supplied in the request, then this endpoint will create a new column with the provided details.
POST /api/meta/entity/bulk#restoreColumns
curl \
-X POST https://tenant.atlan.com/api/meta/entity/bulk#restoreColumns \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"entities":[{"typeName":"Column","attributes":{"name":"id","qualifiedName":"default/mongodb/mongodb.atlan.com/test_db/default/customer/id","connectorName":"mongodb","tableName":"customer","tableQualifiedName":"default/mongodb/mongodb.atlan.com/test_db/default/customer","schemaName":"default","schemaQualifiedName":"default/mongodb/mongodb.atlan.com/test_db/default","databaseName":"test_db","databaseQualifiedName":"default/mongodb/mongodb.atlan.com/test_db","connectionQualifiedName":"default/mongodb/mongodb.atlan.com"},"relationshipAttributes":{"table":{"typeName":"Table","uniqueAttributes":{"qualifiedName":"default/mongodb/mongodb.atlan.com/test_db/default/customer"}}},"guid":"dc14ffca-bf43-4731-b641-51408c4d892c","status":"ACTIVE"},{"typeName":"Column","attributes":{"name":"name","qualifiedName":"default/mongodb/mongodb.atlan.com/test_db/default/customer_view/name","connectorName":"mongodb","viewName":"customer_view","viewQualifiedName":"default/mongodb/mongodb.atlan.com/test_db/default/customer_view","schemaName":"default","schemaQualifiedName":"default/mongodb/mongodb.atlan.com/test_db/default","databaseName":"test_db","databaseQualifiedName":"default/mongodb/mongodb.atlan.com/test_db","connectionQualifiedName":"default/mongodb/mongodb.atlan.com"},"relationshipAttributes":{"view":{"typeName":"View","uniqueAttributes":{"qualifiedName":"default/mongodb/mongodb.atlan.com/test_db/default/customer_view"}}},"guid":"cde58784-792d-42d4-a1b7-70428b708406","status":"ACTIVE"}]}'
Request example
{
"entities": [
{
"typeName": "Column",
"attributes": {
"name": "id",
"qualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default/customer/id",
"connectorName": "mongodb",
"tableName": "customer",
"tableQualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default/customer",
"schemaName": "default",
"schemaQualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default",
"databaseName": "test_db",
"databaseQualifiedName": "default/mongodb/mongodb.atlan.com/test_db",
"connectionQualifiedName": "default/mongodb/mongodb.atlan.com"
},
"relationshipAttributes": {
"table": {
"typeName": "Table",
"uniqueAttributes": {
"qualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default/customer"
}
}
},
"guid": "dc14ffca-bf43-4731-b641-51408c4d892c",
"status": "ACTIVE"
},
{
"typeName": "Column",
"attributes": {
"name": "name",
"qualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default/customer_view/name",
"connectorName": "mongodb",
"viewName": "customer_view",
"viewQualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default/customer_view",
"schemaName": "default",
"schemaQualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default",
"databaseName": "test_db",
"databaseQualifiedName": "default/mongodb/mongodb.atlan.com/test_db",
"connectionQualifiedName": "default/mongodb/mongodb.atlan.com"
},
"relationshipAttributes": {
"view": {
"typeName": "View",
"uniqueAttributes": {
"qualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default/customer_view"
}
}
},
"guid": "cde58784-792d-42d4-a1b7-70428b708406",
"status": "ACTIVE"
}
]
}
Response example (200)
{
"mutatedEntities": {
"UPDATE": [
{
"typeName": "Column",
"attributes": {
"popularityScore": 1.17549435e-38,
"sourceCreatedAt": 0,
"viewerUsers": [],
"viewScore": 1.17549435e-38,
"lastSyncRunAt": 0,
"adminGroups": [],
"qualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default/customer/id",
"__hasLineage": false,
"adminUsers": [],
"ownerGroups\"": [],
"isEditable": true,
"sourceUpdatedAt": 0,
"announcementUpdatedAt": 0,
"name": "id",
"certificateUpdatedAt": 0,
"connectorName": "mongodb",
"tableName": "customer",
"tableQualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default/customer",
"schemaName": "default",
"schemaQualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default",
"databaseName": "test_db",
"databaseQualifiedName": "default/mongodb/mongodb.atlan.com/test_db",
"connectionQualifiedName": "default/mongodb/mongodb.atlan.com",
"isDiscoverable": true,
"viewerGroups": [],
"ownerUsers": []
},
"guid": "dc14ffca-bf43-4731-b641-51408c4d892c",
"status": "ACTIVE",
"displayText": "default",
"classificationNames": [],
"classifications": [],
"meaningNames": [],
"meanings": [],
"isIncomplete": false,
"labels": [],
"createdBy": "service-account-apikey-bea1e1d1-e4e7-465e-8adf-7c61c227a59b",
"updatedBy": "service-account-apikey-bea1e1d1-e4e7-465e-8adf-7c61c227a59b",
"createTime": 1652795647900,
"updateTime": 1652795647900
},
{
"typeName": "Column",
"attributes": {
"popularityScore": 1.17549435e-38,
"sourceCreatedAt": 0,
"viewerUsers": [],
"viewScore": 1.17549435e-38,
"lastSyncRunAt": 0,
"adminGroups": [],
"qualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default/customer_view/name",
"__hasLineage": false,
"adminUsers": [],
"ownerGroups\"": [],
"isEditable": true,
"sourceUpdatedAt": 0,
"announcementUpdatedAt": 0,
"name": "name",
"certificateUpdatedAt": 0,
"connectorName": "mongodb",
"viewName": "customer_view",
"viewQualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default/customer_view",
"schemaName": "default",
"schemaQualifiedName": "default/mongodb/mongodb.atlan.com/test_db/default",
"databaseName": "test_db",
"databaseQualifiedName": "default/mongodb/mongodb.atlan.com/test_db",
"connectionQualifiedName": "default/mongodb/mongodb.atlan.com",
"isDiscoverable": true,
"viewerGroups": [],
"ownerUsers": []
},
"guid": "cde58784-792d-42d4-a1b7-70428b708406",
"status": "ACTIVE",
"displayText": "default",
"classificationNames": [],
"classifications": [],
"meaningNames": [],
"meanings": [],
"isIncomplete": false,
"labels": [],
"createdBy": "service-account-apikey-bea1e1d1-e4e7-465e-8adf-7c61c227a59b",
"updatedBy": "service-account-apikey-bea1e1d1-e4e7-465e-8adf-7c61c227a59b",
"createTime": 1652795647900,
"updateTime": 1652795647900
}
]
},
"guidAssignments": {}
}
Response example (404)
{
"errorCode": "ATLAS-404-00-00A",
"errorMessage": "Referenced entity cde58784-792d-42d4-a1b7-70428b708406 is not found",
"entityGuid": "cde58784-792d-42d4-a1b7-70428b708406"
}