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": "4cde45cd-d681-4e50-9a36-cef111090e0b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "dbbabfee-4924-429c-8926-0bdd0cdc466d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2b283f68-ab75-4f71-bff2-9ef4ef2ff739",
"CreateDate": "2026-04-18T04:56:19.9329082-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T04:56:19.9329082-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-18T04:56:19.9329082-07:00",
"Fields": [
{
"FormTypeFieldId": "24332c50-1aa2-4c7d-b7d0-777a776a221e",
"Section": {
"FormTypeSectionId": "76c37f5f-02c5-423e-badf-51cd573eff9d",
"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": "fbfc53f0-1261-485a-89ee-adf6257e48e0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "210d5ab4-b859-4983-b1a8-6410c1cc0935",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5573f5ef-bad6-464c-a269-c16d69f134cb",
"CreateDate": "2026-04-18T04:56:19.9329082-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T04:56:19.9329082-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7e858963-58d3-41d0-89e6-e410fe2694ac",
"FieldId": "d5d07959-03d4-4c2f-a279-529008f77a5c",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7e858963-58d3-41d0-89e6-e410fe2694ac",
"FieldId": "d5d07959-03d4-4c2f-a279-529008f77a5c",
"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": "24332c50-1aa2-4c7d-b7d0-777a776a221e",
"Section": {
"FormTypeSectionId": "76c37f5f-02c5-423e-badf-51cd573eff9d",
"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": "fbfc53f0-1261-485a-89ee-adf6257e48e0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "210d5ab4-b859-4983-b1a8-6410c1cc0935",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5573f5ef-bad6-464c-a269-c16d69f134cb",
"CreateDate": "2026-04-18T04:56:19.9329082-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T04:56:19.9329082-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7e858963-58d3-41d0-89e6-e410fe2694ac",
"FieldId": "d5d07959-03d4-4c2f-a279-529008f77a5c",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7e858963-58d3-41d0-89e6-e410fe2694ac",
"FieldId": "d5d07959-03d4-4c2f-a279-529008f77a5c",
"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": "82f5280b-c7b2-4248-b957-4d2a318fd589",
"CreateDate": "2026-04-18T04:56:19.9329082-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T04:56:19.9329082-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}