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": "69c764cf-0e44-4366-9ffe-8c3d3b57a9de",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a5290c6f-9bcf-4773-8a14-7107221128d1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "29e5bcd5-b1b6-4d11-bcdc-d387356c47b1",
"CreateDate": "2026-01-07T15:55:53.0756235-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T15:55:53.0756235-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-07T15:55:53.0756235-08:00",
"Fields": [
{
"FormTypeFieldId": "14f69f83-7b5c-40a8-a8fc-9a1592bbbec7",
"Section": {
"FormTypeSectionId": "fabe11b9-f2ed-4a07-b94c-578ea5c0c75b",
"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": "0c5afda4-6656-4828-838a-94f70996ccef",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ff9282b2-76d5-461c-8048-658c82c4a5c9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9bf9ceaf-4a3f-4a8b-a801-a68f519bc6b9",
"CreateDate": "2026-01-07T15:55:53.0756235-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-07T15:55:53.0756235-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4db801c7-707f-42c7-8a94-45374cdcd4a4",
"FieldId": "644743a8-d133-420a-9380-849f5c4a89a5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4db801c7-707f-42c7-8a94-45374cdcd4a4",
"FieldId": "644743a8-d133-420a-9380-849f5c4a89a5",
"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": "14f69f83-7b5c-40a8-a8fc-9a1592bbbec7",
"Section": {
"FormTypeSectionId": "fabe11b9-f2ed-4a07-b94c-578ea5c0c75b",
"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": "0c5afda4-6656-4828-838a-94f70996ccef",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ff9282b2-76d5-461c-8048-658c82c4a5c9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9bf9ceaf-4a3f-4a8b-a801-a68f519bc6b9",
"CreateDate": "2026-01-07T15:55:53.0756235-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-07T15:55:53.0756235-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4db801c7-707f-42c7-8a94-45374cdcd4a4",
"FieldId": "644743a8-d133-420a-9380-849f5c4a89a5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4db801c7-707f-42c7-8a94-45374cdcd4a4",
"FieldId": "644743a8-d133-420a-9380-849f5c4a89a5",
"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": "cc7c2eb0-b33e-42da-ad3a-09d8c3907ff8",
"CreateDate": "2026-01-07T15:55:53.0756235-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-07T15:55:53.0756235-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}