TrieOH
InformdAPIFields

Get a field's select configuration

Fetches the select configuration (behaviour, value type, options) of a `select` field. The actor must be a member of the form.

GET/forms/{form_id}/steps/{step_id}/fields/{field_id}/select

Fetches the select configuration (behaviour, value type, options) of a select field. The actor must be a member of the form.

Authorization

bearerAuth
AuthorizationBearer <token>

JWT issued by IdentityX, signed with Ed25519

In: header

Path Parameters

form_id*string

Form ID.

step_id*string

Step ID.

field_id*string

Field ID.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08/steps/497f6eca-6276-4993-bfeb-53cbbbba6f08/fields/497f6eca-6276-4993-bfeb-53cbbbba6f08/select"
{
  "field_id": "e68e30b1-d177-4632-b748-463bcd0eedc6",
  "behaviour": "checkbox",
  "value_type": "string",
  "options": [
    {}
  ]
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 401,
  "title": "Unauthenticated"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 403,
  "title": "Insufficient Role"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 404,
  "title": "Not Found"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 500,
  "title": "Internal Server Error"
}