View workflow template details¶

Read the complete definition of a workflow template. Can read built-in templates for the current language, as well as custom templates created in the current workspace.

HTTP
GET $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 list to obtain the template ID.

Request¶

Input examples

Shell
curl "$CLOUDSIGMA_API_BASE/workflow-templates/$TEMPLATE_ID" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Parameter reference

Request parameters

Successful response¶

Returns 200 on success. data is a complete template object.

The response fields are as follows.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 12,
    "workspace_id": "ws-001",
    "created_by": "user-001",
    "updated_by": "user-001",
    "template_key": "",
    "name": "daily-import-template",
    "description": "每日导入工作流模板",
    "language": "zh-CN",
    "dsl_yaml": "workflow: {}",
    "runtime_fields": "{\"fields\":[]}",
    "is_builtin": false,
    "created_at": "2026-08-18T10:00:00Z",
    "updated_at": "2026-08-18T10:00:00Z"
  }
}

Field reference

Field	Type	Description
`code`	string	OK when successful.
`msg`	string	OK when successful.
`data.id`	integer	Template ID.
`data.workspace_id`	string	The ID of the workspace to which it belongs; the built-in template is an empty string.
`data.created_by`	string	Creator ID.
`data.updated_by`	string	Last updater ID.
`data.template_key`	string	Built-in template identifier; custom template is an empty string.
`data.name`	string	Template name.
`data.description`	string	Template description.
`data.language`	string	Template language.
`data.dsl_yaml`	string	Workflow DSL YAML.
`data.runtime_fields`	string	Runtime field JSON text; empty string when not configured.
`data.is_builtin`	boolean	Whether it is a built-in template.
`data.created_at`	string	Creation time; may be omitted if not provided by the server.
`data.updated_at`	string	Last updated time; may be omitted if not provided by the server.

Error response¶

Response example

JSON
{
  "code": "ErrNotFound",
  "msg": "模板不存在",
  "data": null
}

Field reference

Field	Type	Description
`code`	string	Error code.
`msg`	string	Readable error message.
`data`	null	`null` in an error response.

Follow-up operations¶

When the definition needs to be modified, Update workflow template; when it is no longer used, Delete workflow template.

Last updated on Sep 15, 2026