System methods: update, delete
The System Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for System, one group of System methods.
System.update
Changes the given properties of a System. Verb page.
interface SystemVerbs {
update(input: SystemUpdateInput, options?: SB.CallOptions): SB.Call<System>
}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
import { $ } from 'startup-builder'
const system = await $.System.update({ id: 'system_uGWze2jvrp', job: 'Example job' })System.delete
Deletes a System: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface SystemVerbs {
delete(input: SystemDeleteInput, options?: SB.CallOptions): SB.Call<System>
}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
import { $ } from 'startup-builder'
const system = await $.System.delete({ id: 'system_uGWze2jvrp' })