question Re: How to perfrom update (REST API - PUT) operation of apache atlas entity in Support Questions

How to perfrom update (REST API - PUT) operation of apache atlas entity

bigdatacm — Tue, 06 Aug 2024 13:26:36 GMT

IHi All,

I am getting one issue while updating my existing entity using PUT calls.

I have downloaded json by using GET and i just trying to update my entity (i have tried updating description also tried not updating anything and PUT as it is ) using PUT operation and its failing with same reason -

"errorCode":"ATLAS-400-00-023","errorMessage":"Attribute null not found for type hive_table"

could you please advise how did you update the entity using PUT command ?

curl --negotiate -u : -X PUT -H "Content-Type: application/json" https://myURL:portNumber/api/atlas/v2/entity/guid/<myGuid>-d @downloaded_entity.json

i have referred this post , however its not showing how to perform PUT operation. Solved: Re: PARTIAL UPDATE APACHE ATLAS ENTITY GUI - Cloudera Community - 297845

so my question is - Does atals REST PAI allows updating entity ? my usecase is i want to update an hive table entity. I have hive table hive column relationship in place. now i want to update my hive-table entity by adding hive columns under attributes: { columns [...]}

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

DianaTorres — Tue, 06 Aug 2024 16:31:27 GMT

@bigdatacm Welcome to the Cloudera Community!

To help you get the best possible solution, I have tagged our Atlas experts @cravani @pvishnu who may be able to assist you further.

Please keep us updated on your post, and we hope you find a satisfactory solution to your query.

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

bigdatacm — Wed, 07 Aug 2024 08:04:59 GMT

thank you @DianaTorres . I will wait for their response

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

bigdatacm — Fri, 16 Aug 2024 16:09:33 GMT

@cravani @pvishnu - could you please advise here ?

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

DianaTorres — Fri, 16 Aug 2024 19:45:11 GMT

@Scharan @mayank_gupta Hi! Do you have any insights here? Thanks

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

mayank_gupta — Fri, 16 Aug 2024 20:38:51 GMT

Hello, yes Atlas API allows updating the entity https://atlas.apache.org/api/v2/resource_EntityREST.html

Further as per the error shared, looks like some missing attributes in the updated JSON that you are trying to push, verify it once or if possible attach it here for a quick review.

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

jhoney12 — Sat, 17 Aug 2024 10:26:56 GMT

I'm facing an issue while performing a PUT operation to update an Apache Atlas entity. I'm getting the error: "errorCode":"ATLAS-400-00-023","errorMessage":"Attribute null not found for type hive_table", despite trying different update approaches. Could someone advise on how to correctly update an entity using the PUT command, or confirm if Atlas REST API supports entity updates?

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

bigdatacm — Tue, 20 Aug 2024 10:10:06 GMT

I just downloaded same entity json and just added 'dummy description' under description of entity and tried with same PUT command and I got same error.

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

bigdatacm — Tue, 20 Aug 2024 13:25:33 GMT

I just downloaded same entity json and just added 'dummy description' under description of entity and tried with same PUT command and I got same error.

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

bigdatacm — Wed, 21 Aug 2024 19:12:07 GMT

@mayank_gupta - thanks

attaching my json file and CURL command i tried below.

curl --negotiate -u : -X PUT -H "Content-Type: application/json" https://URL/api/atlas/v2/entity/guid/7g5678h9-4003-407a-ac00-791c7c53e6d5 -d @test_oracle_tbl.json

error I am getting -
{"errorCode":"ATLAS-400-00-023","errorMessage":"Attribute null not found for type oracle_table_test"}

my json :

{
"referredEntities": {
"a4ff269b-566f-40f6-b7a3-8e0678c100fa": {
"typeName": "oracle_column",
"attributes": {
"owner": null,
"replicatedTo": null,
"userDescription": null,
"replicatedFrom": null,
"qualifiedName": "sales@oracle_column_fc_opo_test",
"displayName": null,
"dataType": "double",
"name": "sales",
"description": null,
"comment": "Sales",
"position": 0,
"table": {
"guid": "7g5678h9-4003-407a-ac00-791c7c53e6d5",
"typeName": "oracle_table_test"
}
},
"guid": "a4ff269b-566f-40f6-b7a3-8e0678c100fa",
"isIncomplete": false,
"status": "ACTIVE",
"createdBy": "ownerTest",
"updatedBy": "ownerTest",
"createTime": 1722463451536,
"updateTime": 1722463451536,
"version": 0,
"relationshipAttributes": {
"inputToProcesses": [],
"pipeline": null,
"schema": [],
"model": null,
"meanings": [],
"table": {
"guid": "7g5678h9-4003-407a-ac00-791c7c53e6d5",
"typeName": "oracle_table_test",
"entityStatus": "ACTIVE",
"displayText": "fc_opo_test",
"relationshipType": "oracle_table_test_columns",
"relationshipGuid": "4581a28b-73fb-4743-9069-649ff1812a80",
"relationshipStatus": "ACTIVE",
"relationshipAttributes": {
"typeName": "oracle_table_test_columns"
}
},
"outputFromProcesses": []
},
"labels": []
}
},
"entity": {
"typeName": "oracle_table_test",
"attributes": {
"owner": "ownerTest",
"temporary": false,
"lastAccessTime": 0,
"aliases": null,
"replicatedTo": null,
"userDescription": null,
"replicatedFrom": null,
"qualifiedName": "fc_opo_test@oracle_table_test",
"displayName": null,
"columns": [
{
"guid": "a4ff269b-566f-40f6-b7a3-8e0678c100fa",
"typeName": "oracle_column"
}
],
"description": "fc_opo_test oracle Table Test",
"viewExpandedText": null,
"tableType": null,
"rewriteEnable": null,
"createTime": 0,
"name": "fc_opo_test",
"comment": null,
"parameters": null,
"retention": 0,
"viewOriginalText": null,
"db": null
},
"guid": "7g5678h9-4003-407a-ac00-791c7c53e6d5",
"isIncomplete": false,
"status": "ACTIVE",
"createdBy": "ownerTest",
"updatedBy": "ownerTest",
"createTime": 1722463451536,
"updateTime": 1722463451536,
"version": 0,
"relationshipAttributes": {
"inputToProcesses": [],
"pipeline": null,
"schema": [],
"columns": [
{
"guid": "a4ff269b-566f-40f6-b7a3-8e0678c100fa",
"typeName": "oracle_column",
"entityStatus": "ACTIVE",
"displayText": "sales",
"relationshipType": "oracle_table_test_columns",
"relationshipGuid": "b63f4847-14ef-4e70-a384-8fa40e422b39",
"relationshipStatus": "ACTIVE",
"relationshipAttributes": {
"typeName": "oracle_table_test_columns"
}
}
],
"model": null,
"meanings": [],
"db": null,
"outputFromProcesses": []
},
"labels": []
}
}

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

vats — Wed, 21 Aug 2024 20:38:13 GMT

@jhoney12 yes Atlas Rest API supports , but you need to download the JSON for the entity first.

i.e

curl " https://URL/api/atlas/v2/entity/guid/7g5678h9-4003-407a-ac00-791c7c53e6d5" \ -i -X GET --negotiate \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -u username:password >> test_oracle_tbl.json -k

and then modify the test_oracle_tbl.json and make a partial update to the entity

curl "https://hostname:port/api/atlas/v2/entity/uniqueAttribute/type/datsetname?attr:qualifiedName=name" -i -X GET --negotiate \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -u username:password -d@test_oracle_tbl.json -k

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

vats — Wed, 21 Aug 2024 20:40:25 GMT

@jhoney12 https://atlas.apache.org/api/v2/resource_EntityREST.html#resource_EntityREST_partialUpdateEntityAttrByGuid_PUT

Note-Entity Partial Update - Add/Update entity attribute identified by its GUID. Supports only uprimitive attribute type and entity references. does not support updation of complex types like arrays, maps Null updates are not possible

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

bigdatacm — Thu, 22 Aug 2024 07:58:02 GMT

Documentation saying syntax as follows.

PUT /v2/entity/guid/{guid}

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

vats — Thu, 22 Aug 2024 12:31:23 GMT

@bigdatacm Can you try this I hope it will work

i.e

curl " https://URL/api/atlas/v2/entity/guid/7g5678h9-4003-407a-ac00-791c7c53e6d5" \
        -i -X GET --negotiate \
        -H 'Content-Type: application/json' \
        -H 'Accept: application/json' \
        -u username:password >> test_oracle_tbl.json -k

and then modify the test_oracle_tbl.json and make a partial update to the entity

curl "https://hostname:port/api/atlas/v2/entity/uniqueAttribute/type/datsetname?attr:qualifiedName=name"
-i -X GET --negotiate \
        -H 'Content-Type: application/json' \
        -H 'Accept: application/json' \
        -u username:password -d@test_oracle_tbl.json -k

Re: How to perfrom update (REST API - PUT) operation of apache atlas entity

bigdatacm — Mon, 26 Aug 2024 09:15:44 GMT

yes, it works with PUT command in place not get command.