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.FormSchemaName | 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. |
Caption |
Schema caption |
string |
None. |
Name |
Schema name |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "formId": "cafc7a72-418e-48a7-8b72-4c550197a458", "formProperties": { "cellPropertiesButton": true, "signButton": true, "markAsErrorButton": true, "allowRemoveValues": true, "openSessionBrowser": true, "saveOnlyModifiedSignals": true, "saveOnlySession": true, "parameterViewerButton": true, "openSessionMode": 1 }, "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": "11af37f7-f353-4d50-8ca0-d90c9e4be080", "frames": [ { "frameId": "fb18016d-5380-4cf3-8a28-02da4f7ab265", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "fb18016d-5380-4cf3-8a28-02da4f7ab265", "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": "11af37f7-f353-4d50-8ca0-d90c9e4be080", "frames": [ { "frameId": "fb18016d-5380-4cf3-8a28-02da4f7ab265", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "fb18016d-5380-4cf3-8a28-02da4f7ab265", "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": "4f0c04cd-2f5c-4afb-afb4-8c32bc21db8d", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "ca421a32-3510-4a99-a39d-650f85c91a89", "eventType": 1, "sourceControlId": "8f80aecf-f115-4f88-9687-e25e86183461" }, { "id": "ca421a32-3510-4a99-a39d-650f85c91a89", "eventType": 1, "sourceControlId": "8f80aecf-f115-4f88-9687-e25e86183461" } ] }, { "scriptId": "4f0c04cd-2f5c-4afb-afb4-8c32bc21db8d", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "ca421a32-3510-4a99-a39d-650f85c91a89", "eventType": 1, "sourceControlId": "8f80aecf-f115-4f88-9687-e25e86183461" }, { "id": "ca421a32-3510-4a99-a39d-650f85c91a89", "eventType": 1, "sourceControlId": "8f80aecf-f115-4f88-9687-e25e86183461" } ] } ], "success": true, "mobileNotifications": true, "validationError": { "errorCode": 1, "description": "sample string 2", "type": 0 }, "caption": "sample string 3", "name": "sample string 4" }