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

Validates and attempts to create a form based on the provided layout and field data.

Request Information

URI Parameters

Name	Description	Type	Additional information
location	The ID of the parent item (location) where the form should be created.	integer	Required
formLayout	The name or identifier of the form layout to use.	string	Required
creator	(Optional) The username of the form creator. If not provided, the current user is assumed.	string	Default value is
isDraft	(Optional) Indicates whether the form is being saved as a draft. Defaults to false.	boolean	Default value is False
enforceMandatory	(Optional) If true, the system will enforce mandatory field validation. Defaults to false.	boolean	Default value is False

Body Parameters

A list of form fields and their values to be validated and submitted.

Collection of FormData

Name	Type	Additional information
mandatorySetByDependency	integer	None.
GUID	string	None.
iteration	integer	None.
index	integer	None.
entryGUID	string	None.
label	string	None.
values	Collection of FormValueData	None.
items	Collection of FormData	None.
uploadStatus	string	None.
levelValues	Dictionary of string [key] and FormLevelValues [value]	None.
roleData	Collection of FormRoleData	None.
validationStatus	string	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",
        "matrixValueID": 2,
        "attributeid": 3,
        "fileID": 4,
        "userID": 5,
        "userGroupID": 6,
        "associatedItemID": 7,
        "other": true,
        "roleID": 9,
        "matrixID": 10,
        "matrixVersion": "sample string 11",
        "matrixName": "sample string 12",
        "tableGUID": "sample string 13",
        "matrixDisplayName": "sample string 14",
        "groupIdx": 15,
        "sourceEntryGUID": "sample string 16",
        "optIdx": 17,
        "dispValue": "sample string 18",
        "mapperID": 19,
        "dateSourceValue": "sample string 20",
        "dateSourceValueEnd": "sample string 21",
        "tagID": 22
      },
      {
        "value": "sample string 1",
        "matrixValueID": 2,
        "attributeid": 3,
        "fileID": 4,
        "userID": 5,
        "userGroupID": 6,
        "associatedItemID": 7,
        "other": true,
        "roleID": 9,
        "matrixID": 10,
        "matrixVersion": "sample string 11",
        "matrixName": "sample string 12",
        "tableGUID": "sample string 13",
        "matrixDisplayName": "sample string 14",
        "groupIdx": 15,
        "sourceEntryGUID": "sample string 16",
        "optIdx": 17,
        "dispValue": "sample string 18",
        "mapperID": 19,
        "dateSourceValue": "sample string 20",
        "dateSourceValueEnd": "sample string 21",
        "tagID": 22
      }
    ],
    "items": [],
    "uploadStatus": "sample string 6",
    "levelValues": {
      "sample string 1": {
        "GUID": "sample string 1",
        "label": "sample string 2",
        "values": [
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          },
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          }
        ]
      },
      "sample string 2": {
        "GUID": "sample string 1",
        "label": "sample string 2",
        "values": [
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          },
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          }
        ]
      }
    },
    "roleData": [
      {
        "rate": 1.1,
        "role": "sample string 2",
        "roleID": 3,
        "userID": 4,
        "value": "sample string 5"
      },
      {
        "rate": 1.1,
        "role": "sample string 2",
        "roleID": 3,
        "userID": 4,
        "value": "sample string 5"
      }
    ],
    "validationStatus": "sample string 7",
    "mandatorySetByDependency": 1
  },
  {
    "GUID": "sample string 1",
    "iteration": 2,
    "index": 3,
    "entryGUID": "sample string 4",
    "label": "sample string 5",
    "values": [
      {
        "value": "sample string 1",
        "matrixValueID": 2,
        "attributeid": 3,
        "fileID": 4,
        "userID": 5,
        "userGroupID": 6,
        "associatedItemID": 7,
        "other": true,
        "roleID": 9,
        "matrixID": 10,
        "matrixVersion": "sample string 11",
        "matrixName": "sample string 12",
        "tableGUID": "sample string 13",
        "matrixDisplayName": "sample string 14",
        "groupIdx": 15,
        "sourceEntryGUID": "sample string 16",
        "optIdx": 17,
        "dispValue": "sample string 18",
        "mapperID": 19,
        "dateSourceValue": "sample string 20",
        "dateSourceValueEnd": "sample string 21",
        "tagID": 22
      },
      {
        "value": "sample string 1",
        "matrixValueID": 2,
        "attributeid": 3,
        "fileID": 4,
        "userID": 5,
        "userGroupID": 6,
        "associatedItemID": 7,
        "other": true,
        "roleID": 9,
        "matrixID": 10,
        "matrixVersion": "sample string 11",
        "matrixName": "sample string 12",
        "tableGUID": "sample string 13",
        "matrixDisplayName": "sample string 14",
        "groupIdx": 15,
        "sourceEntryGUID": "sample string 16",
        "optIdx": 17,
        "dispValue": "sample string 18",
        "mapperID": 19,
        "dateSourceValue": "sample string 20",
        "dateSourceValueEnd": "sample string 21",
        "tagID": 22
      }
    ],
    "items": [],
    "uploadStatus": "sample string 6",
    "levelValues": {
      "sample string 1": {
        "GUID": "sample string 1",
        "label": "sample string 2",
        "values": [
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          },
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          }
        ]
      },
      "sample string 2": {
        "GUID": "sample string 1",
        "label": "sample string 2",
        "values": [
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          },
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          }
        ]
      }
    },
    "roleData": [
      {
        "rate": 1.1,
        "role": "sample string 2",
        "roleID": 3,
        "userID": 4,
        "value": "sample string 5"
      },
      {
        "rate": 1.1,
        "role": "sample string 2",
        "roleID": 3,
        "userID": 4,
        "value": "sample string 5"
      }
    ],
    "validationStatus": "sample string 7",
    "mandatorySetByDependency": 1
  }
]

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'.

application/scim+json

Sample:

An exception has occurred while using the formatter 'SCIMMediaTypeFormatter' to generate sample for media type 'application/scim+json'. Exception message: Self referencing loop detected with type 'SDAPI.FormData'. Path '[0].items'.

Response Information

Resource Description

On success: HTTP 200 OK with the created form object. On failure: HTTP 400 Bad Request with a specific validation error message.

NewFormDTO

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

Response Formats

application/json, text/json, application/scim+json

Sample:

{
  "i_node": 1
}