TRMNL Octri Demo
POST/api/plugin_settings/{plugin_setting_id}/configuration/choices/{resolver_id}

Get plugin configuration choices

Retrieves remote choices for a resolver associated with a plugin configuration. Provide the current revision and a draft so the choices reflect the configuration being edited. Use cursor to continue fetching choices and query to filter them.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 4 body fields
plugin_setting_idintegerrequired
The identifier of the plugin setting whose configuration choices to retrieve.
resolver_idstringrequired
The identifier of the resolver whose remote choices to retrieve.

The configuration revision and draft used to resolve remote choices, with optional pagination and filtering values.

cursorstringoptional
A cursor for continuing through the resolver's choices.
draftarray<object>required
The draft changes used to resolve choices. Provide at most 200 entries; each entry requires `op` and `path`.
querystringoptional
Text used to filter choices. Maximum 200 characters.
revisionstringrequired
The revision of the configuration that the draft is based on.

1 status code
404Returned when the resolver is unknown for the owned target.

Error handling

A 404 is returned when the resolver_id path parameter does not identify a resolver for the owned target. revision and draft are required; the draft array can contain at most 200 entries, each requiring op and a path beginning with /values/. The plugin_setting_id path parameter must identify the plugin setting, and query must be no longer than 200 characters when provided.