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": "75c57484-a8d3-4c19-8d4c-047510d3354e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c4f362f5-b113-4c62-89dd-df4741a802b9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9b4fcf6a-b496-4d42-8aed-532675b335ef",
"CreateDate": "2026-05-11T11:15:13.7831468-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:15:13.7831468-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-11T11:15:13.7831468-07:00",
"Fields": [
{
"FormTypeFieldId": "ca8fdd2f-78e7-4a24-b918-d3cd859576a1",
"Section": {
"FormTypeSectionId": "33e8ff9f-f098-426a-885d-e716cb62d0a5",
"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": "7d41786d-e4a6-44bb-a066-55437dfbb8f7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "49e20ba7-3e0e-49ff-8904-bb6fc30105ab",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f4240f96-ec64-4406-912b-6c689b177e77",
"CreateDate": "2026-05-11T11:15:13.7831468-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:15:13.7831468-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b31aaed5-e24c-4270-98fc-1fb68a87ea6a",
"FieldId": "ba401722-fc7c-40ed-b59c-b51d7baf378b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b31aaed5-e24c-4270-98fc-1fb68a87ea6a",
"FieldId": "ba401722-fc7c-40ed-b59c-b51d7baf378b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "ca8fdd2f-78e7-4a24-b918-d3cd859576a1",
"Section": {
"FormTypeSectionId": "33e8ff9f-f098-426a-885d-e716cb62d0a5",
"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": "7d41786d-e4a6-44bb-a066-55437dfbb8f7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "49e20ba7-3e0e-49ff-8904-bb6fc30105ab",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f4240f96-ec64-4406-912b-6c689b177e77",
"CreateDate": "2026-05-11T11:15:13.7831468-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:15:13.7831468-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b31aaed5-e24c-4270-98fc-1fb68a87ea6a",
"FieldId": "ba401722-fc7c-40ed-b59c-b51d7baf378b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b31aaed5-e24c-4270-98fc-1fb68a87ea6a",
"FieldId": "ba401722-fc7c-40ed-b59c-b51d7baf378b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "ed013cbf-d3f7-4fef-92c5-140abebd1d0c",
"CreateDate": "2026-05-11T11:15:13.7831468-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:15:13.7831468-07:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "75c57484-a8d3-4c19-8d4c-047510d3354e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c4f362f5-b113-4c62-89dd-df4741a802b9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9b4fcf6a-b496-4d42-8aed-532675b335ef",
"CreateDate": "2026-05-11T11:15:13.7831468-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:15:13.7831468-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-11T11:15:13.7831468-07:00",
"Fields": [
{
"FormTypeFieldId": "ca8fdd2f-78e7-4a24-b918-d3cd859576a1",
"Section": {
"FormTypeSectionId": "33e8ff9f-f098-426a-885d-e716cb62d0a5",
"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": "7d41786d-e4a6-44bb-a066-55437dfbb8f7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "49e20ba7-3e0e-49ff-8904-bb6fc30105ab",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f4240f96-ec64-4406-912b-6c689b177e77",
"CreateDate": "2026-05-11T11:15:13.7831468-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:15:13.7831468-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b31aaed5-e24c-4270-98fc-1fb68a87ea6a",
"FieldId": "ba401722-fc7c-40ed-b59c-b51d7baf378b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b31aaed5-e24c-4270-98fc-1fb68a87ea6a",
"FieldId": "ba401722-fc7c-40ed-b59c-b51d7baf378b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "ca8fdd2f-78e7-4a24-b918-d3cd859576a1",
"Section": {
"FormTypeSectionId": "33e8ff9f-f098-426a-885d-e716cb62d0a5",
"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": "7d41786d-e4a6-44bb-a066-55437dfbb8f7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "49e20ba7-3e0e-49ff-8904-bb6fc30105ab",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f4240f96-ec64-4406-912b-6c689b177e77",
"CreateDate": "2026-05-11T11:15:13.7831468-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:15:13.7831468-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b31aaed5-e24c-4270-98fc-1fb68a87ea6a",
"FieldId": "ba401722-fc7c-40ed-b59c-b51d7baf378b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b31aaed5-e24c-4270-98fc-1fb68a87ea6a",
"FieldId": "ba401722-fc7c-40ed-b59c-b51d7baf378b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "ed013cbf-d3f7-4fef-92c5-140abebd1d0c",
"CreateDate": "2026-05-11T11:15:13.7831468-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:15:13.7831468-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}