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": "c3891841-93d7-438a-866d-560c8cdb7a5c",
"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": "858efb87-571d-41fb-b24b-b2daf1f867bd",
"frames": [
{
"frameId": "0b002428-b90b-43b3-a4f2-41f8e4ec3561",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "0b002428-b90b-43b3-a4f2-41f8e4ec3561",
"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": "858efb87-571d-41fb-b24b-b2daf1f867bd",
"frames": [
{
"frameId": "0b002428-b90b-43b3-a4f2-41f8e4ec3561",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "0b002428-b90b-43b3-a4f2-41f8e4ec3561",
"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": "ab55f3f4-775c-4248-914d-b47389fc5593",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "8bf61fa2-42bc-4806-960d-f36f36267c91",
"eventType": 1,
"sourceControlId": "a2bf5c5d-1941-46d4-94a7-be018e129acc"
},
{
"id": "8bf61fa2-42bc-4806-960d-f36f36267c91",
"eventType": 1,
"sourceControlId": "a2bf5c5d-1941-46d4-94a7-be018e129acc"
}
]
},
{
"scriptId": "ab55f3f4-775c-4248-914d-b47389fc5593",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "8bf61fa2-42bc-4806-960d-f36f36267c91",
"eventType": 1,
"sourceControlId": "a2bf5c5d-1941-46d4-94a7-be018e129acc"
},
{
"id": "8bf61fa2-42bc-4806-960d-f36f36267c91",
"eventType": 1,
"sourceControlId": "a2bf5c5d-1941-46d4-94a7-be018e129acc"
}
]
}
],
"success": true,
"mobileNotifications": true,
"validationError": {
"errorCode": 1,
"description": "sample string 2",
"type": 0
},
"caption": "sample string 3",
"name": "sample string 4"
},
{
"formId": "c3891841-93d7-438a-866d-560c8cdb7a5c",
"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": "858efb87-571d-41fb-b24b-b2daf1f867bd",
"frames": [
{
"frameId": "0b002428-b90b-43b3-a4f2-41f8e4ec3561",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "0b002428-b90b-43b3-a4f2-41f8e4ec3561",
"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": "858efb87-571d-41fb-b24b-b2daf1f867bd",
"frames": [
{
"frameId": "0b002428-b90b-43b3-a4f2-41f8e4ec3561",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "0b002428-b90b-43b3-a4f2-41f8e4ec3561",
"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": "ab55f3f4-775c-4248-914d-b47389fc5593",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "8bf61fa2-42bc-4806-960d-f36f36267c91",
"eventType": 1,
"sourceControlId": "a2bf5c5d-1941-46d4-94a7-be018e129acc"
},
{
"id": "8bf61fa2-42bc-4806-960d-f36f36267c91",
"eventType": 1,
"sourceControlId": "a2bf5c5d-1941-46d4-94a7-be018e129acc"
}
]
},
{
"scriptId": "ab55f3f4-775c-4248-914d-b47389fc5593",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "8bf61fa2-42bc-4806-960d-f36f36267c91",
"eventType": 1,
"sourceControlId": "a2bf5c5d-1941-46d4-94a7-be018e129acc"
},
{
"id": "8bf61fa2-42bc-4806-960d-f36f36267c91",
"eventType": 1,
"sourceControlId": "a2bf5c5d-1941-46d4-94a7-be018e129acc"
}
]
}
],
"success": true,
"mobileNotifications": true,
"validationError": {
"errorCode": 1,
"description": "sample string 2",
"type": 0
},
"caption": "sample string 3",
"name": "sample string 4"
}
]