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.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": "bb225b3c-6168-41db-9e95-28fce87bfd08",
"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": "d2d2ecb6-0ea8-41ff-b5b3-e4c40f47ec18",
"frames": [
{
"frameId": "25d0cc9d-59a7-44f6-9334-c3c3418763af",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "25d0cc9d-59a7-44f6-9334-c3c3418763af",
"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": "d2d2ecb6-0ea8-41ff-b5b3-e4c40f47ec18",
"frames": [
{
"frameId": "25d0cc9d-59a7-44f6-9334-c3c3418763af",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "25d0cc9d-59a7-44f6-9334-c3c3418763af",
"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": "6fad5c69-65ec-4ae6-9350-f7063eef72ad",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "69b49118-cb6c-4e65-822f-f4902f14550c",
"eventType": 1,
"sourceControlId": "38d4b48c-a338-401b-91be-70f5e7120ca9"
},
{
"id": "69b49118-cb6c-4e65-822f-f4902f14550c",
"eventType": 1,
"sourceControlId": "38d4b48c-a338-401b-91be-70f5e7120ca9"
}
]
},
{
"scriptId": "6fad5c69-65ec-4ae6-9350-f7063eef72ad",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "69b49118-cb6c-4e65-822f-f4902f14550c",
"eventType": 1,
"sourceControlId": "38d4b48c-a338-401b-91be-70f5e7120ca9"
},
{
"id": "69b49118-cb6c-4e65-822f-f4902f14550c",
"eventType": 1,
"sourceControlId": "38d4b48c-a338-401b-91be-70f5e7120ca9"
}
]
}
],
"success": true,
"mobileNotifications": true,
"validationError": {
"errorCode": 1,
"description": "sample string 2",
"type": 0
},
"caption": "sample string 3",
"name": "sample string 4"
}