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": "efeea36b-7819-4f06-8e56-fd01c5310486",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c2cfe7f0-51d5-441b-b1c0-162c3f2e4d6f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "840597c8-08e0-412b-8a5b-82bfc7fa48f3",
"CreateDate": "2026-08-02T18:19:29.3837294-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-02T18:19:29.3837294-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-02T18:19:29.3837294-07:00",
"Fields": [
{
"FormTypeFieldId": "af44deb1-de38-4136-ad44-2d0935c2b646",
"Section": {
"FormTypeSectionId": "e1d5acf9-b5d8-4778-a683-f85d87254e3a",
"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": "ee495f3b-e688-4dc6-831d-30252a7bd2b8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "88aff1ca-1b14-46b5-ab65-707509175f55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7ccac350-4514-49b0-95d2-8d6d0455396b",
"CreateDate": "2026-08-02T18:19:29.3837294-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T18:19:29.3837294-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": "af44deb1-de38-4136-ad44-2d0935c2b646",
"Section": {
"FormTypeSectionId": "e1d5acf9-b5d8-4778-a683-f85d87254e3a",
"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": "ee495f3b-e688-4dc6-831d-30252a7bd2b8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "88aff1ca-1b14-46b5-ab65-707509175f55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7ccac350-4514-49b0-95d2-8d6d0455396b",
"CreateDate": "2026-08-02T18:19:29.3837294-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T18:19:29.3837294-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": "4c540038-b40a-43e1-830f-5d5e229f138d",
"CreateDate": "2026-08-02T18:19:29.3837294-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T18:19:29.3837294-07:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "efeea36b-7819-4f06-8e56-fd01c5310486",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c2cfe7f0-51d5-441b-b1c0-162c3f2e4d6f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "840597c8-08e0-412b-8a5b-82bfc7fa48f3",
"CreateDate": "2026-08-02T18:19:29.3837294-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-02T18:19:29.3837294-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-02T18:19:29.3837294-07:00",
"Fields": [
{
"FormTypeFieldId": "af44deb1-de38-4136-ad44-2d0935c2b646",
"Section": {
"FormTypeSectionId": "e1d5acf9-b5d8-4778-a683-f85d87254e3a",
"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": "ee495f3b-e688-4dc6-831d-30252a7bd2b8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "88aff1ca-1b14-46b5-ab65-707509175f55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7ccac350-4514-49b0-95d2-8d6d0455396b",
"CreateDate": "2026-08-02T18:19:29.3837294-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T18:19:29.3837294-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": "af44deb1-de38-4136-ad44-2d0935c2b646",
"Section": {
"FormTypeSectionId": "e1d5acf9-b5d8-4778-a683-f85d87254e3a",
"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": "ee495f3b-e688-4dc6-831d-30252a7bd2b8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "88aff1ca-1b14-46b5-ab65-707509175f55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7ccac350-4514-49b0-95d2-8d6d0455396b",
"CreateDate": "2026-08-02T18:19:29.3837294-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T18:19:29.3837294-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": "4c540038-b40a-43e1-830f-5d5e229f138d",
"CreateDate": "2026-08-02T18:19:29.3837294-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T18:19:29.3837294-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}