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": "452600b8-db04-4ffa-b038-eb4287c58eb0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bada1cf8-8e11-4950-a058-06c8546a63b6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a924defc-00b4-4b17-b8ac-75033af49506",
"CreateDate": "2026-02-03T02:18:28.4849385-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-03T02:18:28.4849385-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-03T02:18:28.4849385-08:00",
"Fields": [
{
"FormTypeFieldId": "1dd88713-e441-4fc9-b9f2-7891bb8d0d75",
"Section": {
"FormTypeSectionId": "721b4a4c-fa05-4a2e-9cd3-1407c1a665e7",
"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": "0ab81180-9309-4b89-9547-ff90adad48fe",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c58505e3-6211-4eec-b229-41600defa4d2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dcb93618-c7d5-423f-a748-78ddc7270e11",
"CreateDate": "2026-02-03T02:18:28.4849385-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-03T02:18:28.4849385-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "42fcd588-6092-4d93-a3db-e296961246fd",
"FieldId": "166ee5fb-a532-4fdf-b4a5-ada2503435b9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "42fcd588-6092-4d93-a3db-e296961246fd",
"FieldId": "166ee5fb-a532-4fdf-b4a5-ada2503435b9",
"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": "1dd88713-e441-4fc9-b9f2-7891bb8d0d75",
"Section": {
"FormTypeSectionId": "721b4a4c-fa05-4a2e-9cd3-1407c1a665e7",
"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": "0ab81180-9309-4b89-9547-ff90adad48fe",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c58505e3-6211-4eec-b229-41600defa4d2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dcb93618-c7d5-423f-a748-78ddc7270e11",
"CreateDate": "2026-02-03T02:18:28.4849385-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-03T02:18:28.4849385-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "42fcd588-6092-4d93-a3db-e296961246fd",
"FieldId": "166ee5fb-a532-4fdf-b4a5-ada2503435b9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "42fcd588-6092-4d93-a3db-e296961246fd",
"FieldId": "166ee5fb-a532-4fdf-b4a5-ada2503435b9",
"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": "1a886919-a67f-4211-9874-743f98eba83c",
"CreateDate": "2026-02-03T02:18:28.4849385-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-03T02:18:28.4849385-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}