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": "9f4043ea-0ba4-457e-8f62-eccbbc65df6c", "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": "f058ff7a-debb-49cc-acc4-c425dc8420fa", "frames": [ { "frameId": "212cb301-258e-4091-992a-cb373c5ce068", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "212cb301-258e-4091-992a-cb373c5ce068", "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": "f058ff7a-debb-49cc-acc4-c425dc8420fa", "frames": [ { "frameId": "212cb301-258e-4091-992a-cb373c5ce068", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "212cb301-258e-4091-992a-cb373c5ce068", "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": "d0ab82a2-3ad0-4292-bead-f576d0016731", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "297ea361-4e70-4bc4-8c22-039d6faeea5f", "eventType": 1, "sourceControlId": "f4deeb9e-a0de-43dd-9954-9a22904fae56" }, { "id": "297ea361-4e70-4bc4-8c22-039d6faeea5f", "eventType": 1, "sourceControlId": "f4deeb9e-a0de-43dd-9954-9a22904fae56" } ] }, { "scriptId": "d0ab82a2-3ad0-4292-bead-f576d0016731", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "297ea361-4e70-4bc4-8c22-039d6faeea5f", "eventType": 1, "sourceControlId": "f4deeb9e-a0de-43dd-9954-9a22904fae56" }, { "id": "297ea361-4e70-4bc4-8c22-039d6faeea5f", "eventType": 1, "sourceControlId": "f4deeb9e-a0de-43dd-9954-9a22904fae56" } ] } ], "success": true, "mobileNotifications": true, "validationError": { "errorCode": 1, "description": "sample string 2", "type": 0 }, "caption": "sample string 3", "name": "sample string 4" }