Skip to content

Survey.get

GET /{namespace}/surveys/{id}

Returns one Survey by id.

Noun
Survey
Mode
read

Get returns one Survey by id. It is inherited: every Noun has get, list, create, update and delete.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Survey.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Outputs

OutputTypeRequiredDescription
surveySurveyrequiredThe Survey.

Effects

  • Reads only: it emits no Event and changes nothing.
  • Read: try, do.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.Survey.get

When it waits

Never: a read runs at once.