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": "65e72441-883e-4b25-a27a-547afc93962f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "172d942c-ff95-413f-9bf4-db4d60ad68b3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8e3757c8-993a-40a6-9ab0-44020845ed45",
"CreateDate": "2025-12-24T07:59:19.7259756-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-24T07:59:19.7259756-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-24T07:59:19.7259756-08:00",
"Fields": [
{
"FormTypeFieldId": "1fd0cf23-a578-42ed-bf02-04cccec42b29",
"Section": {
"FormTypeSectionId": "76a4de84-3d4b-4705-a7fb-3322fb23010c",
"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": "bb6a015b-b3b7-441f-b06c-4f5a6769728b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e45f974c-4c2e-4f3d-a1e3-41b3c6fdc157",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "83ff5fc5-b704-4f4e-8f67-703fdf3a5cb0",
"CreateDate": "2025-12-24T07:59:19.7259756-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-24T07:59:19.7259756-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": "1fd0cf23-a578-42ed-bf02-04cccec42b29",
"Section": {
"FormTypeSectionId": "76a4de84-3d4b-4705-a7fb-3322fb23010c",
"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": "bb6a015b-b3b7-441f-b06c-4f5a6769728b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e45f974c-4c2e-4f3d-a1e3-41b3c6fdc157",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "83ff5fc5-b704-4f4e-8f67-703fdf3a5cb0",
"CreateDate": "2025-12-24T07:59:19.7259756-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-24T07:59:19.7259756-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": "4d298b26-c744-4759-b0cb-192413084e84",
"CreateDate": "2025-12-24T07:59:19.7259756-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-24T07:59:19.7259756-08:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "65e72441-883e-4b25-a27a-547afc93962f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "172d942c-ff95-413f-9bf4-db4d60ad68b3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8e3757c8-993a-40a6-9ab0-44020845ed45",
"CreateDate": "2025-12-24T07:59:19.7259756-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-24T07:59:19.7259756-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-24T07:59:19.7259756-08:00",
"Fields": [
{
"FormTypeFieldId": "1fd0cf23-a578-42ed-bf02-04cccec42b29",
"Section": {
"FormTypeSectionId": "76a4de84-3d4b-4705-a7fb-3322fb23010c",
"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": "bb6a015b-b3b7-441f-b06c-4f5a6769728b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e45f974c-4c2e-4f3d-a1e3-41b3c6fdc157",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "83ff5fc5-b704-4f4e-8f67-703fdf3a5cb0",
"CreateDate": "2025-12-24T07:59:19.7259756-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-24T07:59:19.7259756-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": "1fd0cf23-a578-42ed-bf02-04cccec42b29",
"Section": {
"FormTypeSectionId": "76a4de84-3d4b-4705-a7fb-3322fb23010c",
"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": "bb6a015b-b3b7-441f-b06c-4f5a6769728b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e45f974c-4c2e-4f3d-a1e3-41b3c6fdc157",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "83ff5fc5-b704-4f4e-8f67-703fdf3a5cb0",
"CreateDate": "2025-12-24T07:59:19.7259756-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-24T07:59:19.7259756-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": "4d298b26-c744-4759-b0cb-192413084e84",
"CreateDate": "2025-12-24T07:59:19.7259756-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-24T07:59:19.7259756-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}