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. |
| IsLast |
Is Last |
boolean |
None. |
| GroupId |
Form History Group Id |
integer |
None. |
| FormVersion |
Form History Version |
integer |
None. |
| Caption |
Schema caption |
string |
None. |
| Name |
Schema name |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"formId": "11a2b3b7-1f08-476e-b00b-49d733209857",
"formProperties": {
"cellPropertiesButton": true,
"signButton": true,
"markAsErrorButton": true,
"allowRemoveValues": true,
"openSessionBrowser": true,
"saveOnlyModifiedSignals": true,
"saveOnlySession": true,
"parameterViewerButton": true,
"openSessionMode": 1,
"previewButton": true,
"printButton": true
},
"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": "931aadd0-dde7-4cb7-942e-a69d24bbaaa3",
"frames": [
{
"frameId": "369fde6b-b2a6-48f8-9ec0-94a867a651b0",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "369fde6b-b2a6-48f8-9ec0-94a867a651b0",
"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": "931aadd0-dde7-4cb7-942e-a69d24bbaaa3",
"frames": [
{
"frameId": "369fde6b-b2a6-48f8-9ec0-94a867a651b0",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "369fde6b-b2a6-48f8-9ec0-94a867a651b0",
"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": "60e00555-8ddd-4959-9384-dbdc7f81fd81",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "61edf14c-8076-477f-9293-3c479f4b7a33",
"eventType": 1,
"sourceControlId": "64cc579a-2519-4725-a09d-ec5c3e184d12"
},
{
"id": "61edf14c-8076-477f-9293-3c479f4b7a33",
"eventType": 1,
"sourceControlId": "64cc579a-2519-4725-a09d-ec5c3e184d12"
}
]
},
{
"scriptId": "60e00555-8ddd-4959-9384-dbdc7f81fd81",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "61edf14c-8076-477f-9293-3c479f4b7a33",
"eventType": 1,
"sourceControlId": "64cc579a-2519-4725-a09d-ec5c3e184d12"
},
{
"id": "61edf14c-8076-477f-9293-3c479f4b7a33",
"eventType": 1,
"sourceControlId": "64cc579a-2519-4725-a09d-ec5c3e184d12"
}
]
}
],
"success": true,
"mobileNotifications": true,
"validationError": {
"errorCode": 1,
"description": "sample string 2",
"type": 0
},
"isLast": true,
"groupId": 1,
"formVersion": 1,
"caption": "sample string 3",
"name": "sample string 4"
},
{
"formId": "11a2b3b7-1f08-476e-b00b-49d733209857",
"formProperties": {
"cellPropertiesButton": true,
"signButton": true,
"markAsErrorButton": true,
"allowRemoveValues": true,
"openSessionBrowser": true,
"saveOnlyModifiedSignals": true,
"saveOnlySession": true,
"parameterViewerButton": true,
"openSessionMode": 1,
"previewButton": true,
"printButton": true
},
"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": "931aadd0-dde7-4cb7-942e-a69d24bbaaa3",
"frames": [
{
"frameId": "369fde6b-b2a6-48f8-9ec0-94a867a651b0",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "369fde6b-b2a6-48f8-9ec0-94a867a651b0",
"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": "931aadd0-dde7-4cb7-942e-a69d24bbaaa3",
"frames": [
{
"frameId": "369fde6b-b2a6-48f8-9ec0-94a867a651b0",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "369fde6b-b2a6-48f8-9ec0-94a867a651b0",
"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": "60e00555-8ddd-4959-9384-dbdc7f81fd81",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "61edf14c-8076-477f-9293-3c479f4b7a33",
"eventType": 1,
"sourceControlId": "64cc579a-2519-4725-a09d-ec5c3e184d12"
},
{
"id": "61edf14c-8076-477f-9293-3c479f4b7a33",
"eventType": 1,
"sourceControlId": "64cc579a-2519-4725-a09d-ec5c3e184d12"
}
]
},
{
"scriptId": "60e00555-8ddd-4959-9384-dbdc7f81fd81",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "61edf14c-8076-477f-9293-3c479f4b7a33",
"eventType": 1,
"sourceControlId": "64cc579a-2519-4725-a09d-ec5c3e184d12"
},
{
"id": "61edf14c-8076-477f-9293-3c479f4b7a33",
"eventType": 1,
"sourceControlId": "64cc579a-2519-4725-a09d-ec5c3e184d12"
}
]
}
],
"success": true,
"mobileNotifications": true,
"validationError": {
"errorCode": 1,
"description": "sample string 2",
"type": 0
},
"isLast": true,
"groupId": 1,
"formVersion": 1,
"caption": "sample string 3",
"name": "sample string 4"
}
]