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. |
| CoSignatures |
Form co-signatures |
Collection of iMDsoft.API.Metavision.Data.Forms.FormCoSignature |
None. |
| Caption |
Schema caption |
string |
None. |
| Name |
Schema name |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"formId": "526a041a-37db-44d2-bc9f-f6bef045f289",
"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": "c449690a-38f5-4e5c-9f11-00b68b37c010",
"frames": [
{
"frameId": "ef01095a-44cf-4bc5-ba8e-527ec2024367",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "ef01095a-44cf-4bc5-ba8e-527ec2024367",
"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": "c449690a-38f5-4e5c-9f11-00b68b37c010",
"frames": [
{
"frameId": "ef01095a-44cf-4bc5-ba8e-527ec2024367",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "ef01095a-44cf-4bc5-ba8e-527ec2024367",
"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": "a42899f9-9f5e-4397-a2fe-5770197c08f1",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "7ffbc77f-fdd8-4d27-81c7-2954de39c90d",
"eventType": 1,
"sourceControlId": "444e730c-2d17-4550-8889-f2457b176b83"
},
{
"id": "7ffbc77f-fdd8-4d27-81c7-2954de39c90d",
"eventType": 1,
"sourceControlId": "444e730c-2d17-4550-8889-f2457b176b83"
}
]
},
{
"scriptId": "a42899f9-9f5e-4397-a2fe-5770197c08f1",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "7ffbc77f-fdd8-4d27-81c7-2954de39c90d",
"eventType": 1,
"sourceControlId": "444e730c-2d17-4550-8889-f2457b176b83"
},
{
"id": "7ffbc77f-fdd8-4d27-81c7-2954de39c90d",
"eventType": 1,
"sourceControlId": "444e730c-2d17-4550-8889-f2457b176b83"
}
]
}
],
"success": true,
"mobileNotifications": true,
"validationError": {
"errorCode": 1,
"description": "sample string 2",
"type": 0
},
"isLast": true,
"groupId": 1,
"formVersion": 1,
"coSignatures": [
{
"coSignatureId": "876ba902-48dd-4663-8d24-a2972f77370d",
"description": "sample string 2",
"policy": 0,
"sortOrder": 3,
"userTypeIds": [
1,
2
]
},
{
"coSignatureId": "876ba902-48dd-4663-8d24-a2972f77370d",
"description": "sample string 2",
"policy": 0,
"sortOrder": 3,
"userTypeIds": [
1,
2
]
}
],
"caption": "sample string 3",
"name": "sample string 4"
},
{
"formId": "526a041a-37db-44d2-bc9f-f6bef045f289",
"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": "c449690a-38f5-4e5c-9f11-00b68b37c010",
"frames": [
{
"frameId": "ef01095a-44cf-4bc5-ba8e-527ec2024367",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "ef01095a-44cf-4bc5-ba8e-527ec2024367",
"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": "c449690a-38f5-4e5c-9f11-00b68b37c010",
"frames": [
{
"frameId": "ef01095a-44cf-4bc5-ba8e-527ec2024367",
"controls": null,
"name": "sample string 2",
"indexInTab": 3,
"isComment": true,
"scriptName": "sample string 5"
},
{
"frameId": "ef01095a-44cf-4bc5-ba8e-527ec2024367",
"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": "a42899f9-9f5e-4397-a2fe-5770197c08f1",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "7ffbc77f-fdd8-4d27-81c7-2954de39c90d",
"eventType": 1,
"sourceControlId": "444e730c-2d17-4550-8889-f2457b176b83"
},
{
"id": "7ffbc77f-fdd8-4d27-81c7-2954de39c90d",
"eventType": 1,
"sourceControlId": "444e730c-2d17-4550-8889-f2457b176b83"
}
]
},
{
"scriptId": "a42899f9-9f5e-4397-a2fe-5770197c08f1",
"name": "sample string 2",
"parameters": "sample string 3",
"vbScript": "sample string 4",
"javaScript": "sample string 5",
"events": [
{
"id": "7ffbc77f-fdd8-4d27-81c7-2954de39c90d",
"eventType": 1,
"sourceControlId": "444e730c-2d17-4550-8889-f2457b176b83"
},
{
"id": "7ffbc77f-fdd8-4d27-81c7-2954de39c90d",
"eventType": 1,
"sourceControlId": "444e730c-2d17-4550-8889-f2457b176b83"
}
]
}
],
"success": true,
"mobileNotifications": true,
"validationError": {
"errorCode": 1,
"description": "sample string 2",
"type": 0
},
"isLast": true,
"groupId": 1,
"formVersion": 1,
"coSignatures": [
{
"coSignatureId": "876ba902-48dd-4663-8d24-a2972f77370d",
"description": "sample string 2",
"policy": 0,
"sortOrder": 3,
"userTypeIds": [
1,
2
]
},
{
"coSignatureId": "876ba902-48dd-4663-8d24-a2972f77370d",
"description": "sample string 2",
"policy": 0,
"sortOrder": 3,
"userTypeIds": [
1,
2
]
}
],
"caption": "sample string 3",
"name": "sample string 4"
}
]