All Products
Search
Document Center

DataWorks:CreateWorkflowDefinition

Last Updated:Dec 05, 2024

Creates a workflow in a directory of DataStudio.

Operation description

Note You cannot use this API operation to create multiple workflows at a time. If you specify multiple workflows by using FlowSpec, the system creates only the first specified workflow. Other specified workflows and the nodes in the workflows are ignored. You can call the CreateNode operation to create a node.

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
ProjectIdstringYes

The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.

10000
SpecstringYes

The FlowSpec field information about the workflow. For more information, see FlowSpec .

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

0EF298E5-0940-5AC7-9CB0-65025070XXXX
Idstring

The ID of the workflow.

463497880880954XXXX

Examples

Sample success responses

JSONformat

{
  "RequestId": "0EF298E5-0940-5AC7-9CB0-65025070XXXX",
  "Id": "463497880880954XXXX"
}

Error codes

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