GET FormTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves form types for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
| take |
Number of form types to retrieve. Default is all form types |
integer |
None. |
| skip |
Number of form types to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the form types before retrieval |
Collection of Sort |
None. |
| Operator | string |
None. |
|
| Field | string |
None. |
|
| Value | string |
None. |
|
| Logic | string |
None. |
|
| Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of form types.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of FormType |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"FormTypeId": "40020b61-20bb-4f05-9001-9e57cca8ae8d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "dbc1a92d-465c-4d4e-bee8-e237c66c0a80",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "aedf2f93-4930-4235-baf2-3f2d9f545460",
"CreateDate": "2026-08-24T05:31:01.9224371-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T05:31:01.9224371-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-24T05:31:01.9224371-07:00",
"Fields": [
{
"FormTypeFieldId": "d634ab8a-aa4c-48df-904c-9be1bce9020a",
"Section": {
"FormTypeSectionId": "1c6f6f41-3be1-456e-a30a-6b1545c46eaf",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "03cb64f2-b02c-440d-b331-8624ccc8e2f4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "13287e6f-1dd7-4a9b-bedf-4dbf116c3ae1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6e4c17bd-5c4b-45cc-9ad4-f08a9d468519",
"CreateDate": "2026-08-24T05:31:01.9224371-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T05:31:01.9224371-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
},
{
"FormTypeFieldId": "d634ab8a-aa4c-48df-904c-9be1bce9020a",
"Section": {
"FormTypeSectionId": "1c6f6f41-3be1-456e-a30a-6b1545c46eaf",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "03cb64f2-b02c-440d-b331-8624ccc8e2f4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "13287e6f-1dd7-4a9b-bedf-4dbf116c3ae1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6e4c17bd-5c4b-45cc-9ad4-f08a9d468519",
"CreateDate": "2026-08-24T05:31:01.9224371-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T05:31:01.9224371-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "5bd839f2-7821-419f-b0a5-39ba20c470a9",
"CreateDate": "2026-08-24T05:31:01.9224371-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T05:31:01.9224371-07:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "40020b61-20bb-4f05-9001-9e57cca8ae8d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "dbc1a92d-465c-4d4e-bee8-e237c66c0a80",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "aedf2f93-4930-4235-baf2-3f2d9f545460",
"CreateDate": "2026-08-24T05:31:01.9224371-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T05:31:01.9224371-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-24T05:31:01.9224371-07:00",
"Fields": [
{
"FormTypeFieldId": "d634ab8a-aa4c-48df-904c-9be1bce9020a",
"Section": {
"FormTypeSectionId": "1c6f6f41-3be1-456e-a30a-6b1545c46eaf",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "03cb64f2-b02c-440d-b331-8624ccc8e2f4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "13287e6f-1dd7-4a9b-bedf-4dbf116c3ae1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6e4c17bd-5c4b-45cc-9ad4-f08a9d468519",
"CreateDate": "2026-08-24T05:31:01.9224371-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T05:31:01.9224371-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
},
{
"FormTypeFieldId": "d634ab8a-aa4c-48df-904c-9be1bce9020a",
"Section": {
"FormTypeSectionId": "1c6f6f41-3be1-456e-a30a-6b1545c46eaf",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "03cb64f2-b02c-440d-b331-8624ccc8e2f4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "13287e6f-1dd7-4a9b-bedf-4dbf116c3ae1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6e4c17bd-5c4b-45cc-9ad4-f08a9d468519",
"CreateDate": "2026-08-24T05:31:01.9224371-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T05:31:01.9224371-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "5bd839f2-7821-419f-b0a5-39ba20c470a9",
"CreateDate": "2026-08-24T05:31:01.9224371-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T05:31:01.9224371-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}