CreateBusiness

更新时间:
复制 MD 格式

Creates a workflow in DataStudio.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

ProjectId

integer

No

The ID of the DataWorks workspace.
You can log on to the DataWorks console, go to the Workspace Management page, and view the ID.

10000

ProjectIdentifier

string

No

The unique identifier of the DataWorks workspace, which is the English identifier displayed when you switch workspaces at the top of the Data Development page. You must specify either this parameter or the projectid parameter to identify the DataWorks project for this API call.

dw_project

BusinessName

string

Yes

Name of the Business Process.
The name must be unique within the same project space.

My business process

Description

string

No

Description of the Business Process.

test

Owner

string

No

The Alibaba Cloud account ID of the owner responsible for the Business Process.
You can log on to the DataWorks console, move the mouse pointer over the profile picture in the upper-right corner of the menu bar, and view the Account ID. If this parameter is empty, the Alibaba Cloud account ID of the invoker is used by default.

1000000000001

UseType

string

No

Function module to which the Business Process belongs. Valid values:

  • NORMAL (Data Development)

  • MANUAL_BIZ (manually triggered workflow)

NORMAL

Response elements

Element

Type

Description

Example

object

Return Result.

HttpStatusCode

integer

HTTP status code.

200

RequestId

string

The unique ID of this request.
If an error occurs, you can use this ID to troubleshoot the issue.

0000-ABCD-EFG****

ErrorMessage

string

Error message.

The connection does not exist.

Success

boolean

Indicates whether the invocation succeeded. Valid values:

  • true: The invocation succeeded.

  • false: The invocation failed.

true

ErrorCode

string

Error code. The value is as follows:

  • If the request succeeds, the ErrorCode field is not returned.

  • If the request fails, the ErrorCode field is returned.

For more information, see the error code list in this topic.

Invalid.Tenant.ConnectionNotExists

BusinessId

integer

Business Process ID.

100001

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description

500 InternalError.System An internal system error occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. No permission, please authorize
429 Throttling.Api The request for this resource has exceeded your available limit.
429 Throttling.System The DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.