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": "3b7c8320-913d-4b34-8c79-301604383573",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "951b2eaf-4e93-4ca9-acd7-67eb65ef8b55",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "324462a5-585d-47dc-9aa1-b7169e55b953",
"CreateDate": "2026-07-15T13:20:43.0427051-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:20:43.0427051-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-15T13:20:43.0427051-07:00",
"Fields": [
{
"FormTypeFieldId": "21fa27e9-8a2d-48e0-a2ee-491e10a33741",
"Section": {
"FormTypeSectionId": "bd378c05-6053-4dff-95af-3aed4261a763",
"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": "07ad5940-7f3b-421e-b06d-a53b00007c3c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "428281ad-3c71-45e9-8281-a0f396c7d757",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2294dbf5-6da8-4354-88fd-bb2c5855432d",
"CreateDate": "2026-07-15T13:20:43.0427051-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:20:43.0427051-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "be8d6673-590b-41e8-afc4-e2ca4f9816d8",
"FieldId": "8f547fcf-0853-40b9-980a-3f5def34d4bf",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "be8d6673-590b-41e8-afc4-e2ca4f9816d8",
"FieldId": "8f547fcf-0853-40b9-980a-3f5def34d4bf",
"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": "21fa27e9-8a2d-48e0-a2ee-491e10a33741",
"Section": {
"FormTypeSectionId": "bd378c05-6053-4dff-95af-3aed4261a763",
"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": "07ad5940-7f3b-421e-b06d-a53b00007c3c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "428281ad-3c71-45e9-8281-a0f396c7d757",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2294dbf5-6da8-4354-88fd-bb2c5855432d",
"CreateDate": "2026-07-15T13:20:43.0427051-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:20:43.0427051-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "be8d6673-590b-41e8-afc4-e2ca4f9816d8",
"FieldId": "8f547fcf-0853-40b9-980a-3f5def34d4bf",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "be8d6673-590b-41e8-afc4-e2ca4f9816d8",
"FieldId": "8f547fcf-0853-40b9-980a-3f5def34d4bf",
"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": "699a736e-e9c6-4fad-a0f7-f0f7f5c512a4",
"CreateDate": "2026-07-15T13:20:43.0427051-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:20:43.0427051-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}