Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ ER Modeling/ Obtaining the Operation Result

Updated on 2024-11-06 GMT+08:00

View PDF

Obtaining the Operation Result

Function

This API is used to obtain the result of a batch operation, for example, converting a logical model to a physical model or reversing a database.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/design/operation-results

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
operation_type	Yes	String	Batch operation type. Enumerated values include: ER_REVERSE_DB: reversing a database for relational modeling TRANSFORM_LOGIC_MODEL: converting a logical model to a physical model
operation_id	No	String	ID of the batch operation. For converting a logical model to a physical table, set this parameter to the model_id of the logical model. For reversing a database, set this parameter to the model_id of the target model. The value of model_id can be obtained from the API used to obtain a model.

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
data	data object	Data, which is the unified outermost data structure of the returned result

**Table 5** data
Parameter	Type	Description
value	BatchOperationVO object	Value, which is the unified outer data structure of the returned result

**Table 6** BatchOperationVO
Parameter	Type	Description
id	String	Batch approval ID. The value of this parameter is of the String type instead of the Long type.
tenant_id	String	Project ID.
group_id	String	Group ID. The value is of the String type instead of the Long type.
biz_name	String	Service name.
biz_id	String	Service ID. The value is of the String type instead of the Long type.
operation_status	String	Operation result type enumeration. RUNNING(Running), SUCCESS(Operation succeeded), and FAILED(Operation failed). Options: RUNNING: The task is running. SUCCESS: The operation is successful. FAILED: The operation fails.
operation_type	String	Indicates the type.
biz_info	String	Service details.
create_by	String	Creator.
remark	String	Indicates the remark information.
total	Integer	Total number.
success	Integer	Number of successful operations.
failed	Integer	Indicates the number of failed operations.
rate	String	Indicates the current progress.
logs	String	Logs.
groups	Array of BatchOperationVO objects	Group information.

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

Obtain the result of converting a logical model whose model_id is 1184439352260976640 to a physical model.

GET https://{endpoint}/v1/{project_id}/design/operation-results?operation_type=TRANSFORM_LOGIC_MODEL&operation_id=1184439352260976640

Example Responses

Status code: 200

The operation succeeds. BatchOperationVO is returned.

{
  "data" : {
    "value" : {
      "id" : null,
      "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-eeb055e69c624311b6b9cfee89a4ec70",
      "group_id" : "1243524510200836096",
      "biz_name" : null,
      "biz_id" : null,
      "operation_status" : "SUCCESS",
      "operation_type" : "TRANSFORM_LOGIC_MODEL",
      "biz_info" : null,
      "create_by" : "ei_dayu_y00321344_01",
      "remark" : null,
      "total" : 1,
      "success" : 1,
      "failed" : 0,
      "rate" : "1.00",
      "logs" : null,
      "groups" : [ {
        "id" : "1243524510620266496",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-eeb055e69c624311b6b9cfee89a4ec70",
        "group_id" : "1243524510200836096",
        "biz_name" : "ljst202",
        "biz_id" : null,
        "operation_status" : "SUCCESS",
        "operation_type" : "TRANSFORM_LOGIC_MODEL",
        "biz_info" : null,
        "create_by" : "ei_dayu_y00321344_01",
        "remark" : "SKIP | Skipped by users",
        "total" : 0,
        "success" : 0,
        "failed" : 0,
        "rate" : null,
        "logs" : null,
        "groups" : 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 Codes

Status Code	Description
200	The operation succeeds. BatchOperationVO is returned.
400	BadRequest
401	Unauthorized
403	Forbidden

Parent Topic: ER Modeling

Previous topic: Converting a Logical Model to a Physical Model

Next topic: Import and Export

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