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": "50fa3cb4-88a6-4eb8-bbac-ae3e2bb4449b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b6cbee2d-249d-480b-bda7-b47d3ebc5653",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dad68710-21e4-4a28-8444-09a52ca4ac43",
"CreateDate": "2026-10-04T02:40:09.7312769-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:40:09.7312769-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-04T02:40:09.7312769-07:00",
"Fields": [
{
"FormTypeFieldId": "49b865c9-6b4a-4c08-b9d1-7ae85f7e46d0",
"Section": {
"FormTypeSectionId": "8ebd44ef-11cd-47d6-ba9d-9b57096135a8",
"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": "c0f2678c-34d7-4d73-af4e-940f2a478b8a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f206e436-7e81-4e1a-ad65-a0466a22065e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "169a6031-f7cd-42eb-9f90-35e5e845dbde",
"CreateDate": "2026-10-04T02:40:09.7312769-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T02:40:09.7312769-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "46fc0e82-ebe1-4938-b083-c9b5cc915f2a",
"FieldId": "32f5ef19-5174-46b7-8f7f-a7d0a8c104f4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "46fc0e82-ebe1-4938-b083-c9b5cc915f2a",
"FieldId": "32f5ef19-5174-46b7-8f7f-a7d0a8c104f4",
"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": "49b865c9-6b4a-4c08-b9d1-7ae85f7e46d0",
"Section": {
"FormTypeSectionId": "8ebd44ef-11cd-47d6-ba9d-9b57096135a8",
"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": "c0f2678c-34d7-4d73-af4e-940f2a478b8a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f206e436-7e81-4e1a-ad65-a0466a22065e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "169a6031-f7cd-42eb-9f90-35e5e845dbde",
"CreateDate": "2026-10-04T02:40:09.7312769-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T02:40:09.7312769-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "46fc0e82-ebe1-4938-b083-c9b5cc915f2a",
"FieldId": "32f5ef19-5174-46b7-8f7f-a7d0a8c104f4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "46fc0e82-ebe1-4938-b083-c9b5cc915f2a",
"FieldId": "32f5ef19-5174-46b7-8f7f-a7d0a8c104f4",
"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": "5e6d4704-ff51-4796-928a-c7980f347b3c",
"CreateDate": "2026-10-04T02:40:09.7312769-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T02:40:09.7312769-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}