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": "cc60370c-b7ef-4fb1-8b6c-e9b31f42ffe1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "04c708cc-6e67-4de6-a659-78b73c9147d0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ec5673ff-5ec8-4031-9547-4bdedb62cbf1",
"CreateDate": "2026-06-18T05:15:01.4033843-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-18T05:15:01.4033843-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-18T05:15:01.4033843-07:00",
"Fields": [
{
"FormTypeFieldId": "cb55cc51-c402-4932-9e14-4262122c052d",
"Section": {
"FormTypeSectionId": "d46a7002-30f2-4b5b-9dd7-391f530d524f",
"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": "bbb5600c-d865-47e9-89a8-582a1113921e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b8ec5f39-7b32-4ac3-8970-242104ac951f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0ef0ac11-2865-4e04-928d-ada6ee387661",
"CreateDate": "2026-06-18T05:15:01.4033843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-18T05:15:01.4033843-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": "cb55cc51-c402-4932-9e14-4262122c052d",
"Section": {
"FormTypeSectionId": "d46a7002-30f2-4b5b-9dd7-391f530d524f",
"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": "bbb5600c-d865-47e9-89a8-582a1113921e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b8ec5f39-7b32-4ac3-8970-242104ac951f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0ef0ac11-2865-4e04-928d-ada6ee387661",
"CreateDate": "2026-06-18T05:15:01.4033843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-18T05:15:01.4033843-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": "85abeb67-a323-499d-a258-ac90602bd060",
"CreateDate": "2026-06-18T05:15:01.4033843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-18T05:15:01.4033843-07:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "cc60370c-b7ef-4fb1-8b6c-e9b31f42ffe1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "04c708cc-6e67-4de6-a659-78b73c9147d0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ec5673ff-5ec8-4031-9547-4bdedb62cbf1",
"CreateDate": "2026-06-18T05:15:01.4033843-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-18T05:15:01.4033843-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-18T05:15:01.4033843-07:00",
"Fields": [
{
"FormTypeFieldId": "cb55cc51-c402-4932-9e14-4262122c052d",
"Section": {
"FormTypeSectionId": "d46a7002-30f2-4b5b-9dd7-391f530d524f",
"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": "bbb5600c-d865-47e9-89a8-582a1113921e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b8ec5f39-7b32-4ac3-8970-242104ac951f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0ef0ac11-2865-4e04-928d-ada6ee387661",
"CreateDate": "2026-06-18T05:15:01.4033843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-18T05:15:01.4033843-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": "cb55cc51-c402-4932-9e14-4262122c052d",
"Section": {
"FormTypeSectionId": "d46a7002-30f2-4b5b-9dd7-391f530d524f",
"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": "bbb5600c-d865-47e9-89a8-582a1113921e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b8ec5f39-7b32-4ac3-8970-242104ac951f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0ef0ac11-2865-4e04-928d-ada6ee387661",
"CreateDate": "2026-06-18T05:15:01.4033843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-18T05:15:01.4033843-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": "85abeb67-a323-499d-a258-ac90602bd060",
"CreateDate": "2026-06-18T05:15:01.4033843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-18T05:15:01.4033843-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}