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": "25cf2dfb-7005-441d-80fd-7ff99300bf1d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1df4ebb9-9fc9-447b-b39e-17ab7432fb6d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "940596de-23cd-458e-86e1-7c8b2874e1d8",
"CreateDate": "2026-11-01T08:49:08.1979923-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:49:08.1979923-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-01T08:49:08.1979923-08:00",
"Fields": [
{
"FormTypeFieldId": "83e927eb-1fdc-4eea-b8a1-80966693bab6",
"Section": {
"FormTypeSectionId": "b13b72fe-6e72-494d-a4c3-8eac21d4740e",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "00d5fcaf-628b-43d2-aa80-15036742be2f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "00b93646-0518-4fc2-ac51-3f3a15b2a3e7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "330fcf13-6258-4db6-b29b-364a0f8d07c3",
"CreateDate": "2026-11-01T08:49:08.1979923-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:49:08.1979923-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "792513ec-b14b-4e51-bd25-c757a54cc83e",
"FieldId": "d7288ee3-fdf3-4441-8c27-3917de4fda78",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "792513ec-b14b-4e51-bd25-c757a54cc83e",
"FieldId": "d7288ee3-fdf3-4441-8c27-3917de4fda78",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
{
"FormTypeFieldId": "83e927eb-1fdc-4eea-b8a1-80966693bab6",
"Section": {
"FormTypeSectionId": "b13b72fe-6e72-494d-a4c3-8eac21d4740e",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "00d5fcaf-628b-43d2-aa80-15036742be2f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "00b93646-0518-4fc2-ac51-3f3a15b2a3e7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "330fcf13-6258-4db6-b29b-364a0f8d07c3",
"CreateDate": "2026-11-01T08:49:08.1979923-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:49:08.1979923-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "792513ec-b14b-4e51-bd25-c757a54cc83e",
"FieldId": "d7288ee3-fdf3-4441-8c27-3917de4fda78",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "792513ec-b14b-4e51-bd25-c757a54cc83e",
"FieldId": "d7288ee3-fdf3-4441-8c27-3917de4fda78",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "3a58a7ea-ccfa-4984-985a-5afaa9a4864e",
"CreateDate": "2026-11-01T08:49:08.1979923-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:49:08.1979923-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}