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": "f41f5e06-5ea3-43e4-903c-8dde094758de",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "85c28bb4-b598-410b-915c-4e8c3819fdb3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "eb6736ac-de29-43d0-bccd-eee858f25141",
"CreateDate": "2025-11-04T16:33:29.1119484-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:33:29.1119484-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-04T16:33:29.1119484-08:00",
"Fields": [
{
"FormTypeFieldId": "7a41cd79-9ed0-44ab-ad6d-f80e175abbb8",
"Section": {
"FormTypeSectionId": "1be0b65f-ed93-4d24-bf43-d681e67e24c1",
"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": "831947c7-cde7-428d-8d12-ed1183433fd8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "efb024a3-5192-4165-9ab9-ebcbf5671bec",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c71457a9-7f99-4865-b5bc-ece2e66b0ef8",
"CreateDate": "2025-11-04T16:33:29.1119484-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:33:29.1119484-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6539e2e9-f28a-4a4b-b7ed-4bf71df56964",
"FieldId": "40eb753e-7f29-4556-bea0-3b33988dd313",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6539e2e9-f28a-4a4b-b7ed-4bf71df56964",
"FieldId": "40eb753e-7f29-4556-bea0-3b33988dd313",
"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": "7a41cd79-9ed0-44ab-ad6d-f80e175abbb8",
"Section": {
"FormTypeSectionId": "1be0b65f-ed93-4d24-bf43-d681e67e24c1",
"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": "831947c7-cde7-428d-8d12-ed1183433fd8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "efb024a3-5192-4165-9ab9-ebcbf5671bec",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c71457a9-7f99-4865-b5bc-ece2e66b0ef8",
"CreateDate": "2025-11-04T16:33:29.1119484-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:33:29.1119484-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6539e2e9-f28a-4a4b-b7ed-4bf71df56964",
"FieldId": "40eb753e-7f29-4556-bea0-3b33988dd313",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6539e2e9-f28a-4a4b-b7ed-4bf71df56964",
"FieldId": "40eb753e-7f29-4556-bea0-3b33988dd313",
"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": "54aeb8fd-8879-46e2-8777-26f5fb73f627",
"CreateDate": "2025-11-04T16:33:29.1119484-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:33:29.1119484-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}