Purpose
GET /{namespace}/purposes/{id}
Returns one Purpose by id.
- Noun
- Purpose
- Mode
read
Get returns one Purpose by id. It is inherited: every Noun has get, list, create, update and delete.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Purpose. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Outputs
| Output | Type | Required | Description |
|---|---|---|---|
purpose | Purpose | required | The Purpose. |
Effects
- Reads only: it emits no Event and changes nothing.
- Read:
try,do.
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. | Purpose.get |
When it waits
Never: a read runs at once.