Creates a process for deploying or undeploying an entity in DataStudio.
Operation description
Note
You cannot use this API operation to create a process for multiple entities at a time. If you specify multiple entities in a request, the system creates a process only for the first entity.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectId | string | Yes | The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied. | 10000 |
| Type | string | Yes | Specifies whether to deploy or undeploy the entity. Valid values:
| Online |
| ObjectIds | array | Yes | The IDs of entities to which you want to apply the process. Note
A process can be applied to only a single entity and its child entities. If you specify multiple entities in the array, the process is applied only to the first entity in the array and its child entities. Make sure that the array in your request contains only one element. Extra elements will be ignored.
| |
| string | Yes | The ID of the entity to which you want to apply the process, such as the ID of a node or a workflow. | 476506242076571XXXX | |
| Description | string | No | The description of the process. |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX",
"Id": "a7ef0634-20ec-4a7c-a214-54020f91XXXX"
}Error codes
For a list of error codes, visit the Service error codes.