Updated on 2022-09-15 GMT+08:00

Creating a Catalog

Function

This API is used to create a catalog.

URI

POST /v2/{project_id}/design/biz/catalogs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Workflow name

Maximum: 600

description

No

String

Description

Maximum: 2000

guid

No

String

Asset ID

owner

Yes

String

Owner

Maximum: 4000

parent_id

No

Long

Parent catalog ID. If there is no parent catalog, the current catalog is the root catalog.

prev_id

No

Long

ID of the previous node. If there is no previous node, the current node is the first node.

next_id

No

Long

ID of the next node. If there is no next node, the current node is the last node.

id

Yes

Long

This parameter is left empty during creation and is mandatory during update.

qualified_id

No

String

Authentication ID, which is automatically generated

create_by

No

String

Creator

update_by

No

String

User who updated the business catalog

create_time

No

String

Creation time

update_time

No

String

Update time

bizmetric_num

No

Integer

Number of business metrics, which is not transferred to the front end

children_num

No

Integer

Number of sub-processes, excluding those of sub-processes

children

No

Array of BizCatalogVO objects

Sub-catalog

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

name

String

Workflow name

Maximum: 600

description

String

Description

Maximum: 2000

guid

String

Asset ID

owner

String

Owner

Maximum: 4000

parent_id

Long

Parent catalog ID. If there is no parent catalog, the current catalog is the root catalog.

prev_id

Long

ID of the previous node. If there is no previous node, the current node is the first node.

next_id

Long

ID of the next node. If there is no next node, the current node is the last node.

id

Long

This parameter is left empty during creation and is mandatory during update.

qualified_id

String

Authentication ID, which is automatically generated

create_by

String

Creator

update_by

String

User who updated the business catalog

create_time

String

Creation time

update_time

String

Update time

bizmetric_num

Integer

Number of business metrics, which is not transferred to the front end

children_num

Integer

Number of sub-processes, excluding those of sub-processes

children

Array of BizCatalogVO objects

Sub-catalog

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.000 which indicates that the request was successfully processed.

error_msg

String

Error message

data

Object

Returned data

Example Requests

{
  "id" : "887366192090767360",
  "description" : "demo",
  "name" : "demo",
  "owner" : "ei_dlg",
  "parent_id" : "776737281791897600",
  "prev_id" : "885913975320207360"
}

Example Responses

Status code: 200

The operation succeeds. BizCatalogVO is returned.

{
  "data" : {
    "value" : [ {
      "name" : "db",
      "description" : "db",
      "id" : "db",
      "parent_id" : "db",
      "prev_id" : "db",
      "tenant_id" : "tid",
      "create_time" : 1111,
      "update_time" : 2222,
      "create_by" : "test",
      "update_by" : "test"
    } ]
  }
}

Status Codes

Status Code

Description

200

The operation succeeds. BizCatalogVO is returned.

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found