NextGen APIs

GET /documents/dynamic-forms/r1/option-groups/{optionGroupId}/models

Http Verb

GET

Url

/documents/dynamic-forms/r1/option-groups/{optionGroupId}/models

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


Business Logic

This API retrieves the model (selection options) of a specific data collection option group. The model is returned as a list of selection options with code and localized descriptions.

Path Parameters

Parameter

Type

Required

Description

optionGroupId

Long

Yes

The option group ID

Query String Parameters

Language ℹ️

Default: User's language

Header Parameters

Default.

Response documentation

Response payload fields

Returns an array of selection options:

Field

Notes

code

Unique code for the selection option

description

Localized description of the selection option

Response Body:

JSON
[
  {
    "value": "high",
    "description": {
      "en": "High"
    }
  },
  {
    "value": "medium",
    "description": {
      "en": "Medium"
    }
  },
  {
    "value": "low",
    "description": {
      "en": "Low"
    }
  }
]Response error codes


Response error codes

BASE_0001 ,BASE_0020 | NOT_FOUND ,DATACOLLECTION_0027