|
Http Verb |
PATCH |
|---|---|
|
Url |
/documents/dynamic-forms/r1/option-groups/{optionGroupId} |
|
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 properties (description and/or active status) of an existing data collection option group. To update the selection options (model), use the PATCH /models endpoint instead.
Path Parameters
|
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
optionGroupId |
Long |
Yes |
The option group ID |
Request Body
Content-Type
application/json
Request payload fields
|
Field |
Type |
Required |
Validations |
Notes |
|---|---|---|---|---|
|
description |
Optional<LocalizedString> |
No |
@NotEmptyLocalizedItems |
Localized description of the option group |
|
active |
Optional<Boolean> |
No |
|
Indicates if the option group is active |
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