Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

schema_id
string<uuid>
required

The unique identifier for the schema.

field_id
string
required

The id of a field in the form schema's model, as it appears under model.properties.

Minimum string length: 1

Query Parameters

Words to match, split on whitespace and /. An option matches when every word appears, case-insensitively, in some segment of its label: the operation's, work order's or scheme's name or code, or the organisation name when options span organisations. Order does not matter. The first five distinct words are searched in the database and any further ones are applied to the returned labels, which sets meta.stats.truncated when it removes options.

ids
string<uuid>[]

Restrict the options to these ids, for showing the labels of values already held. An id the caller can no longer pick is simply absent. The limit is raised to cover every id asked for.

Maximum array length: 100
limit
integer<int64>
default:25

The most options to return. When more match, meta.stats.truncated is true.

Required range: 1 <= x <= 100

Response

The options of an x-source field.

JSON API response object

data
A list of x-source options · object[]
required
meta
object
required
jsonapi
object
required