Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Process Architecture/ Modified the process architecture.

Updated on 2024-12-04 GMT+08:00

Online Debugging

CLI Examples

View PDF

Modified the process architecture.

Function

Calling Method

For details, see Calling APIs.

URI

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

**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	Workflow name
description	No	String	Description.
guid	No	String	ID in the corresponding asset.
owner	Yes	String	Owner of the instance.
parent_id	No	String	Parent directory ID. If no parent directory ID exists, the parent directory is the root directory. ID string
prev_id	No	String	ID of the previous node. If there is no previous node ID, the node is the first node. ID string
next_id	No	String	ID of the next node. If there is no next node ID, the node is the tail node. ID string
id	Yes	String	This parameter is left empty during creation and is mandatory during update. ID string
qualified_id	No	String	Authentication ID, which is automatically generated.
create_by	No	String	Creator.
update_by	No	String	Person who updates the information.
bizmetric_num	No	Integer	Number of service indicators, which is not transferred by the frontend.
children_num	No	Integer	Number of sub-processes, excluding sub-processes.

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	BizCatalogVO object	BPA directory.

**Table 6** 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 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.

Status code: 404

**Table 10** 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

Modify the process architecture based on the input parameters.

PUT https://{endpoint}/v2/{project_id}/design/biz/catalogs

{
  "name" : "test_czh_l2_01",
  "parent_id" : "1193123592125169667",
  "prev_id" : null,
  "id" : "1193132546607693824",
  "owner" : "{\"owners\":[\"test_uesr\"]}",
  "description" : "aaa"
}

Example Responses

Status code: 200

Success. The returned data is BizCatalogVO.

{
  "data" : {
    "value" : {
      "name" : "test_czh_l2_01",
      "description" : "aaa",
      "guid" : null,
      "owner" : "{\"owners\":[\"test_uesr\"]}",
      "parent_id" : "1193123592125169667",
      "prev_id" : null,
      "next_id" : null,
      "id" : "1193132546607693824",
      "qualified_id" : null,
      "create_by" : "test_uesr",
      "update_by" : "test_uesr",
      "create_time" : "2024-01-06T10:02:46+08:00",
      "update_time" : "2024-04-18T11:47:07.035+08:00",
      "bizmetric_num" : null,
      "children_num" : null,
      "children" : null
    }
  }
}

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status Codes

Status Code	Description
200	Success. The returned data is BizCatalogVO.
400	BadRequest
401	Unauthorized
403	Forbidden
404	Not Found

Parent Topic: Process Architecture

Previous topic: Create BPA

Next topic: Delete BPA

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot