Implementation commands: create, get, list
The Implementation Verbs create, get, list as CLI commands, with inputs, result, refusals and an example.
Reference for Implementation, one group of Implementation commands.
Implementation.create
Creates an Implementation. Verb page.
npx startup-builder do Implementation.create --json '<input>' [--try | --send | --do]Emits Implementation.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
kind | string | required | One of managed, custom, or external. |
endpoint | url | For an external Implementation, where api.sb routes each call. | |
deliverBy | date | For a declared Implementation: when a Function runs the Verb; a missed date refunds every reserve. | |
product | Product | An Implementation runs an Interface, System or Verb of one Product. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
implementation | Implementation | required | The Implementation. |
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 Implementation.create --json '{"kind":Implementation.get
Returns one Implementation by id. Verb page.
npx startup-builder do Implementation.get --json '<input>' [--try]Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Implementation. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
implementation | Implementation | required | The Implementation. |
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 Implementation.get --json '{"id":Implementation.list
Returns Implementations, newest first, one page at a time. Verb page.
npx startup-builder do Implementation.list --json '<input>' [--try]Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
implementations | list of Implementation | required | One page of Implementations. |
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 Implementation.list --json '{"limit":