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": "aafe644d-fcf4-4a27-b486-00fb919710f9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9678c1c6-2ae3-425a-b8cb-3bc161628ad5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7a137a37-9440-4022-b2c2-e1ef6878181c",
"CreateDate": "2026-05-12T17:06:09.9447171-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:06:09.9447171-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-12T17:06:09.9447171-07:00",
"Fields": [
{
"FormTypeFieldId": "57dc38fd-960c-407a-a4eb-bef221a6edb9",
"Section": {
"FormTypeSectionId": "a4163503-ddba-45ac-8ebd-68f8fdb2b4ab",
"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": "3bcfda8d-0199-403a-a79d-f05785c79dcc",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c7277ed3-f634-473f-b3c9-fb925d4bb5a0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c2393743-cbeb-4d78-9290-d9553c9f8928",
"CreateDate": "2026-05-12T17:06:09.9447171-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:06:09.9447171-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ee912978-85f4-4c81-9bca-2103279a0bf6",
"FieldId": "1334e5e1-ab41-460e-b265-b726aabefeae",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ee912978-85f4-4c81-9bca-2103279a0bf6",
"FieldId": "1334e5e1-ab41-460e-b265-b726aabefeae",
"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": "57dc38fd-960c-407a-a4eb-bef221a6edb9",
"Section": {
"FormTypeSectionId": "a4163503-ddba-45ac-8ebd-68f8fdb2b4ab",
"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": "3bcfda8d-0199-403a-a79d-f05785c79dcc",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c7277ed3-f634-473f-b3c9-fb925d4bb5a0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c2393743-cbeb-4d78-9290-d9553c9f8928",
"CreateDate": "2026-05-12T17:06:09.9447171-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:06:09.9447171-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ee912978-85f4-4c81-9bca-2103279a0bf6",
"FieldId": "1334e5e1-ab41-460e-b265-b726aabefeae",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ee912978-85f4-4c81-9bca-2103279a0bf6",
"FieldId": "1334e5e1-ab41-460e-b265-b726aabefeae",
"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": "b7d848cf-1305-48be-bc0c-1974376aea80",
"CreateDate": "2026-05-12T17:06:09.9447171-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:06:09.9447171-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}