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": "cfd61725-4ada-4016-a326-d0f03c06b389",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fe5813b7-d69a-4c1d-a9fd-513aec58cc61",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9315c3d8-67f6-40fb-a10b-84bfa57d423d",
"CreateDate": "2026-08-11T22:24:27.0027666-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:24:27.0027666-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-11T22:24:27.0027666-07:00",
"Fields": [
{
"FormTypeFieldId": "25c5bb8b-ff10-44dc-a981-b378369f3006",
"Section": {
"FormTypeSectionId": "dd748dd8-d3ce-4a8f-90be-d4ba6690702b",
"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": "650a1370-1476-4691-a7eb-70e4df09aa73",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e7c90d2e-6c9d-4ec6-ac7d-a10db7c00797",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b18e039c-ebe1-451a-bca7-935799d527d8",
"CreateDate": "2026-08-11T22:24:27.0027666-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:24:27.0027666-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e09a96ca-57d2-4c37-bee8-11f301dde1e9",
"FieldId": "21d1a59f-84ef-4202-b7d3-efb20e20667f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e09a96ca-57d2-4c37-bee8-11f301dde1e9",
"FieldId": "21d1a59f-84ef-4202-b7d3-efb20e20667f",
"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": "25c5bb8b-ff10-44dc-a981-b378369f3006",
"Section": {
"FormTypeSectionId": "dd748dd8-d3ce-4a8f-90be-d4ba6690702b",
"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": "650a1370-1476-4691-a7eb-70e4df09aa73",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e7c90d2e-6c9d-4ec6-ac7d-a10db7c00797",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b18e039c-ebe1-451a-bca7-935799d527d8",
"CreateDate": "2026-08-11T22:24:27.0027666-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:24:27.0027666-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e09a96ca-57d2-4c37-bee8-11f301dde1e9",
"FieldId": "21d1a59f-84ef-4202-b7d3-efb20e20667f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e09a96ca-57d2-4c37-bee8-11f301dde1e9",
"FieldId": "21d1a59f-84ef-4202-b7d3-efb20e20667f",
"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": "01bb778c-a3b5-438f-aa3b-9c56b8075f46",
"CreateDate": "2026-08-11T22:24:27.0183893-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:24:27.0183893-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}