System commands: update, delete
The System Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for System, one group of System commands.
System.update
Changes the given properties of a System. Verb page.
npx startup-builder do System.update --json '<input>' [--try | --send | --do]Emits System.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the System. |
job | string | The one job it does. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
system | System | required | The System. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do System.update --json '{"id": "system_uGWze2jvrp", "job": "Example job"}'System.delete
Deletes a System: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do System.delete --json '<input>' [--try | --send | --do]Emits System.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the System. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
system | System | required | The System. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do System.delete --json '{"id": "system_uGWze2jvrp"}'