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": "60dc968e-0f19-463b-91c0-fde6230965d5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "00e15aee-e841-4572-9cc0-40b8994990bd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "18f66eae-2830-4e58-98f9-b0b597ecc1f6",
"CreateDate": "2025-12-08T01:59:22.9315675-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-08T01:59:22.9315675-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-08T01:59:22.9315675-08:00",
"Fields": [
{
"FormTypeFieldId": "683e77fe-26ba-4ddd-827f-eb84c3cc0427",
"Section": {
"FormTypeSectionId": "4a9b999a-b219-490a-87cb-1b726aea946e",
"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": "ac1f5f1b-7277-451d-b11d-0e3adb5b1931",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ce4175c1-41f3-4e69-a8e6-bf6e8aeeddc2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "86a50438-ee89-4a2d-9f1a-5fa48620ccaa",
"CreateDate": "2025-12-08T01:59:22.9315675-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-08T01:59:22.9315675-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": "683e77fe-26ba-4ddd-827f-eb84c3cc0427",
"Section": {
"FormTypeSectionId": "4a9b999a-b219-490a-87cb-1b726aea946e",
"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": "ac1f5f1b-7277-451d-b11d-0e3adb5b1931",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ce4175c1-41f3-4e69-a8e6-bf6e8aeeddc2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "86a50438-ee89-4a2d-9f1a-5fa48620ccaa",
"CreateDate": "2025-12-08T01:59:22.9315675-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-08T01:59:22.9315675-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": "bef0e0ba-0e53-495f-99a2-cba173c91fe5",
"CreateDate": "2025-12-08T01:59:22.9315675-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-08T01:59:22.9315675-08:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "60dc968e-0f19-463b-91c0-fde6230965d5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "00e15aee-e841-4572-9cc0-40b8994990bd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "18f66eae-2830-4e58-98f9-b0b597ecc1f6",
"CreateDate": "2025-12-08T01:59:22.9315675-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-08T01:59:22.9315675-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-08T01:59:22.9315675-08:00",
"Fields": [
{
"FormTypeFieldId": "683e77fe-26ba-4ddd-827f-eb84c3cc0427",
"Section": {
"FormTypeSectionId": "4a9b999a-b219-490a-87cb-1b726aea946e",
"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": "ac1f5f1b-7277-451d-b11d-0e3adb5b1931",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ce4175c1-41f3-4e69-a8e6-bf6e8aeeddc2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "86a50438-ee89-4a2d-9f1a-5fa48620ccaa",
"CreateDate": "2025-12-08T01:59:22.9315675-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-08T01:59:22.9315675-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": "683e77fe-26ba-4ddd-827f-eb84c3cc0427",
"Section": {
"FormTypeSectionId": "4a9b999a-b219-490a-87cb-1b726aea946e",
"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": "ac1f5f1b-7277-451d-b11d-0e3adb5b1931",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ce4175c1-41f3-4e69-a8e6-bf6e8aeeddc2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "86a50438-ee89-4a2d-9f1a-5fa48620ccaa",
"CreateDate": "2025-12-08T01:59:22.9315675-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-08T01:59:22.9315675-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": "bef0e0ba-0e53-495f-99a2-cba173c91fe5",
"CreateDate": "2025-12-08T01:59:22.9315675-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-08T01:59:22.9315675-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}