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": "771b3ff8-dcbb-4acd-a365-86b702d2d6a0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "7392a56b-a85c-4266-a98a-8a27b7ee3378",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e27c409d-c3c3-4f62-8bbc-72c15fee13bd",
"CreateDate": "2026-10-15T04:23:18.3327298-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-15T04:23:18.3327298-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-15T04:23:18.3327298-07:00",
"Fields": [
{
"FormTypeFieldId": "759a9643-ad22-4d9f-94d3-beba285a9212",
"Section": {
"FormTypeSectionId": "a18fb5ab-2150-44d4-abd5-312da29f6211",
"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": "1d074555-a3f7-4396-976b-5050998d5cdb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3be9a444-0171-4ca2-8faf-5120903a3927",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "14977507-1ca2-4ed3-b64a-d8ee66241bae",
"CreateDate": "2026-10-15T04:23:18.3327298-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-15T04:23:18.3327298-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": "759a9643-ad22-4d9f-94d3-beba285a9212",
"Section": {
"FormTypeSectionId": "a18fb5ab-2150-44d4-abd5-312da29f6211",
"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": "1d074555-a3f7-4396-976b-5050998d5cdb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3be9a444-0171-4ca2-8faf-5120903a3927",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "14977507-1ca2-4ed3-b64a-d8ee66241bae",
"CreateDate": "2026-10-15T04:23:18.3327298-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-15T04:23:18.3327298-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": "a9356e96-38f5-478d-84f0-4f5b7ed48663",
"CreateDate": "2026-10-15T04:23:18.3327298-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-15T04:23:18.3327298-07:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "771b3ff8-dcbb-4acd-a365-86b702d2d6a0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "7392a56b-a85c-4266-a98a-8a27b7ee3378",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e27c409d-c3c3-4f62-8bbc-72c15fee13bd",
"CreateDate": "2026-10-15T04:23:18.3327298-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-15T04:23:18.3327298-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-15T04:23:18.3327298-07:00",
"Fields": [
{
"FormTypeFieldId": "759a9643-ad22-4d9f-94d3-beba285a9212",
"Section": {
"FormTypeSectionId": "a18fb5ab-2150-44d4-abd5-312da29f6211",
"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": "1d074555-a3f7-4396-976b-5050998d5cdb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3be9a444-0171-4ca2-8faf-5120903a3927",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "14977507-1ca2-4ed3-b64a-d8ee66241bae",
"CreateDate": "2026-10-15T04:23:18.3327298-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-15T04:23:18.3327298-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": "759a9643-ad22-4d9f-94d3-beba285a9212",
"Section": {
"FormTypeSectionId": "a18fb5ab-2150-44d4-abd5-312da29f6211",
"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": "1d074555-a3f7-4396-976b-5050998d5cdb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3be9a444-0171-4ca2-8faf-5120903a3927",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "14977507-1ca2-4ed3-b64a-d8ee66241bae",
"CreateDate": "2026-10-15T04:23:18.3327298-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-15T04:23:18.3327298-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": "a9356e96-38f5-478d-84f0-4f5b7ed48663",
"CreateDate": "2026-10-15T04:23:18.3327298-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-15T04:23:18.3327298-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}