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": "027834ef-9f20-483e-bc60-1567f139de5e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b64b9880-0074-4e97-9360-f258e207b0f2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f1bc46ca-1fbd-483b-b45c-1b9ad51f59b0",
"CreateDate": "2026-08-04T17:25:42.4136726-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:25:42.4136726-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-04T17:25:42.4136726-07:00",
"Fields": [
{
"FormTypeFieldId": "a6a1339a-8f4c-458f-b79d-b2157a5b8d49",
"Section": {
"FormTypeSectionId": "8da0c8d3-0024-4022-9265-b01b108440c9",
"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": "c53b4453-aa0f-4430-8dd8-c0be17731908",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "46e216df-0464-4d4d-8d54-69d099fc2464",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e21e6632-6653-45ac-b864-62d990a50efb",
"CreateDate": "2026-08-04T17:25:42.4136726-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:25:42.4136726-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9641303b-ccbd-4544-a6e0-f3643c9366fa",
"FieldId": "a27aab21-8b63-4949-99d3-6c245a452b67",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9641303b-ccbd-4544-a6e0-f3643c9366fa",
"FieldId": "a27aab21-8b63-4949-99d3-6c245a452b67",
"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": "a6a1339a-8f4c-458f-b79d-b2157a5b8d49",
"Section": {
"FormTypeSectionId": "8da0c8d3-0024-4022-9265-b01b108440c9",
"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": "c53b4453-aa0f-4430-8dd8-c0be17731908",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "46e216df-0464-4d4d-8d54-69d099fc2464",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e21e6632-6653-45ac-b864-62d990a50efb",
"CreateDate": "2026-08-04T17:25:42.4136726-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:25:42.4136726-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9641303b-ccbd-4544-a6e0-f3643c9366fa",
"FieldId": "a27aab21-8b63-4949-99d3-6c245a452b67",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9641303b-ccbd-4544-a6e0-f3643c9366fa",
"FieldId": "a27aab21-8b63-4949-99d3-6c245a452b67",
"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": "a6bae4d8-3fbd-472d-8d28-a77b979803cb",
"CreateDate": "2026-08-04T17:25:42.4136726-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:25:42.4136726-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}