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": "829ad15b-03b2-4515-ba7c-61e36e6ee92c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c32c5f45-4c00-42d5-8b7d-d73d1020e8d8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "58d5427a-54ef-47d5-9cff-60deae7e9ca5",
"CreateDate": "2026-11-22T14:12:51.8717023-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:51.8717023-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-22T14:12:51.8717023-08:00",
"Fields": [
{
"FormTypeFieldId": "866fb39e-0a32-4c71-b349-4ada5886c126",
"Section": {
"FormTypeSectionId": "aba3beee-a9e4-46cd-9ee0-97ba74d621a6",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "ef8fbff8-71cf-4295-ab5d-4569ef141f4b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b0de4715-d949-4078-9b5b-230dcb33dd2a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "eef78ae1-3b92-4a96-953b-397d66d9d83d",
"CreateDate": "2026-11-22T14:12:51.8717023-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:51.8717023-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9b643815-0532-4916-a3e8-491f4f5a511d",
"FieldId": "2277b649-9b46-4ea3-9855-2a4f9f496096",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9b643815-0532-4916-a3e8-491f4f5a511d",
"FieldId": "2277b649-9b46-4ea3-9855-2a4f9f496096",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
{
"FormTypeFieldId": "866fb39e-0a32-4c71-b349-4ada5886c126",
"Section": {
"FormTypeSectionId": "aba3beee-a9e4-46cd-9ee0-97ba74d621a6",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "ef8fbff8-71cf-4295-ab5d-4569ef141f4b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b0de4715-d949-4078-9b5b-230dcb33dd2a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "eef78ae1-3b92-4a96-953b-397d66d9d83d",
"CreateDate": "2026-11-22T14:12:51.8717023-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:51.8717023-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9b643815-0532-4916-a3e8-491f4f5a511d",
"FieldId": "2277b649-9b46-4ea3-9855-2a4f9f496096",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9b643815-0532-4916-a3e8-491f4f5a511d",
"FieldId": "2277b649-9b46-4ea3-9855-2a4f9f496096",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7e7c3612-d9e6-4148-83fa-1411d3a10338",
"CreateDate": "2026-11-22T14:12:51.8717023-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:51.8717023-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}