GET API/V1/FormSchemas
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of iMDsoft.API.Metavision.Data.Forms.FormSchema| Name | 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": "ce9f75fb-3886-4647-89dd-deea30c16051",
"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": "9051e853-dc77-410a-bc1c-43702858b4f2",
"frames": [
{
"frameId": "431508fc-56be-46a8-b0a9-a8b04c16e3d1",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "431508fc-56be-46a8-b0a9-a8b04c16e3d1",
"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": "9051e853-dc77-410a-bc1c-43702858b4f2",
"frames": [
{
"frameId": "431508fc-56be-46a8-b0a9-a8b04c16e3d1",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "431508fc-56be-46a8-b0a9-a8b04c16e3d1",
"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": "6b0fa31e-1108-41cf-92a7-b88124418b06",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "a7cf2b35-63b7-4d4a-8936-a337a1e25b24",
"eventType": 1,
"sourceControlId": "4a85443e-3727-4be4-97da-f84b2647bf6b"
},
{
"id": "a7cf2b35-63b7-4d4a-8936-a337a1e25b24",
"eventType": 1,
"sourceControlId": "4a85443e-3727-4be4-97da-f84b2647bf6b"
}
]
},
{
"scriptId": "6b0fa31e-1108-41cf-92a7-b88124418b06",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "a7cf2b35-63b7-4d4a-8936-a337a1e25b24",
"eventType": 1,
"sourceControlId": "4a85443e-3727-4be4-97da-f84b2647bf6b"
},
{
"id": "a7cf2b35-63b7-4d4a-8936-a337a1e25b24",
"eventType": 1,
"sourceControlId": "4a85443e-3727-4be4-97da-f84b2647bf6b"
}
]
}
],
"success": true,
"mobileNotifications": true,
"validationError": {
"errorCode": 1,
"description": "sample string 2",
"type": 0
},
"caption": "sample string 3",
"name": "sample string 4"
},
{
"formId": "ce9f75fb-3886-4647-89dd-deea30c16051",
"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": "9051e853-dc77-410a-bc1c-43702858b4f2",
"frames": [
{
"frameId": "431508fc-56be-46a8-b0a9-a8b04c16e3d1",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "431508fc-56be-46a8-b0a9-a8b04c16e3d1",
"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": "9051e853-dc77-410a-bc1c-43702858b4f2",
"frames": [
{
"frameId": "431508fc-56be-46a8-b0a9-a8b04c16e3d1",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "431508fc-56be-46a8-b0a9-a8b04c16e3d1",
"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": "6b0fa31e-1108-41cf-92a7-b88124418b06",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "a7cf2b35-63b7-4d4a-8936-a337a1e25b24",
"eventType": 1,
"sourceControlId": "4a85443e-3727-4be4-97da-f84b2647bf6b"
},
{
"id": "a7cf2b35-63b7-4d4a-8936-a337a1e25b24",
"eventType": 1,
"sourceControlId": "4a85443e-3727-4be4-97da-f84b2647bf6b"
}
]
},
{
"scriptId": "6b0fa31e-1108-41cf-92a7-b88124418b06",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "a7cf2b35-63b7-4d4a-8936-a337a1e25b24",
"eventType": 1,
"sourceControlId": "4a85443e-3727-4be4-97da-f84b2647bf6b"
},
{
"id": "a7cf2b35-63b7-4d4a-8936-a337a1e25b24",
"eventType": 1,
"sourceControlId": "4a85443e-3727-4be4-97da-f84b2647bf6b"
}
]
}
],
"success": true,
"mobileNotifications": true,
"validationError": {
"errorCode": 1,
"description": "sample string 2",
"type": 0
},
"caption": "sample string 3",
"name": "sample string 4"
}
]