Help Center/ DataArts Studio/ API Reference/ DataArts Catalog APIs/ Data Map/ Creating or Modifying an Asset (Invitational Test)
Updated on 2025-11-17 GMT+08:00
View PDF

Creating or Modifying an Asset (Invitational Test)

Function

This API is used to create or modify assets. It is in invitational test and will be available for OBT in the future.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/datamap/entities

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.

instance

Yes

String

Instance ID. For details about how to obtain the instance ID, see Instance ID and Workspace ID.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

entity

No

Entity object

Asset information.

referred_entities

No

Object

Associated asset information, which is a Map<String, Entity>. The key is the asset GUID, and value is the asset information.
Table 4 Entity

Parameter

Mandatory

Type

Description

version

No

Number

Data version.

relationship_attributes

No

Object

Association relationship attribute. The data type is Map<String, Object>. The options are as follows: key: relationship type; value: association relationship object.

super_type_names

No

Array of strings

Parent asset type.

business_attributes

No

Object

Service attribute. The data type is Map<String, Map<String, Object>>. The options are as follows: key: service relationship type; value: service relationship.

multi_attributes

No

Object

Multi-value object data structure that bears security levels and tags. The data structure is Map<String, List<Map<String, Object>>>. key indicates the comprehensive relationship type, and value indicates the comprehensive relationship.

privilege_info

No

EntityPrivilegeInfo object

Entity privilege information.

extended_attributes

No

Object

Extended attribute. The data structure is Map<String, Object>. The key field indicates the extended attribute, and the value field indicates the extended attribute value.

guid

No

String

Asset GUID.

type_name

No

String

Asset type name.

type_display_name

No

String

Type display name.

display_text

No

String

Display name.

attributes

No

Object

Asset attribute, which is a Map<String, Object>. The key is an attribute, and value is the attribute value.

updated_attributes

No

Array of strings

List of modified attributes.

project_id

No

String

Project ID

domain_id

No

String

Main account ID.

instance_id

No

Array of strings

Instantiation ID.

workspace_id

No

Array of strings

Workspace IDs

status

No

String

Status

created_by

No

String

Creator

updated_by

No

String

User who makes a modification.

create_time

No

String

Creation time.

update_time

No

String

Modification time.
Table 5 EntityPrivilegeInfo

Parameter

Mandatory

Type

Description

privileges

No

Array of strings

Privilege list.

inherit_privileges

No

Array of strings

List of inherited privileges.

Response Parameters

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

{
  "entity" : {
    "guid" : -1,
    "attributes" : {
      "owner" : "username",
      "is_favorite" : 0,
      "qualifiedName" : "dws@a96be22c-77f3-46ea-96ab-c8913052ec7d",
      "favorites_count" : 0,
      "description" : "This temp entity was generated from DLF lineage service",
      "clusterId" : "",
      "click_through" : 10,
      "baseType" : "Source",
      "path" : "",
      "catalogId" : "",
      "workspaceVsId" : { },
      "createTime" : 0,
      "port" : 8000,
      "sourceType" : "dws",
      "name" : "dws_4autotest1_nomodify",
      "host" : "",
      "id" : "f9338475eb8c4cbda61b85c05908a432",
      "projectId" : ""
    },
    "status" : "ACTIVE",
    "version" : 0,
    "type_name" : "dataasset.Source",
    "type_display_name" : "Data sources",
    "project_id" : 123456,
    "domain_id" : 123456,
    "instance_id" : [ "123456" ],
    "workspace_id" : [ "123456" ],
    "updated_by" : "username",
    "create_time" : 0,
    "update_time" : 0,
    "super_type_names" : [ "base.Asset", "base.Infrastructure" ],
    "business_attributes" : {
      "businessName" : {
        "confidence" : 1.0,
        "name" : "dws0505",
        "confirmed" : true
      }
    },
    "multi_attributes" : {
      "tags" : [ {
        "confidence" : 1.0,
        "name" : "Mistaken deletion of personal data",
        "confirmed" : false
      } ]
    },
    "privilege_info" : {
      "privileges" : [ ],
      "inherit_privileges" : [ ]
    },
    "extended_attributes" : { },
    "display_text" : "dws0505"
  },
  "referred_entities" : null
}

Example Responses

None

Status Codes

Status Code

Description

200

OK.

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.

500

Internal server error.
Parent Topic: Data Map