Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Process Architecture/ Search for BPA Details
Updated on 2025-11-17 GMT+08:00
View PDF

Search for BPA Details

Function

Search for BPA details.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/design/biz/catalogs/{id}

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.

id

Yes

String

Entity ID, which is a string

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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

data

data object

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

Parameter

Type

Description

value

BizCatalogVO object

BPA directory.
Table 5 BizCatalogVO

Parameter

Type

Description

name

String

Workflow name

description

String

Description.

guid

String

ID in the corresponding asset.

owner

String

Owner of the instance.

parent_id

String

Parent directory ID. If no parent directory ID exists, the parent directory is the root directory. ID string

prev_id

String

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

next_id

String

ID of the next node. If there is no next node ID, the node is the tail node. ID string

id

String

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

qualified_id

String

Authentication ID, which is automatically generated.

create_by

String

Creator.

update_by

String

Person who updates the information.

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.

bizmetric_num

Integer

Number of service indicators, which is not transferred by the frontend.

children_num

Integer

Number of sub-processes, excluding sub-processes.

children

Array of BizCatalogVO objects

Lower-level subdirectory, which is read-only.

Status code: 400

Table 6 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 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: 403

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: 404

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

This API is used to query process details in process design based on the process ID.

GET https://{endpoint}/v2/{project_id}/design/biz/catalogs/904051952785162240

Example Responses

Status code: 200

This operation is successful, and the returned data is BizCatalogVO details.

{
  "data" : {
    "value" : {
      "name" : "xx",
      "description" : "",
      "guid" : "4c9c3574-5cc7-46af-8f67-34782d5a6b32",
      "owner" : "{\"owners\":[\"abc\"]}",
      "parent_id" : "887366192090767360",
      "prev_id" : null,
      "next_id" : null,
      "id" : "904051952785162240",
      "qualified_id" : "887366192090767360.904051952785162240",
      "create_by" : "abc",
      "update_by" : "abc",
      "create_time" : "2021-10-30T16:59:42+08:00",
      "update_time" : "2021-10-30T16:59:42+08:00",
      "bizmetric_num" : null,
      "children_num" : 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 code: 404

Not Found

{
  "error_code" : "DS.60xx",
  "error_msg" : "The User Request API does not exist."
}

Status Codes

Status Code

Description

200

This operation is successful, and the returned data is BizCatalogVO details.

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found
Parent Topic: Process Architecture