GET /documents/dynamic-forms/r1/option-groups

Http Verb	GET
Url	/documents/dynamic-forms/r1/option-groups
Permissions required	FSM_DATACOLLECTION_MODULE
Personally Identifiable Information (PII)	No
Sensitive Information	No
Last Modified Version	r1
Released since	2026 W1 (FSM 22.0)
Deprecated since
Removed since
Tech Tags	PAGINATION, ORDERING-SERVER-SIDE

Business Logic

This API returns a list of data collection option groups filtered by input criteria. Option groups are reusable sets of selection options that can be used across multiple dynamic forms templates.

Query String Parameters

Filter ℹ️

Field	Validations	Notes
id		Collection of Ids
description		String filter for description
model		String filter for model (JSON representation of selection options)
active		Boolean filter for active status

Order ℹ️

Default Order

default

Possible order values

No other ordering options available.

Page ℹ️

Default.

Fields ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field	Notes
id	Option group ID
description	Localized description of the option group
model	JSON string representing the selection options
active	Boolean indicating if the option group is active

JSON

{
  "content": [
    {
      "id": 1,
      "description": {
        "en": "Priority Levels",
        "it": "Livelli di Priorità"
      },
      "model": "[{\"value\":\"high\",\"description\":{\"en\":\"High\",\"it\":\"Alto\"}}]",
      "active": true
    }
  ],
  "page": {
    "number": 0,
    "size": 20,
    "totalElements": 1,
    "totalPages": 1
  }
}

Response error codes

BASE_0001 ,DATACOLLECTION_0027