|
Http Verb |
POST |
|---|---|
|
Url |
/documents/dynamic-forms/r1/option-groups |
|
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 creates a new data collection option group. The model (selection options) is initialized as an empty array and can be populated later using the PATCH /models endpoint.
Request Body
Content-Type
application/json
Request payload fields
|
Field |
Type |
Required |
Validations |
Notes |
|---|---|---|---|---|
|
description |
LocalizedString |
Yes |
@NotNull, @NotEmptyLocalizedItems |
Localized description of the option group |
|
active |
Boolean |
Yes |
@NotNull |
Default: true. Indicates if the option group is active |
Header Parameters
Default.
Response documentation
Response Status Code
201 Created
Response Headers
Location: /documents/dynamic-forms/r1/option-groups/{id}
Response payload fields
|
Field |
Notes |
|---|---|
|
id |
The ID of the newly created option group |
Response error codes
BASE_0001 ,BASE_0020 | NOT_FOUND,BASE_0006 ,BASE_0007 ,DATACOLLECTION_0027