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": "50039d65-827b-492b-8231-f176d2e8d6ca",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "271883f2-ecb5-455c-9757-015e6f52aa0a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bb861849-fb43-46de-aa26-4af8e746484d",
"CreateDate": "2026-09-14T14:59:13.1000186-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-14T14:59:13.1000186-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-14T14:59:13.1000186-07:00",
"Fields": [
{
"FormTypeFieldId": "ca270f45-0cdb-4d39-ad07-440e15aad299",
"Section": {
"FormTypeSectionId": "01dab002-4dda-4182-9e2d-7abe09984e7d",
"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": "c84988f8-71d5-49a2-9dbc-bd2a2642c96b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d043ce21-e4b0-4fdf-9f50-f3d83fd08c0a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "212863c5-3f48-4e05-8e31-271cd20a9dbf",
"CreateDate": "2026-09-14T14:59:13.1000186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T14:59:13.1000186-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": "ca270f45-0cdb-4d39-ad07-440e15aad299",
"Section": {
"FormTypeSectionId": "01dab002-4dda-4182-9e2d-7abe09984e7d",
"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": "c84988f8-71d5-49a2-9dbc-bd2a2642c96b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d043ce21-e4b0-4fdf-9f50-f3d83fd08c0a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "212863c5-3f48-4e05-8e31-271cd20a9dbf",
"CreateDate": "2026-09-14T14:59:13.1000186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T14:59:13.1000186-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": "6f24d8a6-b5e9-4caf-a07b-9330bb9bd90d",
"CreateDate": "2026-09-14T14:59:13.1000186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T14:59:13.1000186-07:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "50039d65-827b-492b-8231-f176d2e8d6ca",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "271883f2-ecb5-455c-9757-015e6f52aa0a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bb861849-fb43-46de-aa26-4af8e746484d",
"CreateDate": "2026-09-14T14:59:13.1000186-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-14T14:59:13.1000186-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-14T14:59:13.1000186-07:00",
"Fields": [
{
"FormTypeFieldId": "ca270f45-0cdb-4d39-ad07-440e15aad299",
"Section": {
"FormTypeSectionId": "01dab002-4dda-4182-9e2d-7abe09984e7d",
"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": "c84988f8-71d5-49a2-9dbc-bd2a2642c96b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d043ce21-e4b0-4fdf-9f50-f3d83fd08c0a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "212863c5-3f48-4e05-8e31-271cd20a9dbf",
"CreateDate": "2026-09-14T14:59:13.1000186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T14:59:13.1000186-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": "ca270f45-0cdb-4d39-ad07-440e15aad299",
"Section": {
"FormTypeSectionId": "01dab002-4dda-4182-9e2d-7abe09984e7d",
"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": "c84988f8-71d5-49a2-9dbc-bd2a2642c96b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d043ce21-e4b0-4fdf-9f50-f3d83fd08c0a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "212863c5-3f48-4e05-8e31-271cd20a9dbf",
"CreateDate": "2026-09-14T14:59:13.1000186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T14:59:13.1000186-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": "6f24d8a6-b5e9-4caf-a07b-9330bb9bd90d",
"CreateDate": "2026-09-14T14:59:13.1000186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T14:59:13.1000186-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}