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": "649ee2a9-414d-4dd3-8449-8c17d4bdcf4c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b23af3b8-6b82-4a1d-8029-bfba5187818c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2c2d70ca-d72e-46e8-adfd-7c3c5d2e3bf0",
"CreateDate": "2026-11-21T11:54:29.8976178-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:54:29.8976178-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T11:54:29.8976178-08:00",
"Fields": [
{
"FormTypeFieldId": "d2779290-b021-4cd6-abf8-4d9f0849e7c7",
"Section": {
"FormTypeSectionId": "48c2cac8-4fde-44cc-8f9b-8f60a9dc7293",
"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": "aedcc324-e922-486d-a38a-21f73a4c04a5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "74b3658c-740b-4e4a-b470-753764e513ab",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a46a20b9-6bfd-40bf-bcb8-a610e516e63e",
"CreateDate": "2026-11-21T11:54:29.8976178-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:54:29.8976178-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ede48ec6-0a06-41b8-a3d4-e5343e7ab357",
"FieldId": "ea29cc6a-91dd-4822-8292-e241ad43e29a",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ede48ec6-0a06-41b8-a3d4-e5343e7ab357",
"FieldId": "ea29cc6a-91dd-4822-8292-e241ad43e29a",
"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": "d2779290-b021-4cd6-abf8-4d9f0849e7c7",
"Section": {
"FormTypeSectionId": "48c2cac8-4fde-44cc-8f9b-8f60a9dc7293",
"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": "aedcc324-e922-486d-a38a-21f73a4c04a5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "74b3658c-740b-4e4a-b470-753764e513ab",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a46a20b9-6bfd-40bf-bcb8-a610e516e63e",
"CreateDate": "2026-11-21T11:54:29.8976178-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:54:29.8976178-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ede48ec6-0a06-41b8-a3d4-e5343e7ab357",
"FieldId": "ea29cc6a-91dd-4822-8292-e241ad43e29a",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ede48ec6-0a06-41b8-a3d4-e5343e7ab357",
"FieldId": "ea29cc6a-91dd-4822-8292-e241ad43e29a",
"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": "eb0c84fa-b03e-4d0e-939b-075308e95330",
"CreateDate": "2026-11-21T11:54:29.8976178-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:54:29.8976178-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}