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": "3307c28c-1de5-4c34-b41d-e9d227c19353",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f6e30e22-304d-4d63-9fad-8d33a4ed99aa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a7849d8e-0969-4bf9-836e-e6d062b31a9f",
"CreateDate": "2026-02-22T16:50:05.6698409-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-22T16:50:05.6698409-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-22T16:50:05.6698409-08:00",
"Fields": [
{
"FormTypeFieldId": "0a00c1c5-8a51-48a4-b94b-f453415651a2",
"Section": {
"FormTypeSectionId": "895d4396-9ce9-45b6-ae09-3681b8cbcdad",
"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": "0f27e276-c3a2-455f-96fa-8c9bd74aabb3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9ba82796-59a7-4688-b586-74c9ff2300dc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c3fc78eb-6fc8-4d5e-867e-a79418f395da",
"CreateDate": "2026-02-22T16:50:05.6698409-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-22T16:50:05.6698409-08: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": "0a00c1c5-8a51-48a4-b94b-f453415651a2",
"Section": {
"FormTypeSectionId": "895d4396-9ce9-45b6-ae09-3681b8cbcdad",
"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": "0f27e276-c3a2-455f-96fa-8c9bd74aabb3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9ba82796-59a7-4688-b586-74c9ff2300dc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c3fc78eb-6fc8-4d5e-867e-a79418f395da",
"CreateDate": "2026-02-22T16:50:05.6698409-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-22T16:50:05.6698409-08: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": "c830e7d7-5f93-410e-ab2b-34a140e74694",
"CreateDate": "2026-02-22T16:50:05.6698409-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-22T16:50:05.6698409-08:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "3307c28c-1de5-4c34-b41d-e9d227c19353",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f6e30e22-304d-4d63-9fad-8d33a4ed99aa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a7849d8e-0969-4bf9-836e-e6d062b31a9f",
"CreateDate": "2026-02-22T16:50:05.6698409-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-22T16:50:05.6698409-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-22T16:50:05.6698409-08:00",
"Fields": [
{
"FormTypeFieldId": "0a00c1c5-8a51-48a4-b94b-f453415651a2",
"Section": {
"FormTypeSectionId": "895d4396-9ce9-45b6-ae09-3681b8cbcdad",
"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": "0f27e276-c3a2-455f-96fa-8c9bd74aabb3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9ba82796-59a7-4688-b586-74c9ff2300dc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c3fc78eb-6fc8-4d5e-867e-a79418f395da",
"CreateDate": "2026-02-22T16:50:05.6698409-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-22T16:50:05.6698409-08: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": "0a00c1c5-8a51-48a4-b94b-f453415651a2",
"Section": {
"FormTypeSectionId": "895d4396-9ce9-45b6-ae09-3681b8cbcdad",
"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": "0f27e276-c3a2-455f-96fa-8c9bd74aabb3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9ba82796-59a7-4688-b586-74c9ff2300dc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c3fc78eb-6fc8-4d5e-867e-a79418f395da",
"CreateDate": "2026-02-22T16:50:05.6698409-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-22T16:50:05.6698409-08: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": "c830e7d7-5f93-410e-ab2b-34a140e74694",
"CreateDate": "2026-02-22T16:50:05.6698409-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-22T16:50:05.6698409-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}