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": "6d67af0d-5234-4d3c-a6d6-9c686bc1d999",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "77639040-667d-4720-b8f7-a7ecdecaf8d6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c9edb54a-2b8a-4e48-9a77-5f1d2fc6036f",
"CreateDate": "2026-03-30T12:46:02.8748375-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T12:46:02.8748375-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-30T12:46:02.8748375-07:00",
"Fields": [
{
"FormTypeFieldId": "81a56ef1-a9bb-47c5-adb0-db7d65c9ed83",
"Section": {
"FormTypeSectionId": "e3c2202e-64fe-4de0-a193-d750ff3eaed8",
"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": "77d710d4-e709-4301-a860-c43bbbfc8d13",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "419cd12a-e2c8-445f-a0d8-0db708bd7442",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e178469b-c509-4978-b87e-d60805bd7516",
"CreateDate": "2026-03-30T12:46:02.8748375-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T12:46:02.8748375-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "79837b56-aa61-4f48-861f-d1fd145410ec",
"FieldId": "ea0d0091-8127-445f-8cfc-0f781cb3cb82",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "79837b56-aa61-4f48-861f-d1fd145410ec",
"FieldId": "ea0d0091-8127-445f-8cfc-0f781cb3cb82",
"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": "81a56ef1-a9bb-47c5-adb0-db7d65c9ed83",
"Section": {
"FormTypeSectionId": "e3c2202e-64fe-4de0-a193-d750ff3eaed8",
"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": "77d710d4-e709-4301-a860-c43bbbfc8d13",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "419cd12a-e2c8-445f-a0d8-0db708bd7442",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e178469b-c509-4978-b87e-d60805bd7516",
"CreateDate": "2026-03-30T12:46:02.8748375-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T12:46:02.8748375-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "79837b56-aa61-4f48-861f-d1fd145410ec",
"FieldId": "ea0d0091-8127-445f-8cfc-0f781cb3cb82",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "79837b56-aa61-4f48-861f-d1fd145410ec",
"FieldId": "ea0d0091-8127-445f-8cfc-0f781cb3cb82",
"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": "37cf8568-2171-4a3b-b415-4ea033d5e666",
"CreateDate": "2026-03-30T12:46:02.8748375-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T12:46:02.8748375-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}