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": "520f1aad-ddf4-4d70-a263-d08ca3dca5fe",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1bea7de0-ea02-4d7e-a5b7-3fbcff8c0f64",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "65220446-ce3f-4fb8-87d1-5ffc2ad011b3",
"CreateDate": "2026-05-06T21:42:56.7670154-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-06T21:42:56.7670154-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-06T21:42:56.7670154-07:00",
"Fields": [
{
"FormTypeFieldId": "e5b61b5e-8b9d-4630-afca-58fc20944f81",
"Section": {
"FormTypeSectionId": "1a2b8cc2-35c8-4912-b4d0-117ab3b93e71",
"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": "1d2ace2e-c2d5-4b56-b522-5c6a1f905b82",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c02c9f18-33d8-4b11-9417-540d70ed529a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0d147c50-1bae-4729-986f-d9ea06c9a278",
"CreateDate": "2026-05-06T21:42:56.7670154-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-06T21:42:56.7670154-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": "e5b61b5e-8b9d-4630-afca-58fc20944f81",
"Section": {
"FormTypeSectionId": "1a2b8cc2-35c8-4912-b4d0-117ab3b93e71",
"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": "1d2ace2e-c2d5-4b56-b522-5c6a1f905b82",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c02c9f18-33d8-4b11-9417-540d70ed529a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0d147c50-1bae-4729-986f-d9ea06c9a278",
"CreateDate": "2026-05-06T21:42:56.7670154-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-06T21:42:56.7670154-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": "25b18958-cd6c-4f1a-81e6-6e21b73ce4e5",
"CreateDate": "2026-05-06T21:42:56.7670154-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-06T21:42:56.7670154-07:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "520f1aad-ddf4-4d70-a263-d08ca3dca5fe",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1bea7de0-ea02-4d7e-a5b7-3fbcff8c0f64",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "65220446-ce3f-4fb8-87d1-5ffc2ad011b3",
"CreateDate": "2026-05-06T21:42:56.7670154-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-06T21:42:56.7670154-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-06T21:42:56.7670154-07:00",
"Fields": [
{
"FormTypeFieldId": "e5b61b5e-8b9d-4630-afca-58fc20944f81",
"Section": {
"FormTypeSectionId": "1a2b8cc2-35c8-4912-b4d0-117ab3b93e71",
"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": "1d2ace2e-c2d5-4b56-b522-5c6a1f905b82",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c02c9f18-33d8-4b11-9417-540d70ed529a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0d147c50-1bae-4729-986f-d9ea06c9a278",
"CreateDate": "2026-05-06T21:42:56.7670154-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-06T21:42:56.7670154-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": "e5b61b5e-8b9d-4630-afca-58fc20944f81",
"Section": {
"FormTypeSectionId": "1a2b8cc2-35c8-4912-b4d0-117ab3b93e71",
"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": "1d2ace2e-c2d5-4b56-b522-5c6a1f905b82",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c02c9f18-33d8-4b11-9417-540d70ed529a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0d147c50-1bae-4729-986f-d9ea06c9a278",
"CreateDate": "2026-05-06T21:42:56.7670154-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-06T21:42:56.7670154-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": "25b18958-cd6c-4f1a-81e6-6e21b73ce4e5",
"CreateDate": "2026-05-06T21:42:56.7670154-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-06T21:42:56.7670154-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}