GET API/V1/FormSchema

Request Information

URI Parameters

Name	Description	Type	Additional information
GetLastForm	Should last form be retrieved	boolean	None.
FormId	The form id	globally unique identifier	None.
FormName	The form name	string	None.

Body Parameters

None.

Response Information

Resource Description

iMDsoft.API.Metavision.Data.Forms.FormSchema

Name	Description	Type	Additional information
FormId	Form id	globally unique identifier	None.
FormProperties	Form properties	iMDsoft.API.Metavision.Data.Forms.FormProperties	None.
FormButtons	Form buttons which are outside of the tabs and frames	Collection of iMDsoft.API.Metavision.Data.Forms.MenuItem	None.
Tabs	Form tabs	Collection of iMDsoft.API.Metavision.Data.Forms.FormTab	None.
Scripts	Form scripts	Collection of iMDsoft.API.Metavision.Data.Forms.FormScript	None.
Success	Is request successful	boolean	None.
MobileNotifications	Set for Mobile notifications	boolean	None.
ValidationError	Validation error	iMDsoft.API.Metavision.Data.Forms.ValidationError	None.
IsLast	Is Last	boolean	None.
GroupId	Form History Group Id	integer	None.
FormVersion	Form History Version	integer	None.
Caption	Schema caption	string	None.
Name	Schema name	string	None.

Response Formats

application/json, text/json

Sample:

{
  "formId": "e3ce3494-4dd6-4677-9abf-231def21ba51",
  "formProperties": {
    "cellPropertiesButton": true,
    "signButton": true,
    "markAsErrorButton": true,
    "allowRemoveValues": true,
    "openSessionBrowser": true,
    "saveOnlyModifiedSignals": true,
    "saveOnlySession": true,
    "parameterViewerButton": true,
    "openSessionMode": 1,
    "previewButton": true,
    "printButton": true
  },
  "formButtons": [
    {
      "title": "sample string 1",
      "icon": "sample string 2",
      "type": 0,
      "isDataDriven": true,
      "parameters": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "title": "sample string 1",
      "icon": "sample string 2",
      "type": 0,
      "isDataDriven": true,
      "parameters": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "tabs": [
    {
      "tabId": "dc86d73a-54d2-43a9-885d-0de38dd81b09",
      "frames": [
        {
          "frameId": "de17efa1-2d9b-48f8-ac5e-ef390a260766",
          "controls": null,
          "name": "sample string 2",
          "indexInTab": 3,
          "isComment": true,
          "scriptName": "sample string 5"
        },
        {
          "frameId": "de17efa1-2d9b-48f8-ac5e-ef390a260766",
          "controls": null,
          "name": "sample string 2",
          "indexInTab": 3,
          "isComment": true,
          "scriptName": "sample string 5"
        }
      ],
      "name": "sample string 2",
      "indexInForm": 3,
      "scriptName": "sample string 4"
    },
    {
      "tabId": "dc86d73a-54d2-43a9-885d-0de38dd81b09",
      "frames": [
        {
          "frameId": "de17efa1-2d9b-48f8-ac5e-ef390a260766",
          "controls": null,
          "name": "sample string 2",
          "indexInTab": 3,
          "isComment": true,
          "scriptName": "sample string 5"
        },
        {
          "frameId": "de17efa1-2d9b-48f8-ac5e-ef390a260766",
          "controls": null,
          "name": "sample string 2",
          "indexInTab": 3,
          "isComment": true,
          "scriptName": "sample string 5"
        }
      ],
      "name": "sample string 2",
      "indexInForm": 3,
      "scriptName": "sample string 4"
    }
  ],
  "scripts": [
    {
      "scriptId": "add116a0-589a-4990-803b-f2a50b8d1a82",
      "name": "sample string 2",
      "parameters": "sample string 3",
      "vbScript": "sample string 4",
      "javaScript": "sample string 5",
      "events": [
        {
          "id": "4aba651e-a294-4867-9bcf-27bcdc8dc257",
          "eventType": 1,
          "sourceControlId": "bdf7d25f-74bc-42d5-ab2b-0104b44108a2"
        },
        {
          "id": "4aba651e-a294-4867-9bcf-27bcdc8dc257",
          "eventType": 1,
          "sourceControlId": "bdf7d25f-74bc-42d5-ab2b-0104b44108a2"
        }
      ]
    },
    {
      "scriptId": "add116a0-589a-4990-803b-f2a50b8d1a82",
      "name": "sample string 2",
      "parameters": "sample string 3",
      "vbScript": "sample string 4",
      "javaScript": "sample string 5",
      "events": [
        {
          "id": "4aba651e-a294-4867-9bcf-27bcdc8dc257",
          "eventType": 1,
          "sourceControlId": "bdf7d25f-74bc-42d5-ab2b-0104b44108a2"
        },
        {
          "id": "4aba651e-a294-4867-9bcf-27bcdc8dc257",
          "eventType": 1,
          "sourceControlId": "bdf7d25f-74bc-42d5-ab2b-0104b44108a2"
        }
      ]
    }
  ],
  "success": true,
  "mobileNotifications": true,
  "validationError": {
    "errorCode": 1,
    "description": "sample string 2",
    "type": 0
  },
  "isLast": true,
  "groupId": 1,
  "formVersion": 1,
  "caption": "sample string 3",
  "name": "sample string 4"
}