Delete workflow template¶
Delete a workflow template. Deleting a custom template only affects the current workspace; deleting a built-in template requires administrator privileges. This operation is irreversible.
HTTP
DELETE $CLOUDSIGMA_API_BASE/workflow-templates/{id}
Before you call this API¶
Configure the regional API endpoint and authentication, and select the target workspace.
First query workflow template details to confirm the template to be deleted. Deleting built-in templates also requires administrator rights.
Request¶
Shell
curl -X DELETE "$CLOUDSIGMA_API_BASE/workflow-templates/$TEMPLATE_ID" \
-H "X-API-Key: $CLOUDSIGMA_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
Request parameters
Successful response¶
The template was removed when code was OK and data.message was deleted in the response. Deletion is irreversible.
The response fields are as follows.
JSON
{
"code": "OK",
"msg": "OK",
"data": {
"message": "deleted"
}
}
| Field | Type | Description |
|---|---|---|
code | string | OK when successful. |
msg | string | OK when successful. |
data.message | string | Fixed to deleted, indicating that the template has been deleted. |
Error response¶
JSON
{
"code": "ErrSeedTemplateManaged",
"msg": "系统管理的模板不允许修改",
"data": null
}
| Field | Type | Description |
|---|---|---|
code | string | Error code. |
msg | string | Readable error message. |
data | null | `null` in an error response. |
Follow-up operations¶
Query workflow template list confirms that the template has been removed.
Last updated on