All Products
Search

This Product

    DataWorks:CreateBusiness

    Document Center

    DataWorks:CreateBusiness

    Last Updated:Dec 04, 2025

    Creates a workflow in DataStudio.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ProjectIdlongNo

    The ID of the DataWorks workspace. You can view the workspace ID on the workspace management page in the DataWorks console.

    		10000
    ProjectIdentifierstringNo

    The unique identifier of the DataWorks workspace, This is the identifier shown in the workspace switch at the top of the Data Studio page. Either this parameter or ProjectId must be specified to determine which DataWorks project this API call operates on.

    		dw_project
    BusinessNamestringYes

    The name of the workflow. Workflow names must be unique within the same workspace.

    		My business process
    DescriptionstringNo

    The description of the workflow.

    		test
    OwnerstringNo

    The Alibaba Cloud account ID of the person responsible for the workflow. You can view the account ID by hovering over the user avatar in the top-right corner of the DataWorks console. If this parameter is not specified, the account ID of the API caller is used by default.

    		1000000000001
    UseTypestringNo

    The module to which the workflow belongs. Valid values:

    • NORMAL: Data Studio
    • MANUAL_BIZ: Manually triggered workflow
    		NORMAL

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    HttpStatusCodeinteger

    The HTTP status code.

    		200
    RequestIdstring

    The unique ID of this request. You can troubleshoot issues based on the ID.

    		0000-ABCD-EFG****
    ErrorMessagestring

    The error message.

    		The connection does not exist.
    Successboolean

    Indicates whether the call succeeded. Valid values:

    • true
    • false
    		true
    ErrorCodestring

    The error code.

    • Request succeeded: The ErrorCode field is not returned.
    • Request failed: The ErrorCode field is returned.

    For more information, see the error code section.

    		Invalid.Tenant.ConnectionNotExists
    BusinessIdlong

    The workflow ID.

    		100001

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
    429Throttling.ApiThe request for this resource has exceeded your available limit.-
    429Throttling.SystemThe DataWorks system is busy. Try again later.-
    429Throttling.UserYour request is too frequent. Try again later.-
    500InternalError.SystemAn internal system error occurred. Try again later.-
    500InternalError.UserId.MissingAn internal system error occurred. Try again later.-

    For a list of error codes, visit the Service error codes.