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": "f4d92952-b223-42e2-91de-a474a184201d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0fc17632-7f56-475b-ade7-af08d03b67fb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e8adc9f6-29b9-4d64-accb-b47e5e9fb556",
"CreateDate": "2026-08-24T21:34:15.5055578-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:34:15.5055578-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-24T21:34:15.5055578-07:00",
"Fields": [
{
"FormTypeFieldId": "e7920677-9c2b-4c80-9793-d65d1f836523",
"Section": {
"FormTypeSectionId": "7dff338b-3653-4302-baf5-b7e038155ee1",
"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": "164fa8ea-400c-45be-a72c-0da8836529a5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e31abeb5-a807-489b-859f-d1d4ded2dc17",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "813f0bac-70ed-4acd-bb09-c47094c3a833",
"CreateDate": "2026-08-24T21:34:15.5055578-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:34:15.5055578-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3b5b8260-87a0-4e55-8046-9f7865631961",
"FieldId": "8cdd2c81-1b8c-438c-9215-239e3d78e268",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3b5b8260-87a0-4e55-8046-9f7865631961",
"FieldId": "8cdd2c81-1b8c-438c-9215-239e3d78e268",
"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": "e7920677-9c2b-4c80-9793-d65d1f836523",
"Section": {
"FormTypeSectionId": "7dff338b-3653-4302-baf5-b7e038155ee1",
"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": "164fa8ea-400c-45be-a72c-0da8836529a5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e31abeb5-a807-489b-859f-d1d4ded2dc17",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "813f0bac-70ed-4acd-bb09-c47094c3a833",
"CreateDate": "2026-08-24T21:34:15.5055578-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:34:15.5055578-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3b5b8260-87a0-4e55-8046-9f7865631961",
"FieldId": "8cdd2c81-1b8c-438c-9215-239e3d78e268",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3b5b8260-87a0-4e55-8046-9f7865631961",
"FieldId": "8cdd2c81-1b8c-438c-9215-239e3d78e268",
"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": "aae7d8b6-7ff9-4d2a-a39c-59c514ce32cb",
"CreateDate": "2026-08-24T21:34:15.5055578-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:34:15.5055578-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}