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": "253c1860-003b-4d59-98fd-c82422abd2d7", "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": "8fbb50ea-dfef-42a3-a88b-b9847926dd91", "frames": [ { "frameId": "f0f759d1-5845-4fc7-911a-7f4f7e838980", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "f0f759d1-5845-4fc7-911a-7f4f7e838980", "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": "8fbb50ea-dfef-42a3-a88b-b9847926dd91", "frames": [ { "frameId": "f0f759d1-5845-4fc7-911a-7f4f7e838980", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "f0f759d1-5845-4fc7-911a-7f4f7e838980", "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": "d7642f35-0216-41d8-8161-97b243159479", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "2e866fa0-9a12-4e00-865d-3666449b39de", "eventType": 1, "sourceControlId": "97443ecb-5634-4635-9b54-b2894e4544de" }, { "id": "2e866fa0-9a12-4e00-865d-3666449b39de", "eventType": 1, "sourceControlId": "97443ecb-5634-4635-9b54-b2894e4544de" } ] }, { "scriptId": "d7642f35-0216-41d8-8161-97b243159479", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "2e866fa0-9a12-4e00-865d-3666449b39de", "eventType": 1, "sourceControlId": "97443ecb-5634-4635-9b54-b2894e4544de" }, { "id": "2e866fa0-9a12-4e00-865d-3666449b39de", "eventType": 1, "sourceControlId": "97443ecb-5634-4635-9b54-b2894e4544de" } ] } ], "success": true, "mobileNotifications": true, "validationError": { "errorCode": 1, "description": "sample string 2", "type": 0 }, "caption": "sample string 3", "name": "sample string 4" }, { "formId": "253c1860-003b-4d59-98fd-c82422abd2d7", "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": "8fbb50ea-dfef-42a3-a88b-b9847926dd91", "frames": [ { "frameId": "f0f759d1-5845-4fc7-911a-7f4f7e838980", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "f0f759d1-5845-4fc7-911a-7f4f7e838980", "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": "8fbb50ea-dfef-42a3-a88b-b9847926dd91", "frames": [ { "frameId": "f0f759d1-5845-4fc7-911a-7f4f7e838980", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "f0f759d1-5845-4fc7-911a-7f4f7e838980", "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": "d7642f35-0216-41d8-8161-97b243159479", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "2e866fa0-9a12-4e00-865d-3666449b39de", "eventType": 1, "sourceControlId": "97443ecb-5634-4635-9b54-b2894e4544de" }, { "id": "2e866fa0-9a12-4e00-865d-3666449b39de", "eventType": 1, "sourceControlId": "97443ecb-5634-4635-9b54-b2894e4544de" } ] }, { "scriptId": "d7642f35-0216-41d8-8161-97b243159479", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "2e866fa0-9a12-4e00-865d-3666449b39de", "eventType": 1, "sourceControlId": "97443ecb-5634-4635-9b54-b2894e4544de" }, { "id": "2e866fa0-9a12-4e00-865d-3666449b39de", "eventType": 1, "sourceControlId": "97443ecb-5634-4635-9b54-b2894e4544de" } ] } ], "success": true, "mobileNotifications": true, "validationError": { "errorCode": 1, "description": "sample string 2", "type": 0 }, "caption": "sample string 3", "name": "sample string 4" } ]