Add/Edit User-Defined Properties for Entity in Atlas via API

Question

I want to use the Atlas API to add/edit user-defined properties to a particular entity. I've previously had success using the API to edit properties that are already defined, such as an entity description:

```

curl --location --request PUT 'https://[host]/api/atlas/v2/entity/guid/[guid]?name=description' \

--header 'Content-Type: application/json' \

--header 'Authorization: Basic' \

--data '"a test table"'

```

However, it's not clear how to use the API to create and edit user-defined properties. When I try changing the url query to a user-defined property name, it complains that that property is not defined for the entity type.

For reference, in the UI, this is done fairly easily.

Screenshot 2024-03-26 at 2.24.08 PM.png

Scharan · Accepted Answer

Hello @ipson

To edit the entity in Atlas, you need to export the entity, which will be downloaded in zip format, extract the files, edit the required files, zip the file in its original order, and then import the updated files to Atlas in compressed format (zip).

You can make use of export and import atlas api's to perform the above steps

Puni · Answer

Hi @ipson I have tried checking on this and I find no API option specific to user defined properties.For your reference: Atlas API listhttps://atlas.apache.org/api/v2/index.htmlRegards,Puneeth

Sign up

Please use your Cloudera account.

Login to the community

Please use your Cloudera account.