Skip to content

Endpoint to list worker configuration fields

https://redmine.teklia.com/issues/10348

Requires #1910 (closed)

A new ListWorkerConfigurationFields endpoint at /api/v1/workers/versions/<uuid:pk>/fields/ returns all WorkerConfigurationField instances for a given worker version ID. This requires execution access to the worker, just like RetrieveWorkerVersion.

The view is unpaginated, as pagination would not be useful here and this makes the frontend implementation easier.

The list is sorted by position. The following fields are returned:

  • id
  • parent_id
  • key
  • display_name
  • help_text
  • type
  • many
  • default
  • required
  • editable
  • choices