GET Forms?formId={formId}
Retrieves a form by its Id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| formId |
Id of the form |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the form.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Form |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"FormId": "8aaaf4b6-03d7-4516-9330-fa7fb66d3ab6",
"Asset": {
"AssetId": "23a7c2e7-0939-4460-8186-30a1531dc6c8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fbbc6407-dfff-4978-b018-05d3d7e5bdb6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "115b2ad1-07a8-4240-918a-435ffdae802d",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "86f297ca-beed-4b15-8d58-6efa0c6127ea",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-31T12:43:32.7399651-07:00",
"MeasurementValueNeededDate": "2026-03-31T12:43:32.7399651-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f1d3af83-af52-44b2-88d4-2e297f5abaa0",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "01dd3ec2-c7fc-4f4d-be02-85e65952a839",
"EffectiveDate": "2026-03-31T12:43:32.7399651-07:00",
"StateType": {
"StateTypeId": "f8d8f363-5123-4740-9da4-5f8eec188493",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "fbbc6407-dfff-4978-b018-05d3d7e5bdb6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "115b2ad1-07a8-4240-918a-435ffdae802d",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "77f5e541-8712-4f48-b3b7-72de45a0128d",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "589e78e3-b9e4-4105-b741-f0b54e2b26dd",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f878805d-9e4c-4428-afe1-9f46b0fb9385",
"EffectiveDate": "2026-03-31T12:43:32.7399651-07:00",
"StatusType": {
"StatusTypeId": "65d4a012-8f3b-49be-a475-08f7cbf4a839",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "fbbc6407-dfff-4978-b018-05d3d7e5bdb6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "115b2ad1-07a8-4240-918a-435ffdae802d",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "4a3524e4-dbf2-4322-bdbc-29ff2c6160cc",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1182a3ff-b6aa-4e99-85b7-4e3840ee066d",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "63902ef4-d0c4-472d-bfcc-0060dac3afb3",
"EffectiveDate": "2026-03-31T12:43:32.7399651-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b67d9cee-f7d6-42a5-8aa3-f2e808972738",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4d416ea5-af17-4a58-87af-7742a24d26c4",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "04599aac-a30a-4905-acf7-2149ed3a7535",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-31T12:43:32.7399651-07:00",
"MeasurementValueNeededDate": "2026-03-31T12:43:32.7399651-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d63827a6-4906-4e05-b98d-42c75173779c",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "d044ad50-a038-4015-8ee9-fc273416e774",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fbbc6407-dfff-4978-b018-05d3d7e5bdb6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "115b2ad1-07a8-4240-918a-435ffdae802d",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-31T12:43:32.7399651-07:00",
"Fields": [
{
"FormTypeFieldId": "e736541c-8628-4b5c-a80e-14dc7dded155",
"Section": {
"FormTypeSectionId": "207d12f3-0ce7-491d-a2c4-5f9b0f753c74",
"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": "e5821762-322a-4a0c-8407-acff6c213521",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "39738dba-e677-434c-9a21-889b1d53da73",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "56a04404-bce6-4d7f-88b6-c46b02429439",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "66b93741-885e-4f6e-8002-3b30d0d9caa0",
"FieldId": "09935a67-0ec2-47e0-8d7b-53674ed62800",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "66b93741-885e-4f6e-8002-3b30d0d9caa0",
"FieldId": "09935a67-0ec2-47e0-8d7b-53674ed62800",
"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": "e736541c-8628-4b5c-a80e-14dc7dded155",
"Section": {
"FormTypeSectionId": "207d12f3-0ce7-491d-a2c4-5f9b0f753c74",
"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": "e5821762-322a-4a0c-8407-acff6c213521",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "39738dba-e677-434c-9a21-889b1d53da73",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "56a04404-bce6-4d7f-88b6-c46b02429439",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "66b93741-885e-4f6e-8002-3b30d0d9caa0",
"FieldId": "09935a67-0ec2-47e0-8d7b-53674ed62800",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "66b93741-885e-4f6e-8002-3b30d0d9caa0",
"FieldId": "09935a67-0ec2-47e0-8d7b-53674ed62800",
"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": "bb317a37-b499-4d06-bf2e-4a48e965d604",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-03-31T12:43:32.7399651-07:00",
"Location": "sample string 1",
"TaskId": "aba57b3c-7f45-4f87-8eae-9d8413dfc1b6",
"Values": [
{
"FormFieldValueId": "5a08b9df-b51f-4c1a-9f29-867a97b4a6f8",
"FormId": "3cb36d91-10ae-4cc9-8637-1b7868f354eb",
"FormTypeField": {
"FormTypeFieldId": "e736541c-8628-4b5c-a80e-14dc7dded155",
"FormType": {
"FormTypeId": "d044ad50-a038-4015-8ee9-fc273416e774",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fbbc6407-dfff-4978-b018-05d3d7e5bdb6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "115b2ad1-07a8-4240-918a-435ffdae802d",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-31T12:43:32.7399651-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "bb317a37-b499-4d06-bf2e-4a48e965d604",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "207d12f3-0ce7-491d-a2c4-5f9b0f753c74",
"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": "e5821762-322a-4a0c-8407-acff6c213521",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "39738dba-e677-434c-9a21-889b1d53da73",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "56a04404-bce6-4d7f-88b6-c46b02429439",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "66b93741-885e-4f6e-8002-3b30d0d9caa0",
"FieldId": "09935a67-0ec2-47e0-8d7b-53674ed62800",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "66b93741-885e-4f6e-8002-3b30d0d9caa0",
"FieldId": "09935a67-0ec2-47e0-8d7b-53674ed62800",
"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"
},
"SectionIndex": 1,
"FieldIndex": 1,
"FileName": "sample string 1",
"FileType": "sample string 2",
"FileSize": 1,
"FileContent": "QEA=",
"ValueText": "sample string 3",
"IsValid": true,
"IsValidMessage": "sample string 5",
"SourceSystemId": "sample string 6"
},
{
"FormFieldValueId": "5a08b9df-b51f-4c1a-9f29-867a97b4a6f8",
"FormId": "3cb36d91-10ae-4cc9-8637-1b7868f354eb",
"FormTypeField": {
"FormTypeFieldId": "e736541c-8628-4b5c-a80e-14dc7dded155",
"FormType": {
"FormTypeId": "d044ad50-a038-4015-8ee9-fc273416e774",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fbbc6407-dfff-4978-b018-05d3d7e5bdb6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "115b2ad1-07a8-4240-918a-435ffdae802d",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-31T12:43:32.7399651-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "bb317a37-b499-4d06-bf2e-4a48e965d604",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "207d12f3-0ce7-491d-a2c4-5f9b0f753c74",
"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": "e5821762-322a-4a0c-8407-acff6c213521",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "39738dba-e677-434c-9a21-889b1d53da73",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "56a04404-bce6-4d7f-88b6-c46b02429439",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "66b93741-885e-4f6e-8002-3b30d0d9caa0",
"FieldId": "09935a67-0ec2-47e0-8d7b-53674ed62800",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "66b93741-885e-4f6e-8002-3b30d0d9caa0",
"FieldId": "09935a67-0ec2-47e0-8d7b-53674ed62800",
"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"
},
"SectionIndex": 1,
"FieldIndex": 1,
"FileName": "sample string 1",
"FileType": "sample string 2",
"FileSize": 1,
"FileContent": "QEA=",
"ValueText": "sample string 3",
"IsValid": true,
"IsValidMessage": "sample string 5",
"SourceSystemId": "sample string 6"
}
],
"SourceSystemId": "sample string 2",
"CompanyId": "92ae74d4-10ef-41c6-9117-b45ac0e6b129",
"CreateDate": "2026-03-31T12:43:32.7399651-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-31T12:43:32.7399651-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}