Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Catalog Management/ Create a Directory
Updated on 2025-11-17 GMT+08:00
View PDF

Create a Directory

Function

Create directories (data standards and code tables).

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/design/directorys

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header).

This field is mandatory for authentication using tokens.

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Project-Id

No

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios.

Content-Type

No

String

Default value: application/json;charset=UTF-8

This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Catalog name.

description

No

String

Description.

type

Yes

String

Directory type

Options:

  • STANDARD_ELEMENT: data standard

  • CODE: code table

id

No

String

ID. This parameter is optional for creation but mandatory for update. ID string

parent_id

Yes

String

Parent directory ID. The value null is transferred at the first layer. ID string

prev_id

Yes

String

ID of the previous node. Transfer null for the first node. ID string

ref_id

No

String

Associated subject ID, which is a string

children

No

Array of DirectoryVO objects

Subdirectory.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

data object

data: unified outermost data structure of the returned result.
Table 5 data

Parameter

Type

Description

value

DirectoryVO object

value: unified outer data structure of the returned result.
Table 6 DirectoryVO

Parameter

Type

Description

name

String

Catalog name.

description

String

Description.

type

String

Directory type

Options:

  • STANDARD_ELEMENT: data standard

  • CODE: code table

id

String

ID. This parameter is optional for creation but mandatory for update. ID string

parent_id

String

Parent directory ID. The value null is transferred at the first layer. ID string

prev_id

String

ID of the previous node. Transfer null for the first node. ID string

root_id

String

Root node ID, which is read-only ID string

qualified_name

String

Asset name of a catalog. This parameter is read-only.

from_public

Boolean

Indicates whether the data is from the public layer. This parameter is read-only.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

create_by

String

Creator, which is read-only.

update_by

String

Updater, which is read-only.

ref_id

String

Associated subject ID, which is a string

children

Array of DirectoryVO objects

Subdirectory.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Example Requests

Create a directory based on the request parameters.

POST https://{endpoint}/v2/{project_id}/design/directorys?type=STANDARD_ELEMENT

{
  "name" : "Online payment",
  "parent_id" : "1169318103583268864",
  "prev_id" : 1169318103583268864,
  "type" : "STANDARD_ELEMENT"
}

Example Responses

Status code: 200

This operation succeeds, and the returned data is DirectoryVO.

{
  "data" : {
    "value" : {
      "name" : "Online payment",
      "description" : null,
      "type" : "STANDARD_ELEMENT",
      "id" : "1231215227505364992",
      "parent_id" : "1169318103583268864",
      "prev_id" : null,
      "root_id" : "1169318103583268864",
      "qualified_name" : "Payment Method. Online Payment",
      "create_time" : "2024-04-20T12:09:45.11+08:00",
      "update_time" : "2024-04-20T12:09:45.11+08:00",
      "from_public" : null,
      "create_by" : "test_uesr",
      "update_by" : "test_uesr",
      "ref_id" : null,
      "children" : null
    }
  }
}

Status code: 400

BadRequest

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

Status code: 401

Unauthorized

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

Status code: 403

Forbidden

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

Status Codes

Status Code

Description

200

This operation succeeds, and the returned data is DirectoryVO.

400

BadRequest

401

Unauthorized

403

Forbidden
Parent Topic: Catalog Management