POST api/forms/create?location={location}&formLayout={formLayout}&creator={creator}&isDraft={isDraft}&enforceMandatory={enforceMandatory}

Submits a new form to the site.

Request Information

URI Parameters

Name	Description	Type	Additional information
location	The ID of the destination / parent item.	integer	Required
formLayout	The GUID, or exact name of the form layout.	string	Required
creator	The username of the user who will be marked as the submitter of this form.	string	Default value is
isDraft	Flag indicating if this form is a draft.	boolean	Default value is False
enforceMandatory	Flag indicating if this form is to enforce mandatory fields	boolean	Default value is False

Body Parameters

The form metadata.

Collection of MetaField

Name	Description	Type	Additional information
GUID	unique GUID for this field	string	None.
iteration	The iteration (index of parent element)	integer	None.
index	The groupIndex (zero-based row index) of this value	integer	None.
entryGUID	Entry/row GUID for this field	string	None.
label	Field label (note a form may have the same label repeated so GUID is the only safe unique identifier)	string	None.
values	Array of values, most fields will have a single value here but certain fields like checkboxes may have multiple values	Collection of MetaValue	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "GUID": "sample string 1",
    "iteration": 2,
    "index": 3,
    "entryGUID": "sample string 4",
    "label": "sample string 5",
    "values": [
      {
        "value": "sample string 1",
        "attributeid": 2,
        "fileID": 3,
        "userID": 4,
        "userGroupID": 5,
        "associatedItemID": 6,
        "other": true,
        "roleID": 8,
        "matrixID": 9,
        "matrixVersion": "sample string 10",
        "matrixName": "sample string 11",
        "tableGUID": "sample string 12",
        "matrixDisplayName": "sample string 13",
        "groupIdx": 14
      },
      {
        "value": "sample string 1",
        "attributeid": 2,
        "fileID": 3,
        "userID": 4,
        "userGroupID": 5,
        "associatedItemID": 6,
        "other": true,
        "roleID": 8,
        "matrixID": 9,
        "matrixVersion": "sample string 10",
        "matrixName": "sample string 11",
        "tableGUID": "sample string 12",
        "matrixDisplayName": "sample string 13",
        "groupIdx": 14
      }
    ]
  },
  {
    "GUID": "sample string 1",
    "iteration": 2,
    "index": 3,
    "entryGUID": "sample string 4",
    "label": "sample string 5",
    "values": [
      {
        "value": "sample string 1",
        "attributeid": 2,
        "fileID": 3,
        "userID": 4,
        "userGroupID": 5,
        "associatedItemID": 6,
        "other": true,
        "roleID": 8,
        "matrixID": 9,
        "matrixVersion": "sample string 10",
        "matrixName": "sample string 11",
        "tableGUID": "sample string 12",
        "matrixDisplayName": "sample string 13",
        "groupIdx": 14
      },
      {
        "value": "sample string 1",
        "attributeid": 2,
        "fileID": 3,
        "userID": 4,
        "userGroupID": 5,
        "associatedItemID": 6,
        "other": true,
        "roleID": 8,
        "matrixID": 9,
        "matrixVersion": "sample string 10",
        "matrixName": "sample string 11",
        "tableGUID": "sample string 12",
        "matrixDisplayName": "sample string 13",
        "groupIdx": 14
      }
    ]
  }
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

NewFormDTO

Name	Description	Type	Additional information
i_node	The i_node of the newly created Form.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "i_node": 1
}