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": "6ab12bf7-f889-493a-9be8-8ebef0b43bc4",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "811a0df7-24ff-4bd3-806a-816841e0bd66",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "262bfdf8-fe51-4261-ad0a-a5d688d3c3cd",
"CreateDate": "2025-12-01T00:15:02.4802651-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T00:15:02.4802651-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-01T00:15:02.4802651-08:00",
"Fields": [
{
"FormTypeFieldId": "e7ca39cc-a161-47a5-884a-94e480763a6f",
"Section": {
"FormTypeSectionId": "76a32b3f-a43a-45c5-8d2b-04632f98169a",
"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": "0cf361ca-2beb-4f10-a123-c8dd2d2162b7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f01b2736-a22b-43a2-ac00-69ec185cddc7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d5d30f41-7fd3-486b-8f88-2b9ed98cb7ca",
"CreateDate": "2025-12-01T00:15:02.4802651-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T00:15:02.4802651-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": "e7ca39cc-a161-47a5-884a-94e480763a6f",
"Section": {
"FormTypeSectionId": "76a32b3f-a43a-45c5-8d2b-04632f98169a",
"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": "0cf361ca-2beb-4f10-a123-c8dd2d2162b7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f01b2736-a22b-43a2-ac00-69ec185cddc7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d5d30f41-7fd3-486b-8f88-2b9ed98cb7ca",
"CreateDate": "2025-12-01T00:15:02.4802651-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T00:15:02.4802651-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": "c0fcc4f5-854f-4992-9911-7573527ce9ec",
"CreateDate": "2025-12-01T00:15:02.4802651-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T00:15:02.4802651-08:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "6ab12bf7-f889-493a-9be8-8ebef0b43bc4",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "811a0df7-24ff-4bd3-806a-816841e0bd66",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "262bfdf8-fe51-4261-ad0a-a5d688d3c3cd",
"CreateDate": "2025-12-01T00:15:02.4802651-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T00:15:02.4802651-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-01T00:15:02.4802651-08:00",
"Fields": [
{
"FormTypeFieldId": "e7ca39cc-a161-47a5-884a-94e480763a6f",
"Section": {
"FormTypeSectionId": "76a32b3f-a43a-45c5-8d2b-04632f98169a",
"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": "0cf361ca-2beb-4f10-a123-c8dd2d2162b7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f01b2736-a22b-43a2-ac00-69ec185cddc7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d5d30f41-7fd3-486b-8f88-2b9ed98cb7ca",
"CreateDate": "2025-12-01T00:15:02.4802651-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T00:15:02.4802651-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": "e7ca39cc-a161-47a5-884a-94e480763a6f",
"Section": {
"FormTypeSectionId": "76a32b3f-a43a-45c5-8d2b-04632f98169a",
"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": "0cf361ca-2beb-4f10-a123-c8dd2d2162b7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f01b2736-a22b-43a2-ac00-69ec185cddc7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d5d30f41-7fd3-486b-8f88-2b9ed98cb7ca",
"CreateDate": "2025-12-01T00:15:02.4802651-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T00:15:02.4802651-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": "c0fcc4f5-854f-4992-9911-7573527ce9ec",
"CreateDate": "2025-12-01T00:15:02.4802651-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T00:15:02.4802651-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}