|
Http Verb |
PATCH |
|---|---|
|
Url |
/documents/dynamic-forms/r1/option-groups/{optionGroupId}/models |
|
Permissions required |
FSM_DATACOLLECTION_MODULE, FSM_DATACOLLECTION_CONFIGURATION_EDIT |
|
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 updates the model (selection options) of an existing data collection option group. The entire list of selection options is replaced with the provided list. Missing translations are automatically added for all configured languages.
Path Parameters
|
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
optionGroupId |
Long |
Yes |
The option group ID |
Request Body
Content-Type
application/json
Request payload fields
Array of selection options:
|
Field |
Type |
Required |
Validations |
Notes |
|---|---|---|---|---|
|
code |
String |
Yes |
|
Unique code for the selection option |
|
description |
LocalizedString |
Yes |
|
Localized description of the selection option |
Header Parameters
Default.
Response documentation
Response Status Code
204 No Content
Response error codes
BASE_0001 ,BASE_0020 | NOT_FOUND ,BASE_0006 ,BASE_0007 ,DATACOLLECTION_0027