Help Center/ DataArts Studio/ API Reference/ DataArts Catalog APIs/ Asset/ Querying the Summary of Specified Fields
Updated on 2025-11-17 GMT+08:00
View PDF

Querying the Summary of Specified Fields

Function

This API is used to collect brief information about specified fields.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/asset/profile/columns

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

dw_id

No

String

Connection ID.

db_type

No

String

Data source type

database_name

No

String

Database name

table_name

No

String

Table name

table_id

No

String

Table ID

column_names

No

Array of TableColumnDTO objects

List of summary fields to be updated.

fields_name

No

Array of strings

List of field names

queue

No

String

Execute the update statement queue.

unique

No

Boolean

Whether to collect unique values

time_profile

No

Boolean

Time archive.

sample

No

String

Data sampling mode.

job_id

No

String

Job ID

cancel

No

Boolean

Whether to cancel it

auto_stop

No

Boolean

Whether to automatically stop it.

obsconfig

No

OBSCommonConfig object

OBS configuration, which is not involved in summary collection.
Table 4 TableColumnDTO

Parameter

Mandatory

Type

Description

column_name

No

String

Specifies the column name.

description

No

String

Field description

type

No

String

Column type

is_partition_column

No

Boolean

Indicates whether a field is a partition field.
Table 5 OBSCommonConfig

Parameter

Mandatory

Type

Description

column_map

No

Object

Map<String, String> structure. key: field name; value: field information.

path

No

String

Path

delimiter

No

String

Separator.

quote

No

String

Reference.

escape

No

String

Avoid this problem.

header

No

Boolean

Indicates whether a header is used.

data_type

No

String

Data type.

date_format

No

String

Data format.

timestamp_format

No

String

Time format

null_value

No

String

If this parameter is left empty, the default value is used.

comment

No

String

Annotation.

parse_mode

No

String

Parsing mode.

join_table

No

String

Joint table.

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.

Example Requests

{
  "dw_id" : "003b3ed52daf41e6829a0bc74526f5f7",
  "db_type" : "DLI",
  "database_name" : "default",
  "table_name" : "a1",
  "queue" : "default",
  "unique" : false,
  "sample" : "0",
  "column_names" : [ {
    "column_name" : "q1",
    "description" : "",
    "type" : "double"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

200

Success.

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.
Parent Topic: Asset