All Products
Search
Document Center

DataWorks:UpdateWorkflowDefinition

Last Updated:Dec 05, 2024

Updates the basic information about a workflow in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.

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.

10001
IdstringYes

The ID of the workflow.

652567824470354XXXX
SpecstringYes

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

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

20BF7E80-668A-5620-8AD8-879B8FEAXXXX
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "20BF7E80-668A-5620-8AD8-879B8FEAXXXX",
  "Success": true
}

Error codes

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