GET v1/forms/{environment}/{orgId}?pageIndex={pageIndex}&pageSize={pageSize}&sort={sort}
Use this method to get a list of all available forms for an organization. This method does not provide paging therefore, the calling party will receive all forms available for an organization.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| environment |
Environment where the org id was created from. |
string |
Required |
| orgId |
MaaS Org Id. |
integer |
Required |
| pageIndex |
Optional parameter greater or equal to zero that specifies the page index if paging is desired. Defaults to 0 |
integer |
None. |
| pageSize |
Optional parameter that specifies how many items per page to return. |
integer |
Default value is 20 |
| sort |
Optional parameter where to specify if the result should be sort in ascending or descending order, where Default is a synonym of ascending. Default value is "Default". |
SortOption |
Default value is Default |
Body Parameters
None.
Response Information
Resource Description
Returns a collection of dynamic form elements associated to the specified organization.
Collection of DynamicForm| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Form unique identifier. |
string |
None. |
| type |
Form Type (Used by MDU solutions only) |
string |
None. |
| name |
Form Name |
string |
None. |
| description |
Form Description |
string |
None. |
| items |
Form Items |
Collection of FormElement |
None. |
| emailActionSettings |
Use this property to modify action settings. Action settings can not be deleted or added, only updated as they are pointers to underlaying form associated actions and not actual settings of the element themselves. When editing a Submit Button Form element, the settings related to email come from this collection of settings. |
Collection of EntityTemplateActionSetting |
None. |
Response Formats
application/json, text/json
[
{
"id": "sample string 1",
"type": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"items": [
{
"id": "sample string 1",
"name": "sample string 2",
"label": "sample string 3",
"formUUID": "sample string 4",
"help": "sample string 5",
"required": true,
"type": {
"id": "sample string 1",
"type": "sample string 2",
"name": "sample string 3",
"description": "sample string 4"
},
"order": 7,
"prompt": "sample string 8",
"textType": 1,
"minLength": 1,
"maxLength": 1,
"preFill": true,
"preFillTag": "sample string 9",
"width": 1,
"height": 1,
"alignment": "sample string 10",
"defaultOption": "sample string 11",
"minuteInterval": 1,
"defaultDate": "sample string 12",
"minDate": "sample string 13",
"maxDate": "sample string 14",
"defaultCheck": true,
"errorColor": "sample string 15",
"choices": [
{
"id": "sample string 1",
"name": "sample string 3",
"internalName": "sample string 4",
"order": 1
},
{
"id": "sample string 1",
"name": "sample string 3",
"internalName": "sample string 4",
"order": 1
}
]
},
{
"id": "sample string 1",
"name": "sample string 2",
"label": "sample string 3",
"formUUID": "sample string 4",
"help": "sample string 5",
"required": true,
"type": {
"id": "sample string 1",
"type": "sample string 2",
"name": "sample string 3",
"description": "sample string 4"
},
"order": 7,
"prompt": "sample string 8",
"textType": 1,
"minLength": 1,
"maxLength": 1,
"preFill": true,
"preFillTag": "sample string 9",
"width": 1,
"height": 1,
"alignment": "sample string 10",
"defaultOption": "sample string 11",
"minuteInterval": 1,
"defaultDate": "sample string 12",
"minDate": "sample string 13",
"maxDate": "sample string 14",
"defaultCheck": true,
"errorColor": "sample string 15",
"choices": [
{
"id": "sample string 1",
"name": "sample string 3",
"internalName": "sample string 4",
"order": 1
},
{
"id": "sample string 1",
"name": "sample string 3",
"internalName": "sample string 4",
"order": 1
}
]
}
],
"emailActionSettings": [
{
"id": "sample string 1",
"name": "sample string 3",
"value": "sample string 4"
},
{
"id": "sample string 1",
"name": "sample string 3",
"value": "sample string 4"
}
]
},
{
"id": "sample string 1",
"type": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"items": [
{
"id": "sample string 1",
"name": "sample string 2",
"label": "sample string 3",
"formUUID": "sample string 4",
"help": "sample string 5",
"required": true,
"type": {
"id": "sample string 1",
"type": "sample string 2",
"name": "sample string 3",
"description": "sample string 4"
},
"order": 7,
"prompt": "sample string 8",
"textType": 1,
"minLength": 1,
"maxLength": 1,
"preFill": true,
"preFillTag": "sample string 9",
"width": 1,
"height": 1,
"alignment": "sample string 10",
"defaultOption": "sample string 11",
"minuteInterval": 1,
"defaultDate": "sample string 12",
"minDate": "sample string 13",
"maxDate": "sample string 14",
"defaultCheck": true,
"errorColor": "sample string 15",
"choices": [
{
"id": "sample string 1",
"name": "sample string 3",
"internalName": "sample string 4",
"order": 1
},
{
"id": "sample string 1",
"name": "sample string 3",
"internalName": "sample string 4",
"order": 1
}
]
},
{
"id": "sample string 1",
"name": "sample string 2",
"label": "sample string 3",
"formUUID": "sample string 4",
"help": "sample string 5",
"required": true,
"type": {
"id": "sample string 1",
"type": "sample string 2",
"name": "sample string 3",
"description": "sample string 4"
},
"order": 7,
"prompt": "sample string 8",
"textType": 1,
"minLength": 1,
"maxLength": 1,
"preFill": true,
"preFillTag": "sample string 9",
"width": 1,
"height": 1,
"alignment": "sample string 10",
"defaultOption": "sample string 11",
"minuteInterval": 1,
"defaultDate": "sample string 12",
"minDate": "sample string 13",
"maxDate": "sample string 14",
"defaultCheck": true,
"errorColor": "sample string 15",
"choices": [
{
"id": "sample string 1",
"name": "sample string 3",
"internalName": "sample string 4",
"order": 1
},
{
"id": "sample string 1",
"name": "sample string 3",
"internalName": "sample string 4",
"order": 1
}
]
}
],
"emailActionSettings": [
{
"id": "sample string 1",
"name": "sample string 3",
"value": "sample string 4"
},
{
"id": "sample string 1",
"name": "sample string 3",
"value": "sample string 4"
}
]
}
]