Add a readme
POST
/api/meta/entity/bulk#addReadme
Attach a readme to an asset.
Note that the creation of a readme relies on no match being found for the provided qualifiedName
s. If the qualifiedName
s do match any existing readme, that readme will instead be updated rather than a new one being created. Also be aware that the qualifiedName
is case-sensitive.
For more details on the semantics and other attributes available through this interface, see the Upsert entities operation.
POST /api/meta/entity/bulk#addReadme
curl \
-X POST https://tenant.atlan.com/api/meta/entity/bulk#addReadme \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"entities":[{"typeName":"Readme","attributes":{"name":"user_id Readme","qualifiedName":"2e5b4bdb-592d-4964-afbe-021214b0cc9f/readme\n","description":"%3Ch2%3EID%3C%2Fh2%3E%3Cp%3EUnique%20identifier%20of%20a%20customer.%3C%2Fp%3E"},"relationshipAttributes":{"asset":{"typeName":"Column","guid":"2e5b4bdb-592d-4964-afbe-021214b0cc9f"}}},{"typeName":"Readme","attributes":{"name":"INSTACART_TOP_USERS Readme","qualifiedName":"c1ef6535-4c9d-4946-83a3-9f70d7a98e47/readme","description":"%3Ch2%3EOverview%3C%2Fh2%3E%3Cp%3ETop%20users%20of%20our%20website.%3C%2Fp%3E"},"relationshipAttributes":{"asset":{"typeName":"Table","guid":"d45fb048-0461-44ec-9cc7-eaf7a438c8df"}}}]}'
Request example
{
"entities": [
{
"typeName": "Readme",
"attributes": {
"name": "user_id Readme",
"qualifiedName": "2e5b4bdb-592d-4964-afbe-021214b0cc9f/readme\n",
"description": "%3Ch2%3EID%3C%2Fh2%3E%3Cp%3EUnique%20identifier%20of%20a%20customer.%3C%2Fp%3E"
},
"relationshipAttributes": {
"asset": {
"typeName": "Column",
"guid": "2e5b4bdb-592d-4964-afbe-021214b0cc9f"
}
}
},
{
"typeName": "Readme",
"attributes": {
"name": "INSTACART_TOP_USERS Readme",
"qualifiedName": "c1ef6535-4c9d-4946-83a3-9f70d7a98e47/readme",
"description": "%3Ch2%3EOverview%3C%2Fh2%3E%3Cp%3ETop%20users%20of%20our%20website.%3C%2Fp%3E"
},
"relationshipAttributes": {
"asset": {
"typeName": "Table",
"guid": "d45fb048-0461-44ec-9cc7-eaf7a438c8df"
}
}
}
]
}
Response example (200)
{
"mutatedEntities": {
"CREATE": [
{
"typeName": "Readme",
"attributes": {
"popularityScore": 1.17549435e-38,
"viewerUsers": [],
"sourceCreatedAt": 0,
"viewScore": 1.17549435e-38,
"lastSyncRunAt": 0,
"adminRoles": [],
"adminGroups": [],
"qualifiedName": "2e5b4bdb-592d-4964-afbe-021214b0cc9f/readme",
"__hasLineage": false,
"description": "%3Ch2%3EID%3C%2Fh2%3E%3Cp%3EUnique%20identifier%20of%20a%20customer.%3C%2Fp%3E\n",
"adminUsers": [],
"ownerGroups": [],
"isEditable": true,
"sourceUpdatedAt": 0,
"announcementUpdatedAt": 0,
"name": "user_id Readme",
"certificateUpdatedAt": 0,
"isGlobal": false,
"isDiscoverable": true,
"viewerGroups": [],
"ownerUsers": []
},
"guid": "2992ae78-c480-48b9-b61a-67cce210e3d7",
"status": "ACTIVE",
"displayText": "user_id Readme",
"classificationNames": [],
"classifications": [],
"meaningNames": [],
"meanings": [],
"isIncomplete": false,
"labels": [],
"createdBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
"updatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
"createTime": 1655460145909,
"updateTime": 1655460145909
},
{
"typeName": "Readme",
"attributes": {
"popularityScore": 1.17549435e-38,
"viewerUsers": [],
"sourceCreatedAt": 0,
"viewScore": 1.17549435e-38,
"lastSyncRunAt": 0,
"adminRoles": [],
"adminGroups": [],
"qualifiedName": "c1ef6535-4c9d-4946-83a3-9f70d7a98e47/readme",
"__hasLineage": false,
"description": "%3Ch2%3EOverview%3C%2Fh2%3E%3Cp%3ETop%20users%20of%20our%20website.%3C%2Fp%3E\n",
"adminUsers": [],
"ownerGroups": [],
"isEditable": true,
"sourceUpdatedAt": 0,
"announcementUpdatedAt": 0,
"name": "INSTACART_TOP_USERS Readme",
"certificateUpdatedAt": 0,
"isGlobal": false,
"isDiscoverable": true,
"viewerGroups": [],
"ownerUsers": []
},
"guid": "f25aec9b-790f-4760-b66c-997eee2fe613",
"status": "ACTIVE",
"displayText": "INSTACART_TOP_USERS Readme",
"classificationNames": [],
"classifications": [],
"meaningNames": [],
"meanings": [],
"isIncomplete": false,
"labels": [],
"createdBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
"updatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
"createTime": 1655460145909,
"updateTime": 1655460145909
}
],
"UPDATE": [
{
"typeName": "Column",
"attributes": {
"qualifiedName": "default/snowflake/1655116256/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_TOP_USERS/user_id",
"name": "user_id",
"description": "Unique identifier of the user"
},
"guid": "2e5b4bdb-592d-4964-afbe-021214b0cc9f",
"status": "ACTIVE",
"displayText": "user_id",
"classificationNames": [],
"meaningNames": [],
"meanings": [],
"isIncomplete": false,
"labels": [],
"createdBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
"updatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
"createTime": 1655116523261,
"updateTime": 1655460145909
},
{
"typeName": "Table",
"attributes": {
"qualifiedName\"": "default/snowflake/1655116256/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_TOP_USERS",
"name\"": "INSTACART_TOP_USERS",
"description\"": "Top users across categories"
},
"guid": "c1ef6535-4c9d-4946-83a3-9f70d7a98e47",
"status": "ACTIVE",
"displayText": "INSTACART_TOP_USERS",
"classificationNames": [],
"meaningNames": [],
"meanings": [],
"isIncomplete": false,
"labels": [],
"createdBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
"updatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
"createTime": 1655116491284,
"updateTime": 1655460145909
}
],
"guidAssignments": {
"-786722728348341": "2992ae78-c480-48b9-b61a-67cce210e3d7",
"-786722728348342": "f25aec9b-790f-4760-b66c-997eee2fe613"
}
}
}