Approvals

This category lists the 25 Runtime system commands under system.approval..

1. List definitions

Full name: system.approval.definition.list

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

sl system approval definition list \
  [--keyword value] [--cursor value] [--limit n] [--json]

Parameters:

• keyword（optional）— Matches process name, code, description, subject, or status
• subjectType（optional）— Only form_data is supported by this list
• cursor（optional）— Opaque nextCursor from the previous request
• limit（optional）— Maximum items, 1-100; defaults to 20

2. Retrieve definition

Full name: system.approval.definition.get

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

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

Parameters:

• definitionId（required）— Approval definition UUID discovered with its list command

3. Create definition

Full name: system.approval.definition.create

Create approval definition resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

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

Parameters:

• code（required）— Tenant-unique immutable-style code using lowercase letters, digits, and underscores
• name（required）— Process display name
• description（optional）— Nullable process description
• subjectType（required）— Must be form_data
• subjectKey（required）— Enabled subject form UUID
• subjectName（required）— Current subject form name
• schema（required）— Initial approval graph; an empty nodes/edges draft is allowed only here

4. Update definition

Full name: system.approval.definition.update

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

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

Parameters:

• definitionId（required）— Approval definition UUID discovered with its list command
• code/name/description（optional）— Basic process metadata
• subjectType/subjectKey/subjectName（optional）— Replacement enabled form subject triple. Keep all three consistent

5. Enable definition

Full name: system.approval.definition.enable

Enable approval definition resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system approval definition enable --definition-id <uuid> [--json]

Parameters:

• definitionId（required）— Disabled approval definition UUID discovered with its list command

6. Archive definition

Full name: system.approval.definition.archive

Archive approval definition resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system approval definition archive --definition-id <uuid> [--json]

Parameters:

• definitionId（required）— Approval definition UUID discovered with its list command

7. Delete definition

Full name: system.approval.definition.delete

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

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

Parameters:

• definitionId（required）— Archived approval definition UUID discovered with its list command

8. List definition versions

Full name: system.approval.definition.version.list

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

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

Parameters:

• definitionId（required）— Approval definition UUID discovered with its list command
• cursor/limit（optional）— Opaque nextCursor and 1-100 version limit

9. Create definition version

Full name: system.approval.definition.version.create

Create approval definition version resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

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

Parameters:

• definitionId（required）— Approval definition UUID discovered with its list command
• schema（required）— Complete connected graph validated against the approval compiler and tenant resources

10. Publish definition version

Full name: system.approval.definition.version.publish

Publish approval definition version resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

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

Parameters:

• definitionId（required）— Approval definition UUID discovered with its list command
• versionId（required）— Draft definition version UUID discovered with its list command

11. List records

Full name: system.approval.record.list

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

sl system approval record list \
  [--definition-id <uuid>] [--form-api-name value] [--status value] \
  [--from iso --to iso] [--keyword value] [--cursor value] [--limit n] \
  [--definition-json json|--definition-file path] [--json]

Parameters:

• status（optional）— Current task status
• instanceStatus（optional）— Overall instance status
• definitionId/formApiName（optional）— Process and form filters
• initiatorMemberId/currentApproverMemberId（optional）— Member UUID filters
• startedAtFrom/startedAtTo（optional）— Paired ISO datetimes with offsets
• keyword/searchFieldApiName（optional）— Keyword and optional field-specific search; field search requires formApiName
• cursor/limit（optional）— Opaque nextCursor and 1-100 result limit; keep filters unchanged between requests

12. Retrieve record column settings

Full name: system.approval.record.column-settings.get

Retrieve approval record column settings resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system approval record column-settings get \
  --form-api-name value [--json]

Parameters:

• formApiName（required）— Form API name, or all for common approval columns

13. Save record column settings

Full name: system.approval.record.column-settings.save

Save approval record column settings resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system approval record column-settings save \
  --form-api-name value (--definition-json json|--definition-file path) \
  [--json]

Parameters:

• formApiName（required）— Same scope used by get
• columns（required）— Complete ordered column snapshot: fieldId, apiName, hidden, sortOrder

14. Retrieve instance

Full name: system.approval.instance.get

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

sl system approval instance get --instance-id <uuid> [--json]

Parameters:

• instanceId（required）— Approval instance UUID discovered with its list command

15. Withdraw an administrative action from the instance

Full name: system.approval.instance.admin-withdraw

Withdraw an administrative action from approval instance. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: High risk

sl system approval instance admin-withdraw \
  --instance-id <uuid> --reason value [--json]

Parameters:

• instanceId（required）— Running approval instance UUID discovered with its list command
• reason（required）— Mandatory administrator reason recorded as the withdrawal comment

16. Retrieve task

Full name: system.approval.task.get

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

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

Parameters:

• taskId（required）— Approval task UUID discovered with its list command

17. Record an administrative decision for the task

Full name: system.approval.task.admin-decide

Record an administrative decision for approval task. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: High risk

sl system approval task admin-decide \
  --task-id <uuid> (--definition-json json|--definition-file path) \
  [--json]

Parameters:

• taskId（required）— Pending approval task UUID discovered with its list command
• decision（required）— approved, rejected, or returned
• reason（required）— Mandatory administrator reason
• mentionedMemberIds（optional）— Up to 50 active member UUIDs
• returnTarget（optional）— Required only for returned: initiator, restart, or a prior nodeKey

18. Add an administrative signature to the task

Full name: system.approval.task.admin-add-sign

Add an administrative signature to approval task. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system approval task admin-add-sign \
  --task-id <uuid> (--definition-json json|--definition-file path) \
  [--json]

Parameters:

• taskId（required）— Pending approval task UUID discovered with its list command
• memberIds（required）— 1-50 active tenant member UUIDs
• reason（required）— Mandatory administrator reason

19. List timeout rules

Full name: system.approval.timeout-rule.list

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

sl system approval timeout-rule list \
  [--keyword value] [--cursor value] [--limit n] [--json]

Parameters:

• keyword（optional）— Rule name filter
• cursor/limit（optional）— Opaque nextCursor and 1-100 result limit

20. Retrieve timeout rule

Full name: system.approval.timeout-rule.get

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

sl system approval timeout-rule get --rule-id <uuid> [--json]

Parameters:

• ruleId（required）— Timeout rule UUID discovered with its list command

21. Create timeout rule

Full name: system.approval.timeout-rule.create

Create approval timeout rule resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system approval timeout-rule create \
  (--definition-json json|--definition-file path) [--json]

Parameters:

• name（required）— Rule name
• scopeType/definitionIds（required）— selected_definitions requires IDs; all_definitions requires an empty list
• timeoutValue/timeoutUnit（required）— Primary timeout duration
• actionRemind/actionAutoClose（required）— At least one action must be true
• remindTimeoutValue/remindTimeoutUnit（required）— Reminder duration fields
• autoCloseTimeoutValue/autoCloseTimeoutUnit（required）— Auto-close duration fields
• includeInProgressInstances（required）— Whether enabling also schedules eligible running instances
• repeatRemind/repeatRemindValue/repeatRemindUnit（required）— Repeat configuration; repeat requires reminders
• enabled（optional）— Fixed false for CLI creation; call enable after review

22. Update timeout rule

Full name: system.approval.timeout-rule.update

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

sl system approval timeout-rule update \
  --rule-id <uuid> (--definition-json json|--definition-file path) \
  [--json]

Parameters:

• ruleId（required）— Timeout rule UUID discovered with its list command
• configuration fields（optional）— Partial configuration update; enabled is intentionally excluded

23. Enable timeout rule

Full name: system.approval.timeout-rule.enable

Enable approval timeout rule resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system approval timeout-rule enable --rule-id <uuid> [--json]

Parameters:

• ruleId（required）— Disabled timeout rule UUID discovered with its list command

24. Disable timeout rule

Full name: system.approval.timeout-rule.disable

Disable approval timeout rule resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system approval timeout-rule disable --rule-id <uuid> [--json]

Parameters:

• ruleId（required）— Enabled timeout rule UUID discovered with its list command

25. Delete timeout rule

Full name: system.approval.timeout-rule.delete

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

sl system approval timeout-rule delete --rule-id <uuid> [--json]

Parameters:

• ruleId（required）— Disabled timeout rule UUID discovered with its list command