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": "ce65b236-013a-4f01-8c66-2c5bf6f16d45",
"Asset": {
"AssetId": "19dbc3a1-a6fd-43a7-a59a-8e5673ad02ca",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7b804ad2-22db-4f88-9ab6-798e5585d0b3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1cbb87a1-f944-4af7-9a88-c6787d949761",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "01994d3b-2f27-41b9-b46f-2331ec408005",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T22:15:33.7627477-07:00",
"MeasurementValueNeededDate": "2026-04-27T22:15:33.7627477-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "20c3f4e6-625a-447b-86d7-2dac3b3c4931",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "75f853cd-a35d-4099-8824-140449f3e36f",
"EffectiveDate": "2026-04-27T22:15:33.7627477-07:00",
"StateType": {
"StateTypeId": "642e66c5-08a0-488b-91dd-48e585fa1920",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7b804ad2-22db-4f88-9ab6-798e5585d0b3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1cbb87a1-f944-4af7-9a88-c6787d949761",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2bfd5587-e840-4c69-82d8-0cf06d78ada8",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b61a0c28-6214-45c8-bcda-1b5e137995b4",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b450e5b8-a657-4e8b-8b3b-ee20071a22f3",
"EffectiveDate": "2026-04-27T22:15:33.7627477-07:00",
"StatusType": {
"StatusTypeId": "1a962e96-8410-4984-9b72-8e51e25da4c9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7b804ad2-22db-4f88-9ab6-798e5585d0b3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1cbb87a1-f944-4af7-9a88-c6787d949761",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "330f8769-af51-419c-9e9e-fd5b7f411eb2",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "84640897-2f13-4f46-af41-16e0d549a6c5",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ed128299-5129-44ea-a5cd-f455531d7267",
"EffectiveDate": "2026-04-27T22:15:33.7627477-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "8bc00801-9d20-4810-8f81-361658e9d2eb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1bac4fdf-2682-4759-84bb-542c8e4163c8",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "29da28bb-007a-4ca0-b3ce-581777c45af8",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-27T22:15:33.7627477-07:00",
"MeasurementValueNeededDate": "2026-04-27T22:15:33.7627477-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d7ca5283-c4eb-4b19-bb24-c03a32e81cd6",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "f2b8470a-ea5d-4743-80e8-a1a8b4873b5c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "7b804ad2-22db-4f88-9ab6-798e5585d0b3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1cbb87a1-f944-4af7-9a88-c6787d949761",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-27T22:15:33.7627477-07:00",
"Fields": [
{
"FormTypeFieldId": "ad0333db-ec61-4b71-abd7-8be1381d91c4",
"Section": {
"FormTypeSectionId": "86975ca4-48df-4fe5-8ded-e61e313f404c",
"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": "5dbd0d79-c1d6-4668-8790-59435995c90e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "13dc8fab-78b2-407b-81f5-1d5034a40f36",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9021e041-1b38-485d-ac4b-db8ebcc46834",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a0cbc797-8cbb-45c0-a5b2-bdb7293cc51b",
"FieldId": "3c66d0d2-71ae-4199-8f26-29657b5bf90e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a0cbc797-8cbb-45c0-a5b2-bdb7293cc51b",
"FieldId": "3c66d0d2-71ae-4199-8f26-29657b5bf90e",
"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": "ad0333db-ec61-4b71-abd7-8be1381d91c4",
"Section": {
"FormTypeSectionId": "86975ca4-48df-4fe5-8ded-e61e313f404c",
"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": "5dbd0d79-c1d6-4668-8790-59435995c90e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "13dc8fab-78b2-407b-81f5-1d5034a40f36",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9021e041-1b38-485d-ac4b-db8ebcc46834",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a0cbc797-8cbb-45c0-a5b2-bdb7293cc51b",
"FieldId": "3c66d0d2-71ae-4199-8f26-29657b5bf90e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a0cbc797-8cbb-45c0-a5b2-bdb7293cc51b",
"FieldId": "3c66d0d2-71ae-4199-8f26-29657b5bf90e",
"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": "1d167e2e-0f8f-4d9b-8dc3-993e0ff6523b",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-04-27T22:15:33.7627477-07:00",
"Location": "sample string 1",
"TaskId": "45168558-8359-434f-9204-67d90b292d70",
"Values": [
{
"FormFieldValueId": "61ab7a82-2dde-4f54-bcf5-8bd47bbf3562",
"FormId": "b2835fb5-0647-461f-98c4-4a26b508a9c1",
"FormTypeField": {
"FormTypeFieldId": "ad0333db-ec61-4b71-abd7-8be1381d91c4",
"FormType": {
"FormTypeId": "f2b8470a-ea5d-4743-80e8-a1a8b4873b5c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "7b804ad2-22db-4f88-9ab6-798e5585d0b3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1cbb87a1-f944-4af7-9a88-c6787d949761",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-27T22:15:33.7627477-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "1d167e2e-0f8f-4d9b-8dc3-993e0ff6523b",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "86975ca4-48df-4fe5-8ded-e61e313f404c",
"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": "5dbd0d79-c1d6-4668-8790-59435995c90e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "13dc8fab-78b2-407b-81f5-1d5034a40f36",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9021e041-1b38-485d-ac4b-db8ebcc46834",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a0cbc797-8cbb-45c0-a5b2-bdb7293cc51b",
"FieldId": "3c66d0d2-71ae-4199-8f26-29657b5bf90e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a0cbc797-8cbb-45c0-a5b2-bdb7293cc51b",
"FieldId": "3c66d0d2-71ae-4199-8f26-29657b5bf90e",
"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": "61ab7a82-2dde-4f54-bcf5-8bd47bbf3562",
"FormId": "b2835fb5-0647-461f-98c4-4a26b508a9c1",
"FormTypeField": {
"FormTypeFieldId": "ad0333db-ec61-4b71-abd7-8be1381d91c4",
"FormType": {
"FormTypeId": "f2b8470a-ea5d-4743-80e8-a1a8b4873b5c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "7b804ad2-22db-4f88-9ab6-798e5585d0b3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1cbb87a1-f944-4af7-9a88-c6787d949761",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-27T22:15:33.7627477-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "1d167e2e-0f8f-4d9b-8dc3-993e0ff6523b",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "86975ca4-48df-4fe5-8ded-e61e313f404c",
"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": "5dbd0d79-c1d6-4668-8790-59435995c90e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "13dc8fab-78b2-407b-81f5-1d5034a40f36",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9021e041-1b38-485d-ac4b-db8ebcc46834",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a0cbc797-8cbb-45c0-a5b2-bdb7293cc51b",
"FieldId": "3c66d0d2-71ae-4199-8f26-29657b5bf90e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a0cbc797-8cbb-45c0-a5b2-bdb7293cc51b",
"FieldId": "3c66d0d2-71ae-4199-8f26-29657b5bf90e",
"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": "bde4a6c4-ed95-4deb-9f18-ce55c2e22dd9",
"CreateDate": "2026-04-27T22:15:33.7627477-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-27T22:15:33.7627477-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}