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": "d92b4f5e-3ca7-4b7b-8839-daf6f23b5c7a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ac871a71-d644-4f84-bab8-f60ae2016c85",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5b8d63e8-5b88-41af-b699-9dae57a219d8",
"CreateDate": "2026-02-23T12:23:35.9375902-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T12:23:35.9375902-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-23T12:23:35.9375902-08:00",
"Fields": [
{
"FormTypeFieldId": "81b7741c-63c8-4d4d-83d9-5f65227f52ee",
"Section": {
"FormTypeSectionId": "34f8dff6-71fd-48d6-9a7d-bec52f1ba7ab",
"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": "b6feb372-8b38-41b3-b47e-16a87d0643b6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0fa9907a-2bf2-4a42-8ba8-05fda7bd0275",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "610e89ab-810a-4ce8-96ef-422369204200",
"CreateDate": "2026-02-23T12:23:35.9375902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T12:23:35.9375902-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "aa5d0400-1701-4fe7-95b3-abe6fdc3228b",
"FieldId": "c0983cf1-6ce3-44aa-9ce0-776a61eb7c8a",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "aa5d0400-1701-4fe7-95b3-abe6fdc3228b",
"FieldId": "c0983cf1-6ce3-44aa-9ce0-776a61eb7c8a",
"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": "81b7741c-63c8-4d4d-83d9-5f65227f52ee",
"Section": {
"FormTypeSectionId": "34f8dff6-71fd-48d6-9a7d-bec52f1ba7ab",
"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": "b6feb372-8b38-41b3-b47e-16a87d0643b6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0fa9907a-2bf2-4a42-8ba8-05fda7bd0275",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "610e89ab-810a-4ce8-96ef-422369204200",
"CreateDate": "2026-02-23T12:23:35.9375902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T12:23:35.9375902-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "aa5d0400-1701-4fe7-95b3-abe6fdc3228b",
"FieldId": "c0983cf1-6ce3-44aa-9ce0-776a61eb7c8a",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "aa5d0400-1701-4fe7-95b3-abe6fdc3228b",
"FieldId": "c0983cf1-6ce3-44aa-9ce0-776a61eb7c8a",
"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": "b6a4d4f7-6c28-4886-81f6-e5ffb7113a8a",
"CreateDate": "2026-02-23T12:23:35.9375902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T12:23:35.9375902-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}