Creates a workflow in DataStudio.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateBusiness

The operation that you want to perform. Set the value to CreateBusiness.

BusinessName String Yes My workflow

The name of the workflow. The name must be unique in a workspace.

ProjectId Long Yes 10000

The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page to view the ID.

RegionId String Yes cn-shanghai

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint used to call the operation.

ProjectIdentifier String No dw_project

The unique English identifier of the DataWorks workspace. The identifier is displayed in the top navigation bar of the DataStudio page. You can click the identifier to switch to another workspace.

You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.

Description String No A workflow created by using the operation

The description of the workflow.

Owner String No 1000000000001

The ID of the Alibaba Cloud account used by the owner of the workflow. If this parameter is not specified, the ID of the Alibaba Cloud account of the user who calls the operation is used by default.

UseType String No NORMAL

The functional module to which the workflow belongs. Valid values: NORMAL and MANUAL-BIZ.

Response parameters

Parameter Type Example Description
BusinessId Long 100001

The ID of the workflow.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code returned.

ErrorMessage String The connection does not exist.

The error message returned.

HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String 0000-ABCD-EFG****

The ID of the request. You can use the ID to troubleshoot issues.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateBusiness
&<Common request parameters>

Sample success responses

JSON format

{"RequestId":"0000-ABCD-EFG****","HttpStatusCode":"200","ErrorCode":"Invalid.Tenant.ConnectionNotExists","ErrorMessage":"The connection does not exist.","BusinessId":"100001","Success":"true"}

Error codes

Http status code Error code Error message Description
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal system error has occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal system error has occurred. Try again later.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the maximum number of requests for the resource has been reached.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted in a short period of time. Try again later.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. The error message returned because your access is forbidden. Activate DataWorks Enterprise or Ultimate Edition.

For a list of error codes, visit the API Error Center.