Skip to main content

Automation

This category lists the 14 Runtime system commands under system.automation..

1. List tasks​

Full name: system.automation.task.list

List automation task records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system automation task list \
  [--keyword value] [--cursor value] [--limit n] [--json]

Parameters:

  • keyword（optional）— Case-insensitive code/name search
  • cursor（optional）— Opaque nextCursor returned by the previous request
  • limit（optional）— Maximum definitions, 1-100; defaults to 20

2. Retrieve task​

Full name: system.automation.task.get

Retrieve automation task resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system automation task get --definition-id <uuid> [--json]

Parameters:

  • definitionId（required）— Automation definition UUID discovered with task.list

3. Create task​

Full name: system.automation.task.create

Create an automation definition and version 1 as a draft from a previously validated graph schema. This command never publishes or activates the task. After approval, publish the returned version id with system.automation.task.version.publish; never activate a newly created draft. · Risk: Write

sl system automation task create \
  (--definition-json json|--definition-file path) [--json]

Parameters:

  • code（required）— Tenant-unique stable automation code, 1-120 characters
  • name（required）— Display name, 1-200 characters
  • description（optional）— Nullable description, at most 2000 characters
  • graphSchema（required）— Complete persisted graph. Create atomically writes the definition and version 1 draft; it does not publish

4. Update task​

Full name: system.automation.task.update

Update automation task resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system automation task update \
  --definition-id <uuid> (--definition-json json|--definition-file path) \
  [--json]

Parameters:

  • definitionId（required）— Existing definition UUID
  • code（optional）— Replacement tenant-unique code
  • name（optional）— Replacement display name
  • description（optional）— Replacement description; null clears it

5. Activate task​

Full name: system.automation.task.activate

Resume a paused automation task that already has an active published version. Never use this command for a draft or newly created task; publish its draft version instead. · Risk: Write

sl system automation task activate --definition-id <uuid> [--json]

Parameters:

  • definitionId（required）— Definition UUID with an active published version. Resumes a paused task and is idempotent when already active

6. Pause task​

Full name: system.automation.task.pause

Pause automation task resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system automation task pause --definition-id <uuid> [--json]

Parameters:

  • definitionId（required）— Active or paused definition UUID. Pausing also pauses its schedule and is idempotent when already paused

7. Delete task​

Full name: system.automation.task.delete

Delete automation task resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: High risk

sl system automation task delete --definition-id <uuid> [--json]

Parameters:

  • definitionId（required）— Draft or paused definition UUID. Active or archived definitions cannot be deleted

8. List task versions​

Full name: system.automation.task.version.list

List automation task version records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system automation task version list \
  --definition-id <uuid> [--cursor value] [--limit n] [--json]

Parameters:

  • definitionId（required）— Existing definition UUID
  • cursor（optional）— Opaque nextCursor returned by the previous request
  • limit（optional）— Maximum versions, 1-100

9. Create task version​

Full name: system.automation.task.version.create

Create a new immutable draft version for an existing automation definition from a previously validated graph schema. This command never publishes or activates the task. · Risk: Write

sl system automation task version create \
  --definition-id <uuid> (--graph-json json|--graph-file path) [--json]

Parameters:

  • definitionId（required）— Existing non-archived definition UUID
  • graphSchema（required）— Complete graph snapshot for a new draft version. This does not mutate an existing snapshot

10. Publish task version​

Full name: system.automation.task.version.publish

Validate and publish one draft automation version. Publishing sets the definition active and assigns activeVersionId, so no subsequent task.activate call is required. · Risk: Write

sl system automation task version publish \
  --definition-id <uuid> --version-id <uuid> [--json]

Parameters:

  • definitionId（required）— Definition UUID that owns the version
  • versionId（required）— Draft version UUID to validate and publish

11. Run task​

Full name: system.automation.task.run

Run automation task resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system automation task run \
  --definition-id <uuid> [--payload-json json|--payload-file path] \
  [--json]

Parameters:

  • definitionId（required）— Active definition UUID with a published active version
  • payload（optional）— Manual trigger payload. A form-bound single-record manual trigger requires payload.recordId

12. List executions​

Full name: system.automation.execution.list

List automation execution records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system automation execution list \
  [--definition-id <uuid>] [--parent-execution-id <uuid>] \
  [--status value] [--keyword value] [--cursor value] [--limit n] \
  [--from timestamp --to timestamp] [--json]

Parameters:

  • definitionId（optional）— Filter by definition UUID
  • parentExecutionId（optional）— Filter child executions of one batch root
  • status（optional）— queued, running, waiting, succeeded, failed, or canceled
  • keyword（optional）— Definition/execution keyword filter
  • cursor（optional）— Opaque cursor returned by the previous page; do not construct it
  • limit（optional）— Page size, 1-100
  • timeRange（optional）— Inclusive search window {from,to}; both values are RFC 3339 timestamps with offsets and from must precede to

13. Retrieve execution​

Full name: system.automation.execution.get

Retrieve automation execution resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system automation execution get --execution-id <uuid> [--json]

Parameters:

  • executionId（required）— Execution UUID. Returns trigger snapshot, graph snapshot, progress, output/error, and node logs

14. List execution batch failures​

Full name: system.automation.execution.batch-failure.list

List automation execution batch failure records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system automation execution batch-failure list \
  --execution-id <uuid> [--cursor value] [--limit n] [--json]

Parameters:

  • executionId（required）— Root batch execution UUID
  • cursor（optional）— Opaque nextCursor returned by the previous request
  • limit（optional）— Maximum failed children, 1-100