GET Forms/Category
Get formCategories from criteria
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
| IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
| IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| FormCategoryIDs |
Filter by FormCategoryIDs |
Collection of integer |
None. |
| FormClass |
Filter by FormClass |
byte |
None. |
| CategoryName |
Filter by CategoryName |
string |
None. |
| CreatedDateUtcMin |
Filter by CreatedDateUtcMin |
date |
None. |
| CreatedDateUtcMax |
Filter by CreatedDateUtcMax |
date |
None. |
| LastUpdatedDateUtcMin |
Filter by LastUpdatedDateUtcMin |
date |
None. |
| LastUpdatedDateUtcMax |
Filter by LastUpdatedDateUtcMax |
date |
None. |
| FormBusinessUnits |
Filter by Form Business Units |
Collection of integer |
None. |
| Form |
Filter by Form Properties |
FindFormCriteria |
None. |
| MaxRows |
Limit number of rows |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
List of FormCategoryDTOs
Collection of FormCategoryDto| Name | Description | Type | Additional information |
|---|---|---|---|
| FormCategoryID | integer |
None. |
|
| FormClass | FormClass |
None. |
|
| CategoryName | string |
None. |
|
| SortOrder | integer |
None. |
|
| RecordState | FormRecordState |
None. |
|
| Created | FormAuditDataDto |
None. |
|
| LastUpdated | FormAuditDataDto |
None. |