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": "df51109d-0e03-47e4-b775-461f9e5094aa",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "7fdec975-fdc8-4003-895d-6052f04cf1d8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "947ff078-5f10-4e19-a4ee-48dc747b35bf",
"CreateDate": "2026-10-11T16:59:59.0497856-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-11T16:59:59.0497856-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-11T16:59:59.0497856-07:00",
"Fields": [
{
"FormTypeFieldId": "ac1207d1-02da-4b58-9311-143af45d35f4",
"Section": {
"FormTypeSectionId": "c6a2ad1e-e68e-45ca-93cc-9ed9c669e48b",
"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": "38c700ec-3b76-4af1-9534-07b9541aa0b3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "edab0e8b-b3a4-4353-bad2-00a1fd6a59eb",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6c514337-e753-4001-abfc-3c8b0b90ccac",
"CreateDate": "2026-10-11T16:59:59.0497856-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-11T16:59:59.0497856-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": "ac1207d1-02da-4b58-9311-143af45d35f4",
"Section": {
"FormTypeSectionId": "c6a2ad1e-e68e-45ca-93cc-9ed9c669e48b",
"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": "38c700ec-3b76-4af1-9534-07b9541aa0b3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "edab0e8b-b3a4-4353-bad2-00a1fd6a59eb",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6c514337-e753-4001-abfc-3c8b0b90ccac",
"CreateDate": "2026-10-11T16:59:59.0497856-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-11T16:59:59.0497856-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": "e3a2909a-90b9-4c76-8537-88511a6aeba0",
"CreateDate": "2026-10-11T16:59:59.0497856-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-11T16:59:59.0497856-07:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "df51109d-0e03-47e4-b775-461f9e5094aa",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "7fdec975-fdc8-4003-895d-6052f04cf1d8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "947ff078-5f10-4e19-a4ee-48dc747b35bf",
"CreateDate": "2026-10-11T16:59:59.0497856-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-11T16:59:59.0497856-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-11T16:59:59.0497856-07:00",
"Fields": [
{
"FormTypeFieldId": "ac1207d1-02da-4b58-9311-143af45d35f4",
"Section": {
"FormTypeSectionId": "c6a2ad1e-e68e-45ca-93cc-9ed9c669e48b",
"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": "38c700ec-3b76-4af1-9534-07b9541aa0b3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "edab0e8b-b3a4-4353-bad2-00a1fd6a59eb",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6c514337-e753-4001-abfc-3c8b0b90ccac",
"CreateDate": "2026-10-11T16:59:59.0497856-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-11T16:59:59.0497856-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": "ac1207d1-02da-4b58-9311-143af45d35f4",
"Section": {
"FormTypeSectionId": "c6a2ad1e-e68e-45ca-93cc-9ed9c669e48b",
"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": "38c700ec-3b76-4af1-9534-07b9541aa0b3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "edab0e8b-b3a4-4353-bad2-00a1fd6a59eb",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6c514337-e753-4001-abfc-3c8b0b90ccac",
"CreateDate": "2026-10-11T16:59:59.0497856-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-11T16:59:59.0497856-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": "e3a2909a-90b9-4c76-8537-88511a6aeba0",
"CreateDate": "2026-10-11T16:59:59.0497856-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-11T16:59:59.0497856-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}