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": "682c3b03-da0f-4754-83cc-7d31f614d2e9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9c1f032e-bb66-4de2-830c-47f8da5d5e55",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1a04b88f-a00e-46f2-a5d4-c1aaff15bf17",
"CreateDate": "2026-06-17T17:25:14.9027748-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:25:14.9027748-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-17T17:25:14.9027748-07:00",
"Fields": [
{
"FormTypeFieldId": "b63134ca-6e52-4ac9-835e-97a153f1e1ff",
"Section": {
"FormTypeSectionId": "50eb7ec1-7e71-4168-a87a-798b74a51af5",
"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": "78996d37-fd54-495a-9fa2-66bdcd777a82",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5a3e011a-066d-46aa-bc7b-363beabd9152",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "98d95bde-f5b1-476b-b632-85b8c71792fd",
"CreateDate": "2026-06-17T17:25:14.9027748-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:25:14.9027748-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "364a681f-efa8-41d1-b9ff-ca93db51f45d",
"FieldId": "49e2b5db-dc8f-4601-a58d-a8a36d1afc0d",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "364a681f-efa8-41d1-b9ff-ca93db51f45d",
"FieldId": "49e2b5db-dc8f-4601-a58d-a8a36d1afc0d",
"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": "b63134ca-6e52-4ac9-835e-97a153f1e1ff",
"Section": {
"FormTypeSectionId": "50eb7ec1-7e71-4168-a87a-798b74a51af5",
"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": "78996d37-fd54-495a-9fa2-66bdcd777a82",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5a3e011a-066d-46aa-bc7b-363beabd9152",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "98d95bde-f5b1-476b-b632-85b8c71792fd",
"CreateDate": "2026-06-17T17:25:14.9027748-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:25:14.9027748-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "364a681f-efa8-41d1-b9ff-ca93db51f45d",
"FieldId": "49e2b5db-dc8f-4601-a58d-a8a36d1afc0d",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "364a681f-efa8-41d1-b9ff-ca93db51f45d",
"FieldId": "49e2b5db-dc8f-4601-a58d-a8a36d1afc0d",
"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": "b83d4f90-0564-4cfb-902a-20de0c88d751",
"CreateDate": "2026-06-17T17:25:14.9027748-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:25:14.9027748-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}