GET API/V1/FormSchemas
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of 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": "65cd914d-d963-4e74-b133-7947c96dee28", "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": "dfa4e076-7c14-4059-ac2d-edaaec69410d", "frames": [ { "frameId": "a9b5deaf-bfb5-4c95-80ae-ebdb8c3ec7e7", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "a9b5deaf-bfb5-4c95-80ae-ebdb8c3ec7e7", "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": "dfa4e076-7c14-4059-ac2d-edaaec69410d", "frames": [ { "frameId": "a9b5deaf-bfb5-4c95-80ae-ebdb8c3ec7e7", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "a9b5deaf-bfb5-4c95-80ae-ebdb8c3ec7e7", "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": "520f924b-f20c-44ef-bb83-ce4f8f880636", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "eec1ddb8-6446-4bf5-8b0c-4d16fa52a39d", "eventType": 1, "sourceControlId": "1b5f83c6-45cb-41a0-a15e-03e13f5f3328" }, { "id": "eec1ddb8-6446-4bf5-8b0c-4d16fa52a39d", "eventType": 1, "sourceControlId": "1b5f83c6-45cb-41a0-a15e-03e13f5f3328" } ] }, { "scriptId": "520f924b-f20c-44ef-bb83-ce4f8f880636", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "eec1ddb8-6446-4bf5-8b0c-4d16fa52a39d", "eventType": 1, "sourceControlId": "1b5f83c6-45cb-41a0-a15e-03e13f5f3328" }, { "id": "eec1ddb8-6446-4bf5-8b0c-4d16fa52a39d", "eventType": 1, "sourceControlId": "1b5f83c6-45cb-41a0-a15e-03e13f5f3328" } ] } ], "success": true, "mobileNotifications": true, "validationError": { "errorCode": 1, "description": "sample string 2", "type": 0 }, "caption": "sample string 3", "name": "sample string 4" }, { "formId": "65cd914d-d963-4e74-b133-7947c96dee28", "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": "dfa4e076-7c14-4059-ac2d-edaaec69410d", "frames": [ { "frameId": "a9b5deaf-bfb5-4c95-80ae-ebdb8c3ec7e7", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "a9b5deaf-bfb5-4c95-80ae-ebdb8c3ec7e7", "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": "dfa4e076-7c14-4059-ac2d-edaaec69410d", "frames": [ { "frameId": "a9b5deaf-bfb5-4c95-80ae-ebdb8c3ec7e7", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "a9b5deaf-bfb5-4c95-80ae-ebdb8c3ec7e7", "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": "520f924b-f20c-44ef-bb83-ce4f8f880636", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "eec1ddb8-6446-4bf5-8b0c-4d16fa52a39d", "eventType": 1, "sourceControlId": "1b5f83c6-45cb-41a0-a15e-03e13f5f3328" }, { "id": "eec1ddb8-6446-4bf5-8b0c-4d16fa52a39d", "eventType": 1, "sourceControlId": "1b5f83c6-45cb-41a0-a15e-03e13f5f3328" } ] }, { "scriptId": "520f924b-f20c-44ef-bb83-ce4f8f880636", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "eec1ddb8-6446-4bf5-8b0c-4d16fa52a39d", "eventType": 1, "sourceControlId": "1b5f83c6-45cb-41a0-a15e-03e13f5f3328" }, { "id": "eec1ddb8-6446-4bf5-8b0c-4d16fa52a39d", "eventType": 1, "sourceControlId": "1b5f83c6-45cb-41a0-a15e-03e13f5f3328" } ] } ], "success": true, "mobileNotifications": true, "validationError": { "errorCode": 1, "description": "sample string 2", "type": 0 }, "caption": "sample string 3", "name": "sample string 4" } ]