Adding or Modifying an Asset

Function

Add or modify an asset.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/asset

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Project ID and Account ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.
workspace	Yes	String	Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
entity	Yes	AtlasAssetEntity object	Asset information.
referred_entities	No	Object	Associated asset map Map(String, AtlasAssetEntity). The key is guid, and the value is asset information.

**Table 4** AtlasAssetEntity
Parameter	Mandatory	Type	Description
type_name	Yes	String	Type name.
guid	No	String	Asset GUID.
version	No	Integer	Version
update_time	No	Number	Modification time.
update_user	No	String	User who makes a modification.
create_time	No	Number	Creation time.
create_user	No	String	Creator
display_text	No	String	recommendation
status	No	String	Status
classifications	No	Array of AtlasClassificationInfo objects	Category information.
meanings	No	Array of TermAssignmentHeader objects	Associate a task.
relation_ship_attributes	No	Object	Entity map Map(String, Object). key: association relationship type. value: association relationship information.
attributes	Yes	Object	Entity map Map(String, Object). key: attribute name; value: attribute value.

**Table 5** AtlasClassificationInfo
Parameter	Mandatory	Type	Description
entity_guid	No	String	Asset GUID.
propagate	No	Boolean	Indicates whether to propagate.
validity_periods	No	Array of TimeBoundary objects	Time information.
type_name	No	String	Type name.
attributes	No	Object	Entity map Map(String, Object). key: attribute name; value: attribute value.

**Table 6** TimeBoundary
Parameter	Mandatory	Type	Description
start_time	No	String	Start time.
end_time	No	String	End time.
time_zone	No	String	Time zone.

**Table 7** TermAssignmentHeader
Parameter	Mandatory	Type	Description
confidence	No	Integer	Trust ID.
steward	No	String	Administrator
source	No	String	Source.
status	No	String	Enumerated values: DISCOVERED, PROPOSED, IMPORTED, VALIDATED, DEPRECATED, OBSOLETE and OTHER.
create_user	No	String	Creator
expression	No	String	Expression.
display_text	No	String	Display information
term_guid	No	String	Tag GUID
relation_guid	No	String	Associated GUID

Response Parameters

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

{
  "entity" : {
    "attributes" : {
      "owner" : null,
      "comments" : null,
      "qualifiedName" : "postgres.dm_autotest.duoallfuhe013.dqc_create_timestamp@dws.dws-4autotest-nomodify.dws.myhuaweicloud.com-dws_4autotest_nomodify.0833a5737480d53b2f25c010dc1a7b88-workspace-1b59d3c777ad4d619b89eeac4f3cce87",
      "isPartitionColumn" : false,
      "description" : null,
      "isPrimaryKey" : false,
      "type" : "bigint",
      "ordinalPosition" : 6,
      "connectionType" : "dws",
      "securityLevel" : null,
      "connectionQName" : "dws@dws-4autotest-nomodify.dws.myhuaweicloud.com-dws_4autotest_nomodify.0833a5737480d53b2f25c010dc1a7b88-workspace-1b59d3c777ad4d619b89eeac4f3cce87",
      "isNullable" : "true",
      "name" : "dqc_create_timestamp",
      "connectionId" : "null:8a94806e79e693a30179e972c4aa000c",
      "alias" : null,
      "table" : {
        "uniqueAttributes" : {
          "qualifiedName" : "postgres.dm_autotest.duoallfuhe013@dws.dws-4autotest-nomodify.dws.myhuaweicloud.com-dws_4autotest_nomodify.0833a5737480d53b2f25c010dc1a7b88-workspace-1b59d3c777ad4d619b89eeac4f3cce87"
        },
        "typeName" : "dws_table",
        "name" : "duoallfuhe013",
        "guid" : "bc9af691-3401-4a7e-959f-413359dafeb6"
      }
    },
    "classifications" : null,
    "create_time" : 1662567796444,
    "create_user" : "user_demo",
    "display_text" : "dqc_create_timestamp",
    "guid" : "266b1194-1713-47c9-94be-fdac82023f2f",
    "meanings" : null,
    "relation_ship_attributes" : {
      "inputToProcesses" : [ ],
      "meanings" : [ ],
      "table" : {
        "relationshipAttributes" : {
          "typeName" : "dws_table_column"
        },
        "displayText" : "duoallfuhe013",
        "relationshipGuid" : "f78811cb-0dd8-4459-8fda-54ca44d66005",
        "typeName" : "dws_table",
        "guid" : "bc9af691-3401-4a7e-959f-413359dafeb6",
        "relationshipStatus" : "ACTIVE"
      },
      "outputFromProcesses" : [ ]
    },
    "status" : "ACTIVE",
    "type_name" : "dws_column",
    "update_time" : 1662567796444,
    "update_user" : "user_demo",
    "version" : 0
  },
  "referred_entities" : {
    "dws@dws-4autotest-nomodify.dws.myhuaweicloud.com-dws_4autotest_nomodify.0833a5737480d53b2f25c010dc1a7b88-workspace-1b59d3c777ad4d619b89eeac4f3cce87" : {
      "attributes" : {
        "owner" : "user_demo",
        "securityLevel" : null,
        "createTime" : 0,
        "port" : 8000,
        "qualifiedName" : "dws@dws-4autotest-nomodify.dws.myhuaweicloud.com-dws_4autotest_nomodify.0833a5737480d53b2f25c010dc1a7b88-workspace-1b59d3c777ad4d619b89eeac4f3cce87",
        "name" : "dws_test",
        "host" : null,
        "description" : null,
        "id" : "8a94806e79e693a30179e972c4aa000c",
        "connectionType" : "dws"
      },
      "classifications" : null,
      "create_time" : 1665641601524,
      "create_user" : "user_demo",
      "display_text" : "dws_test",
      "guid" : "46bdc502-7912-460f-9d67-15141e9ab096",
      "meanings" : null,
      "relation_ship_attributes" : {
        "meanings" : [ ]
      },
      "status" : "ACTIVE",
      "type_name" : "Connection",
      "update_time" : 1669914264150,
      "update_user" : "user_demo",
      "version" : 0
    }
  }
}

Example Responses

None

Status Codes

Status Code	Description
200	OK.
400	Bad Request:
401	Unauthorized:
403	Forbidden.
404	Not found.
500	InternalServerError.

Parent Topic: Asset Management

Previous topic: Obtaining Asset Details by GUID

Next topic: Deleting an Asset

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel