GET FormTypes?formTypeId={formTypeId}
Retrieves a form type by its Id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| formTypeId |
Id of the form type |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the form type.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | FormType |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"FormTypeId": "28067b79-ad7b-4619-b615-46677dec180c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "88d90111-74d3-40e8-baad-0629966b91a4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "48673a6a-5db3-44ff-916c-fa93d9ba8799",
"CreateDate": "2026-06-01T20:26:53.0656564-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:26:53.0656564-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-01T20:26:53.0656564-07:00",
"Fields": [
{
"FormTypeFieldId": "eb97742b-3793-472f-a10a-8064a5953c87",
"Section": {
"FormTypeSectionId": "4476d36c-b485-453f-a5ad-69d3a5992b68",
"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": "76558c2a-e555-44dd-9cd2-1b7b969856c6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "389401dd-9a41-43fa-a474-f205c774e5ee",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "83972d8b-4448-4fdc-bb0d-8d86e88e5471",
"CreateDate": "2026-06-01T20:26:53.0656564-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:26:53.0656564-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6913adca-d6b3-454c-bf38-75a7033c6b69",
"FieldId": "815cea0b-b198-45aa-ae5c-a9f78714d8f9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6913adca-d6b3-454c-bf38-75a7033c6b69",
"FieldId": "815cea0b-b198-45aa-ae5c-a9f78714d8f9",
"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": "eb97742b-3793-472f-a10a-8064a5953c87",
"Section": {
"FormTypeSectionId": "4476d36c-b485-453f-a5ad-69d3a5992b68",
"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": "76558c2a-e555-44dd-9cd2-1b7b969856c6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "389401dd-9a41-43fa-a474-f205c774e5ee",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "83972d8b-4448-4fdc-bb0d-8d86e88e5471",
"CreateDate": "2026-06-01T20:26:53.0656564-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:26:53.0656564-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6913adca-d6b3-454c-bf38-75a7033c6b69",
"FieldId": "815cea0b-b198-45aa-ae5c-a9f78714d8f9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6913adca-d6b3-454c-bf38-75a7033c6b69",
"FieldId": "815cea0b-b198-45aa-ae5c-a9f78714d8f9",
"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": "4df05515-7a0a-4bb3-bf94-52c094b558d7",
"CreateDate": "2026-06-01T20:26:53.0656564-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:26:53.0656564-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}