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": "1eb3ab7e-127d-427e-9508-92cecec22841",
"Asset": {
"AssetId": "c53014de-8989-4b5d-a8b6-a06e729a238c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a9a300a5-6b55-489f-a8a6-f67670ac62d0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b14cce4b-5204-4d72-aee8-c4f7f2c2abc7",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8257005f-c12a-4e78-bf34-4437501d3f1e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-13T22:25:35.0553375-07:00",
"MeasurementValueNeededDate": "2026-04-13T22:25:35.0553375-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d81cf4c3-eadf-43b0-9e61-fe3217353c3d",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b8395445-9c6b-4985-8ece-1f5ca6c1dbef",
"EffectiveDate": "2026-04-13T22:25:35.0553375-07:00",
"StateType": {
"StateTypeId": "13b4ba95-0f82-4766-843f-edc581824bdc",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a9a300a5-6b55-489f-a8a6-f67670ac62d0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b14cce4b-5204-4d72-aee8-c4f7f2c2abc7",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e77c0788-47bc-40d5-ad32-43a05535d413",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9354cbec-3fee-41b8-b754-af264c5a7411",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "61bd48ec-1643-4599-9635-4cc938969598",
"EffectiveDate": "2026-04-13T22:25:35.0553375-07:00",
"StatusType": {
"StatusTypeId": "1210a5ce-d7ac-40f7-9278-0aa0ebac8408",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a9a300a5-6b55-489f-a8a6-f67670ac62d0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b14cce4b-5204-4d72-aee8-c4f7f2c2abc7",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ede8aba4-81a2-423c-8349-23ca6e8cdebe",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c4cd765c-34e7-437d-9f62-f9b898665e7a",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "fbd49a03-d845-40fa-aa2a-31231f0352db",
"EffectiveDate": "2026-04-13T22:25:35.0553375-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "bf2e88b2-f96c-439f-943c-e55f658ffb35",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "87ff4878-3d97-4dc0-96f8-7d3171fccb85",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e507351c-b656-4449-861e-89f1a9ae2a2f",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-13T22:25:35.0553375-07:00",
"MeasurementValueNeededDate": "2026-04-13T22:25:35.0553375-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5877a23e-ad1e-4949-8dd7-69f5cfd2b648",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "94c231d3-894e-4601-9694-93d83583eba0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a9a300a5-6b55-489f-a8a6-f67670ac62d0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b14cce4b-5204-4d72-aee8-c4f7f2c2abc7",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-13T22:25:35.0553375-07:00",
"Fields": [
{
"FormTypeFieldId": "aeb9d3d8-0bb4-422b-b97b-3dcaae1e81c0",
"Section": {
"FormTypeSectionId": "e6b2f4af-308d-41cb-9c76-f8448bb50911",
"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": "a0720877-008e-409c-b853-59a34400f868",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d94ecde6-26ce-4b43-9636-80ededb85911",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a5382233-e200-4fab-a8e1-171e6b845073",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "498f9aee-f26d-49d4-b164-6074afe7ee4b",
"FieldId": "37f11217-c8db-43e6-b281-0b0bcb282d00",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "498f9aee-f26d-49d4-b164-6074afe7ee4b",
"FieldId": "37f11217-c8db-43e6-b281-0b0bcb282d00",
"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": "aeb9d3d8-0bb4-422b-b97b-3dcaae1e81c0",
"Section": {
"FormTypeSectionId": "e6b2f4af-308d-41cb-9c76-f8448bb50911",
"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": "a0720877-008e-409c-b853-59a34400f868",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d94ecde6-26ce-4b43-9636-80ededb85911",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a5382233-e200-4fab-a8e1-171e6b845073",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "498f9aee-f26d-49d4-b164-6074afe7ee4b",
"FieldId": "37f11217-c8db-43e6-b281-0b0bcb282d00",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "498f9aee-f26d-49d4-b164-6074afe7ee4b",
"FieldId": "37f11217-c8db-43e6-b281-0b0bcb282d00",
"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": "d0e30ea8-8004-4aa8-bb0b-e17fe18ca369",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-04-13T22:25:35.0553375-07:00",
"Location": "sample string 1",
"TaskId": "368313e7-287a-46d0-a921-61faeb94fd89",
"Values": [
{
"FormFieldValueId": "83a755e8-0bc4-4486-8fe6-c7ef90a66e25",
"FormId": "7c526ad6-44a4-4c4f-9776-043ff338fed4",
"FormTypeField": {
"FormTypeFieldId": "aeb9d3d8-0bb4-422b-b97b-3dcaae1e81c0",
"FormType": {
"FormTypeId": "94c231d3-894e-4601-9694-93d83583eba0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a9a300a5-6b55-489f-a8a6-f67670ac62d0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b14cce4b-5204-4d72-aee8-c4f7f2c2abc7",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-13T22:25:35.0553375-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "d0e30ea8-8004-4aa8-bb0b-e17fe18ca369",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "e6b2f4af-308d-41cb-9c76-f8448bb50911",
"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": "a0720877-008e-409c-b853-59a34400f868",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d94ecde6-26ce-4b43-9636-80ededb85911",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a5382233-e200-4fab-a8e1-171e6b845073",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "498f9aee-f26d-49d4-b164-6074afe7ee4b",
"FieldId": "37f11217-c8db-43e6-b281-0b0bcb282d00",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "498f9aee-f26d-49d4-b164-6074afe7ee4b",
"FieldId": "37f11217-c8db-43e6-b281-0b0bcb282d00",
"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": "83a755e8-0bc4-4486-8fe6-c7ef90a66e25",
"FormId": "7c526ad6-44a4-4c4f-9776-043ff338fed4",
"FormTypeField": {
"FormTypeFieldId": "aeb9d3d8-0bb4-422b-b97b-3dcaae1e81c0",
"FormType": {
"FormTypeId": "94c231d3-894e-4601-9694-93d83583eba0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a9a300a5-6b55-489f-a8a6-f67670ac62d0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b14cce4b-5204-4d72-aee8-c4f7f2c2abc7",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-13T22:25:35.0553375-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "d0e30ea8-8004-4aa8-bb0b-e17fe18ca369",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "e6b2f4af-308d-41cb-9c76-f8448bb50911",
"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": "a0720877-008e-409c-b853-59a34400f868",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d94ecde6-26ce-4b43-9636-80ededb85911",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a5382233-e200-4fab-a8e1-171e6b845073",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "498f9aee-f26d-49d4-b164-6074afe7ee4b",
"FieldId": "37f11217-c8db-43e6-b281-0b0bcb282d00",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "498f9aee-f26d-49d4-b164-6074afe7ee4b",
"FieldId": "37f11217-c8db-43e6-b281-0b0bcb282d00",
"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": "c266bba2-7a9c-4af5-b868-d0c67c1ae1a5",
"CreateDate": "2026-04-13T22:25:35.0553375-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-13T22:25:35.0553375-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}