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": "d3a7ccf4-fe5c-4ac6-9296-0d2486ada423",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fc37a75e-8468-4448-acfc-3e51f5ea3098",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f6d49011-63d2-4b39-9b1e-50fdd6353a19",
"CreateDate": "2025-06-22T22:59:08.6514946-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-22T22:59:08.6514946-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-06-22T22:59:08.6514946-07:00",
"Fields": [
{
"FormTypeFieldId": "bde1d557-ceb1-4719-b754-6d4a55fbec72",
"Section": {
"FormTypeSectionId": "e5441c87-5e77-46c6-ac75-906c705db9c9",
"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": "822f45a3-c3d1-44fd-a7e3-46fbe245fec2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3378ea15-9eb7-48bd-a85c-073f2255b728",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f17278a7-57cd-4e03-8622-3764141ac3f4",
"CreateDate": "2025-06-22T22:59:08.6514946-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-22T22:59:08.6514946-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": "bde1d557-ceb1-4719-b754-6d4a55fbec72",
"Section": {
"FormTypeSectionId": "e5441c87-5e77-46c6-ac75-906c705db9c9",
"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": "822f45a3-c3d1-44fd-a7e3-46fbe245fec2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3378ea15-9eb7-48bd-a85c-073f2255b728",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f17278a7-57cd-4e03-8622-3764141ac3f4",
"CreateDate": "2025-06-22T22:59:08.6514946-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-22T22:59:08.6514946-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": "b2b0718f-a918-4635-ab9f-539a7465fe4a",
"CreateDate": "2025-06-22T22:59:08.6514946-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-22T22:59:08.6514946-07:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "d3a7ccf4-fe5c-4ac6-9296-0d2486ada423",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fc37a75e-8468-4448-acfc-3e51f5ea3098",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f6d49011-63d2-4b39-9b1e-50fdd6353a19",
"CreateDate": "2025-06-22T22:59:08.6514946-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-22T22:59:08.6514946-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-06-22T22:59:08.6514946-07:00",
"Fields": [
{
"FormTypeFieldId": "bde1d557-ceb1-4719-b754-6d4a55fbec72",
"Section": {
"FormTypeSectionId": "e5441c87-5e77-46c6-ac75-906c705db9c9",
"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": "822f45a3-c3d1-44fd-a7e3-46fbe245fec2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3378ea15-9eb7-48bd-a85c-073f2255b728",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f17278a7-57cd-4e03-8622-3764141ac3f4",
"CreateDate": "2025-06-22T22:59:08.6514946-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-22T22:59:08.6514946-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": "bde1d557-ceb1-4719-b754-6d4a55fbec72",
"Section": {
"FormTypeSectionId": "e5441c87-5e77-46c6-ac75-906c705db9c9",
"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": "822f45a3-c3d1-44fd-a7e3-46fbe245fec2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3378ea15-9eb7-48bd-a85c-073f2255b728",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f17278a7-57cd-4e03-8622-3764141ac3f4",
"CreateDate": "2025-06-22T22:59:08.6514946-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-22T22:59:08.6514946-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": "b2b0718f-a918-4635-ab9f-539a7465fe4a",
"CreateDate": "2025-06-22T22:59:08.6514946-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-22T22:59:08.6514946-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}