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.

GET https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/executions

Preparation before calling

Prepare a personal access token and target workspace ID that has access to the target workspace.

Query parameters

offsetinteger
Returns the starting position of the list.
limitinteger
Return the quantity.
statusstring
Filter by job status.
execution_modestring
Filter by execution mode.
workflow_namestring
Filter by workflow name.

Request example

curl "https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/executions?offset=0&limit=20" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

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.

codestring
`OK` when successful.
msgstring
`OK` when successful.
data.totalinteger
The total number of jobs that meet the filter conditions.
data.executionsobject[]
Current page job summary; empty array when there are no results.
data.executions[].execution_idstring
Execution ID.
data.executions[].workflow_idstring
ID of the workflow to which it belongs.
data.executions[].dispatch_job_idstring
Scheduling job ID; returned when provided by the server.
data.executions[].workflow_namestring
Workflow name; returned when provided by the server.
data.executions[].statusstring
Current status.
data.executions[].execution_modestring
Execution mode.
data.executions[].available_actionsstring[]
Operations allowed in the current state.
data.executions[].cron_expressionstring
Cron expression; only returned in timing mode.
data.executions[].moi_task_idstring
Task ID; returned when the server has assigned it.
data.executions[].moi_case_idstring
Case ID; returned when the server has assigned it.
data.executions[].moi_workflow_def_idstring
Workflow definition identifier; returned when the server has assigned it.
data.executions[].moi_workflow_version_idstring
Workflow version identifier; returned when the server has assigned it.
data.executions[].data_namestring
The name of the data associated with this execution; returned when applicable.
data.executions[].file_idstring
The file ID associated with this execution; returned when applicable.
data.executions[].pause_scopestring
Pause range; returned when in pause state and provided by the server.
data.executions[].errorstring
Current execution error; returned when there is an error.
data.executions[].started_atstring
Start time; may be omitted if not generated.
data.executions[].ended_atstring
End time; may be omitted if not generated.
data.executions[].created_atstring
Creation time; may be omitted if not generated.
data.executions[].updated_atstring
Last updated time; may be omitted if not generated.

Successful response example

{
  "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"
      }
    ]
  }
}

Error response

codestring
Error code.
msgstring
Readable error message.
datanull
`null` in an error response.

Error response example

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

Follow-up operations

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

Last updated on