|
Http Verb |
GET |
|---|---|
|
Url |
/documents/dynamic-forms/r1/option-groups/{optionGroupId} |
|
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 a specific data collection option group by its ID.
Path Parameters
|
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
optionGroupId |
Long |
Yes |
The option group ID |
Query String Parameters
Language ℹ️
Default: User's language
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 |
Response Body:
{
"id": 1,
"description": {
"en": "Priority Levels",
"it": "Livelli di Priorità"
},
"model": "[{\"value\":\"high\",\"description\":{\"en\":\"High\",\"it\":\"Alto\"}}]",
"active": true
}
Response error codes
BASE_0020 | NOT_FOUND ,DATACOLLECTION_0027