Skip to main content

Version: 22.10

POST Create Form Group

Create a form group that a user or task can be assigned to.

info

The Form Groups REST API Overview provides an introduction to this REST API, including information about:

  • Security (authentication and authorization)

Request

HTTP request

POST https://<JM_SERVER>/manager/secure/rest/form-groups/v1/

Request body

The POST request must contain a JSON structure describing the group. To support multiple parameters this API uses the HTTP Content Type: application/json.

The set of task JSON attributes is listed below. All attributes are optional unless otherwise indicated.

AttributeDescription
groupNameString
Required. A unique group name.
groupDescriptionString
The group description.
formWorkGroupboolean
An access control permission: whether to share the form with work group members.
newFormboolean
An access control permission: whether to allow users to open new forms.
savedFormboolean
An access control permission: whether to allow users to open saved work group forms and group assigned tasks.
completedFormboolean
An access control permission: whether to allow users to view completed form group submissions.
taskAssignboolean
An access control permission: whether to allow users to reassign tasks to other users.

Example

The following example illustrates how to create a form group.

Ensure you specify Content-Type: application/json.

POST /manager/secure/rest/form-groups/v1/ HTTP/1.1
Host: https://transact.maguire.com
Content-Type: application/json

{
"groupName": "Acme Applicant Group",
"groupDescription": "Acme Corporation Applicants Group",
"formWorkGroup": true,
"newForm": false,
"savedForm": true,
"completedForm": true,
"taskAssign": false
}

Response

If successful, this operation returns a response with a HTTP 200 OK status code.

Example

An example succcessful response is shown below.

{
"id": 52,
"groupName": "Acme Applicant Group",
"groupDescription": "Acme Corporation Applicants Group",
"formWorkGroup": true,
"newForm": false,
"savedForm": true,
"completedForm": true,
"taskAssign": false
}