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": "4e3df621-e456-46f5-bb32-ac0beaef775a", "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": "b3fd8ab7-5dbb-40cd-bdb1-72eaa8372657", "frames": [ { "frameId": "925db6f5-2e3f-4abf-b7d3-9829acf7025e", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "925db6f5-2e3f-4abf-b7d3-9829acf7025e", "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": "b3fd8ab7-5dbb-40cd-bdb1-72eaa8372657", "frames": [ { "frameId": "925db6f5-2e3f-4abf-b7d3-9829acf7025e", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "925db6f5-2e3f-4abf-b7d3-9829acf7025e", "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": "a2a955ef-42d9-4d72-8389-a4a79c5c3dab", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "0e408b64-e879-4b27-8c0f-f6fd75148587", "eventType": 1, "sourceControlId": "40855d56-f377-42fa-9ca7-57be38a96b2e" }, { "id": "0e408b64-e879-4b27-8c0f-f6fd75148587", "eventType": 1, "sourceControlId": "40855d56-f377-42fa-9ca7-57be38a96b2e" } ] }, { "scriptId": "a2a955ef-42d9-4d72-8389-a4a79c5c3dab", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "0e408b64-e879-4b27-8c0f-f6fd75148587", "eventType": 1, "sourceControlId": "40855d56-f377-42fa-9ca7-57be38a96b2e" }, { "id": "0e408b64-e879-4b27-8c0f-f6fd75148587", "eventType": 1, "sourceControlId": "40855d56-f377-42fa-9ca7-57be38a96b2e" } ] } ], "success": true, "mobileNotifications": true, "validationError": { "errorCode": 1, "description": "sample string 2", "type": 0 }, "caption": "sample string 3", "name": "sample string 4" }, { "formId": "4e3df621-e456-46f5-bb32-ac0beaef775a", "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": "b3fd8ab7-5dbb-40cd-bdb1-72eaa8372657", "frames": [ { "frameId": "925db6f5-2e3f-4abf-b7d3-9829acf7025e", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "925db6f5-2e3f-4abf-b7d3-9829acf7025e", "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": "b3fd8ab7-5dbb-40cd-bdb1-72eaa8372657", "frames": [ { "frameId": "925db6f5-2e3f-4abf-b7d3-9829acf7025e", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "925db6f5-2e3f-4abf-b7d3-9829acf7025e", "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": "a2a955ef-42d9-4d72-8389-a4a79c5c3dab", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "0e408b64-e879-4b27-8c0f-f6fd75148587", "eventType": 1, "sourceControlId": "40855d56-f377-42fa-9ca7-57be38a96b2e" }, { "id": "0e408b64-e879-4b27-8c0f-f6fd75148587", "eventType": 1, "sourceControlId": "40855d56-f377-42fa-9ca7-57be38a96b2e" } ] }, { "scriptId": "a2a955ef-42d9-4d72-8389-a4a79c5c3dab", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "0e408b64-e879-4b27-8c0f-f6fd75148587", "eventType": 1, "sourceControlId": "40855d56-f377-42fa-9ca7-57be38a96b2e" }, { "id": "0e408b64-e879-4b27-8c0f-f6fd75148587", "eventType": 1, "sourceControlId": "40855d56-f377-42fa-9ca7-57be38a96b2e" } ] } ], "success": true, "mobileNotifications": true, "validationError": { "errorCode": 1, "description": "sample string 2", "type": 0 }, "caption": "sample string 3", "name": "sample string 4" } ]