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": "09b2c16d-10f2-45f7-950d-4b82d3b32ff5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ff250518-c106-43d1-959c-41193874e5e7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c64a8a85-fb03-4b7a-877a-09b3d9cc6d7c",
"CreateDate": "2025-12-17T04:25:44.9796453-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:25:44.9796453-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-17T04:25:44.9796453-08:00",
"Fields": [
{
"FormTypeFieldId": "74252df7-560b-4339-ac7c-09d9b83c77c5",
"Section": {
"FormTypeSectionId": "c871f41f-4156-4b92-aef4-13e0dccd1d0c",
"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": "a87ceff5-8f85-46c8-960f-dc76de0085f8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4bdd4574-e1f9-41cf-8f7e-67356096e8eb",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "97e2bae8-9246-4957-afea-d1e4d8bc0359",
"CreateDate": "2025-12-17T04:25:44.9796453-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:25:44.9796453-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6ce99a44-fadb-4aad-b12d-ab7ad0bc7574",
"FieldId": "ce26db43-c13a-4489-b87b-73c2e51b50ea",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6ce99a44-fadb-4aad-b12d-ab7ad0bc7574",
"FieldId": "ce26db43-c13a-4489-b87b-73c2e51b50ea",
"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": "74252df7-560b-4339-ac7c-09d9b83c77c5",
"Section": {
"FormTypeSectionId": "c871f41f-4156-4b92-aef4-13e0dccd1d0c",
"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": "a87ceff5-8f85-46c8-960f-dc76de0085f8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4bdd4574-e1f9-41cf-8f7e-67356096e8eb",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "97e2bae8-9246-4957-afea-d1e4d8bc0359",
"CreateDate": "2025-12-17T04:25:44.9796453-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:25:44.9796453-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6ce99a44-fadb-4aad-b12d-ab7ad0bc7574",
"FieldId": "ce26db43-c13a-4489-b87b-73c2e51b50ea",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6ce99a44-fadb-4aad-b12d-ab7ad0bc7574",
"FieldId": "ce26db43-c13a-4489-b87b-73c2e51b50ea",
"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": "05420621-3114-46ec-ab35-54b7d54e2c86",
"CreateDate": "2025-12-17T04:25:44.9796453-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:25:44.9796453-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}