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": "d3c563a2-1967-4b2e-9387-fdef455ed77f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b8df499d-ad00-4d87-bf24-ab6315ec7d4d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "588bf18e-6fbd-40bf-a68a-c7c96a516368",
"CreateDate": "2026-06-22T01:39:07.7744863-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:39:07.7744863-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-22T01:39:07.7744863-07:00",
"Fields": [
{
"FormTypeFieldId": "bca0f568-43f3-4c7f-adc4-5eeca2aafbc6",
"Section": {
"FormTypeSectionId": "424f6b28-e848-4410-906b-29b6e2889640",
"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": "0b67fa33-9117-4511-ac24-2985aa7fac9d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ee95134d-f353-40fd-b266-dcfa18cc42be",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "352cfe62-7a13-46dc-86b9-58ca0fb8b022",
"CreateDate": "2026-06-22T01:39:07.7744863-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:39:07.7744863-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3123b86e-ee0f-4e08-acaf-ce965934f1ee",
"FieldId": "01b9544e-ebbd-4a19-8b4a-48bdf1e1e23b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3123b86e-ee0f-4e08-acaf-ce965934f1ee",
"FieldId": "01b9544e-ebbd-4a19-8b4a-48bdf1e1e23b",
"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": "bca0f568-43f3-4c7f-adc4-5eeca2aafbc6",
"Section": {
"FormTypeSectionId": "424f6b28-e848-4410-906b-29b6e2889640",
"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": "0b67fa33-9117-4511-ac24-2985aa7fac9d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ee95134d-f353-40fd-b266-dcfa18cc42be",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "352cfe62-7a13-46dc-86b9-58ca0fb8b022",
"CreateDate": "2026-06-22T01:39:07.7744863-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:39:07.7744863-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3123b86e-ee0f-4e08-acaf-ce965934f1ee",
"FieldId": "01b9544e-ebbd-4a19-8b4a-48bdf1e1e23b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3123b86e-ee0f-4e08-acaf-ce965934f1ee",
"FieldId": "01b9544e-ebbd-4a19-8b4a-48bdf1e1e23b",
"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": "70a3c396-7fc3-4a38-901e-a882f5e90e97",
"CreateDate": "2026-06-22T01:39:07.7744863-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:39:07.7744863-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}