View workflow jobs¶

Lists the workflow execution jobs that are readable by the current caller. First find the execution ID through this interface, and then query the job details or results.

HTTP
GET $CLOUDSIGMA_API_BASE/workflow/v2/workflow-apps/executions

Before you call this API¶

Configure the regional API endpoint and authentication, and select the target workspace.

Request¶

Input examples

Shell
curl "$CLOUDSIGMA_API_BASE/workflow/v2/workflow-apps/executions?offset=0&limit=20" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Parameter reference

Query parameters

Field	Type	Description
`offset`	integer	Returns the starting position of the list.
`limit`	integer	Return the quantity.
`status`	string	Filter by job status.
`execution_mode`	string	Filter by execution mode.
`workflow_name`	string	Filter by workflow name.

Successful response¶

Returns 200 on success. data.total is the total number of matches, and data.executions is the job summary for the current page.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "total": 1,
    "executions": [
      {
        "execution_id": "exec-001",
        "dispatch_job_id": "dispatch-001",
        "workflow_id": "wf-001",
        "workflow_name": "daily-import",
        "status": "running",
        "available_actions": ["pause", "cancel"],
        "execution_mode": "one_shot",
        "moi_task_id": "task-001",
        "moi_case_id": "case-001",
        "started_at": "2026-08-18T10:00:00Z",
        "created_at": "2026-08-18T10:00:00Z",
        "updated_at": "2026-08-18T10:01:00Z"
      }
    ]
  }
}

Field reference

Field	Type	Description
`code`	string	`OK` when successful.
`msg`	string	`OK` when successful.
`data.total`	integer	The total number of jobs that meet the filter conditions.
`data.executions`	object[]	Current page job summary; empty array when there are no results.
`data.executions[].execution_id`	string	Execution ID.
`data.executions[].workflow_id`	string	ID of the workflow to which it belongs.
`data.executions[].dispatch_job_id`	string	Scheduling job ID; returned when provided by the server.
`data.executions[].workflow_name`	string	Workflow name; returned when provided by the server.
`data.executions[].status`	string	Current status.
`data.executions[].execution_mode`	string	Execution mode.
`data.executions[].available_actions`	string[]	Operations allowed in the current state.
`data.executions[].cron_expression`	string	Cron expression; only returned in timing mode.
`data.executions[].moi_task_id`	string	Task ID; returned when the server has assigned it.
`data.executions[].moi_case_id`	string	Case ID; returned when the server has assigned it.
`data.executions[].moi_workflow_def_id`	string	Workflow definition identifier; returned when the server has assigned it.
`data.executions[].moi_workflow_version_id`	string	Workflow version identifier; returned when the server has assigned it.
`data.executions[].data_name`	string	The name of the data associated with this execution; returned when applicable.
`data.executions[].file_id`	string	The file ID associated with this execution; returned when applicable.
`data.executions[].pause_scope`	string	Pause range; returned when in pause state and provided by the server.
`data.executions[].error`	string	Current execution error; returned when there is an error.
`data.executions[].started_at`	string	Start time; may be omitted if not generated.
`data.executions[].ended_at`	string	End time; may be omitted if not generated.
`data.executions[].created_at`	string	Creation time; may be omitted if not generated.
`data.executions[].updated_at`	string	Last updated time; may be omitted if not generated.

Error response¶

Response example

JSON
{
  "code": "ErrParamInvalid",
  "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¶

Use data.executions[].workflow_id and execution_id query workflow job details.

Last updated on Sep 15, 2026