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": "e876854c-eaaa-4a7b-a916-a859c8c2ba3e",
"Asset": {
"AssetId": "bbb93af9-9508-4a1c-aa74-461e41bd23da",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "55822243-f203-4de3-b667-c108b6cef8cc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5cbd308-242f-40d7-b5c4-22a69e4c19c4",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "252e3c76-b657-4987-aa20-f3aba1400cc3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-19T07:50:53.5228374-08:00",
"MeasurementValueNeededDate": "2026-02-19T07:50:53.5228374-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "623b83b9-cfff-4803-8c00-f9a6cab234ac",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "042b8901-d40d-4dda-bb0a-d49dd823cd7c",
"EffectiveDate": "2026-02-19T07:50:53.5228374-08:00",
"StateType": {
"StateTypeId": "bdf175df-f372-4d82-9646-9e8e2f878f03",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "55822243-f203-4de3-b667-c108b6cef8cc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5cbd308-242f-40d7-b5c4-22a69e4c19c4",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "178d0fd8-883c-4d3f-b664-0cc33d3d13a0",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2fd6a705-3ba4-4914-a656-40675074e883",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "0903441b-5db3-4aa7-a0d5-c99d5a600804",
"EffectiveDate": "2026-02-19T07:50:53.5228374-08:00",
"StatusType": {
"StatusTypeId": "0db0d412-7663-43a7-a17e-0fb93dc83c03",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "55822243-f203-4de3-b667-c108b6cef8cc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5cbd308-242f-40d7-b5c4-22a69e4c19c4",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b4fb0ae7-cc31-4d15-9180-3592569fe70d",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "576eb27b-693d-4332-9e4f-b385e98e68bb",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5f363021-cd89-4d10-a1e6-f26efcb0e3b6",
"EffectiveDate": "2026-02-19T07:50:53.5228374-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "2fe496f4-5463-41ec-9202-2467885f6fbf",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2c29fe79-0a49-4cbe-9518-be9400d4d19f",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c321c277-df68-4752-be0b-6badfded2190",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-19T07:50:53.5228374-08:00",
"MeasurementValueNeededDate": "2026-02-19T07:50:53.5228374-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cdc9afa3-4009-4167-8b75-b951bc15cc0c",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "ee8b20f3-c138-4779-9e5e-f469c92db7f8",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "55822243-f203-4de3-b667-c108b6cef8cc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5cbd308-242f-40d7-b5c4-22a69e4c19c4",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-19T07:50:53.5228374-08:00",
"Fields": [
{
"FormTypeFieldId": "78764cd1-17c6-49eb-9e6c-772a6c7498fe",
"Section": {
"FormTypeSectionId": "97f5d91f-dea0-4c41-adfe-8d3cd4a6cc95",
"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": "d5b4b5e0-abc7-4e43-b878-2748d2588fce",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e05ca2e2-310c-453e-91a8-1bf3bce8b65e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cdf01395-ce3c-46cd-a5c4-5d6740ac107a",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f9fcbc58-86bd-444f-9457-9e5476dde568",
"FieldId": "c2f1dbd6-d89c-4739-beb7-2c18c845d04f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f9fcbc58-86bd-444f-9457-9e5476dde568",
"FieldId": "c2f1dbd6-d89c-4739-beb7-2c18c845d04f",
"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": "78764cd1-17c6-49eb-9e6c-772a6c7498fe",
"Section": {
"FormTypeSectionId": "97f5d91f-dea0-4c41-adfe-8d3cd4a6cc95",
"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": "d5b4b5e0-abc7-4e43-b878-2748d2588fce",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e05ca2e2-310c-453e-91a8-1bf3bce8b65e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cdf01395-ce3c-46cd-a5c4-5d6740ac107a",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f9fcbc58-86bd-444f-9457-9e5476dde568",
"FieldId": "c2f1dbd6-d89c-4739-beb7-2c18c845d04f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f9fcbc58-86bd-444f-9457-9e5476dde568",
"FieldId": "c2f1dbd6-d89c-4739-beb7-2c18c845d04f",
"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": "f056f0cb-320d-4266-88b8-4987d8003585",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-02-19T07:50:53.5228374-08:00",
"Location": "sample string 1",
"TaskId": "20555811-c0d9-4f6e-a104-6dd3cec496a2",
"Values": [
{
"FormFieldValueId": "fb930320-3a6a-4d4f-b394-2d1257ba2cd4",
"FormId": "a203e198-fa3d-462c-b2ba-d6f44205c903",
"FormTypeField": {
"FormTypeFieldId": "78764cd1-17c6-49eb-9e6c-772a6c7498fe",
"FormType": {
"FormTypeId": "ee8b20f3-c138-4779-9e5e-f469c92db7f8",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "55822243-f203-4de3-b667-c108b6cef8cc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5cbd308-242f-40d7-b5c4-22a69e4c19c4",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-19T07:50:53.5228374-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "f056f0cb-320d-4266-88b8-4987d8003585",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "97f5d91f-dea0-4c41-adfe-8d3cd4a6cc95",
"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": "d5b4b5e0-abc7-4e43-b878-2748d2588fce",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e05ca2e2-310c-453e-91a8-1bf3bce8b65e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cdf01395-ce3c-46cd-a5c4-5d6740ac107a",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f9fcbc58-86bd-444f-9457-9e5476dde568",
"FieldId": "c2f1dbd6-d89c-4739-beb7-2c18c845d04f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f9fcbc58-86bd-444f-9457-9e5476dde568",
"FieldId": "c2f1dbd6-d89c-4739-beb7-2c18c845d04f",
"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": "fb930320-3a6a-4d4f-b394-2d1257ba2cd4",
"FormId": "a203e198-fa3d-462c-b2ba-d6f44205c903",
"FormTypeField": {
"FormTypeFieldId": "78764cd1-17c6-49eb-9e6c-772a6c7498fe",
"FormType": {
"FormTypeId": "ee8b20f3-c138-4779-9e5e-f469c92db7f8",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "55822243-f203-4de3-b667-c108b6cef8cc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5cbd308-242f-40d7-b5c4-22a69e4c19c4",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-19T07:50:53.5228374-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "f056f0cb-320d-4266-88b8-4987d8003585",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "97f5d91f-dea0-4c41-adfe-8d3cd4a6cc95",
"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": "d5b4b5e0-abc7-4e43-b878-2748d2588fce",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e05ca2e2-310c-453e-91a8-1bf3bce8b65e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cdf01395-ce3c-46cd-a5c4-5d6740ac107a",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f9fcbc58-86bd-444f-9457-9e5476dde568",
"FieldId": "c2f1dbd6-d89c-4739-beb7-2c18c845d04f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f9fcbc58-86bd-444f-9457-9e5476dde568",
"FieldId": "c2f1dbd6-d89c-4739-beb7-2c18c845d04f",
"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": "4e814e9a-7c69-44bb-ac0d-e5171223171f",
"CreateDate": "2026-02-19T07:50:53.5228374-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-19T07:50:53.5228374-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}