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": "38e8c286-aff0-4f32-a3ab-992d51a46196", "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": "a06fed74-c1ff-42b8-a827-7ab6f57494ef", "frames": [ { "frameId": "be1639e6-7dbf-4e8b-8056-d2d0fd398797", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "be1639e6-7dbf-4e8b-8056-d2d0fd398797", "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": "a06fed74-c1ff-42b8-a827-7ab6f57494ef", "frames": [ { "frameId": "be1639e6-7dbf-4e8b-8056-d2d0fd398797", "controls": null, "name": "sample string 2", "indexInTab": 3, "isComment": true, "scriptName": "sample string 5" }, { "frameId": "be1639e6-7dbf-4e8b-8056-d2d0fd398797", "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": "41dfe4a6-3e30-48ef-a471-4c77a536c653", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "727bf54a-050d-43ae-bb0e-528370caa3a5", "eventType": 1, "sourceControlId": "992d1a09-0bdb-4824-9062-e26bc95f9785" }, { "id": "727bf54a-050d-43ae-bb0e-528370caa3a5", "eventType": 1, "sourceControlId": "992d1a09-0bdb-4824-9062-e26bc95f9785" } ] }, { "scriptId": "41dfe4a6-3e30-48ef-a471-4c77a536c653", "name": "sample string 2", "parameters": "sample string 3", "vbScript": "sample string 4", "javaScript": "sample string 5", "events": [ { "id": "727bf54a-050d-43ae-bb0e-528370caa3a5", "eventType": 1, "sourceControlId": "992d1a09-0bdb-4824-9062-e26bc95f9785" }, { "id": "727bf54a-050d-43ae-bb0e-528370caa3a5", "eventType": 1, "sourceControlId": "992d1a09-0bdb-4824-9062-e26bc95f9785" } ] } ], "success": true, "mobileNotifications": true, "validationError": { "errorCode": 1, "description": "sample string 2", "type": 0 }, "caption": "sample string 3", "name": "sample string 4" }