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": "8ef7c871-de04-488e-ae1c-83108995f15e",
"Asset": {
"AssetId": "fd9003fd-ddc9-4330-9f48-d79b359ab441",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b42a2dcc-d9d1-4a54-b0c6-41ca1180492a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "491105fb-bf1d-4a67-a7bd-8173f64e6fef",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "244223f2-3ca3-4c38-bf8e-9755a48f7233",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-08T04:59:23.1245594-08:00",
"MeasurementValueNeededDate": "2025-11-08T04:59:23.1245594-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a0ba0cc3-1ec6-4d24-91a9-5b502a41372e",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "602f5b46-ec8c-456c-918c-85eedf55546f",
"EffectiveDate": "2025-11-08T04:59:23.1245594-08:00",
"StateType": {
"StateTypeId": "9bc24faf-0080-40d1-8a12-430dbd53e0c7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b42a2dcc-d9d1-4a54-b0c6-41ca1180492a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "491105fb-bf1d-4a67-a7bd-8173f64e6fef",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "66e14bf7-11d4-4da6-8ca4-0a1ce7ab6880",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9c044bdc-8610-4f62-98dd-371382f61f3b",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "7187539d-125b-443a-bbf3-358902d02b95",
"EffectiveDate": "2025-11-08T04:59:23.1245594-08:00",
"StatusType": {
"StatusTypeId": "4c048a43-0ba2-4a0c-950c-0fb2f40b3829",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b42a2dcc-d9d1-4a54-b0c6-41ca1180492a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "491105fb-bf1d-4a67-a7bd-8173f64e6fef",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1dbb7006-82f9-4a2f-9a76-fdaffead7623",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a6188013-3cc9-4763-b2e8-135799915336",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "328f6aaa-decd-4355-88de-529eba7547cb",
"EffectiveDate": "2025-11-08T04:59:23.1245594-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "d1e4248c-9dae-4954-b7fe-0b0ba4067f22",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "53a859bc-9093-42be-8131-934e89b1a73f",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "356c6f8b-08b8-48cb-b2c4-7dd622cda166",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-08T04:59:23.1245594-08:00",
"MeasurementValueNeededDate": "2025-11-08T04:59:23.1245594-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f0b8e1a5-1bf2-4c73-9a42-c15031271682",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "bf096e6f-d61c-42ab-bf54-b47c11f11fef",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b42a2dcc-d9d1-4a54-b0c6-41ca1180492a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "491105fb-bf1d-4a67-a7bd-8173f64e6fef",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-08T04:59:23.1245594-08:00",
"Fields": [
{
"FormTypeFieldId": "a84f1821-9879-4392-be22-4f0bb5651210",
"Section": {
"FormTypeSectionId": "0b4c6e65-d9fa-4d79-bf68-54638506582a",
"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": "6678b88f-c2c8-4ff7-9b30-260314924f8f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "eb95a4fa-4c60-429f-bb4f-4248f93c1337",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7c841ce8-3b3e-434f-82cc-0c558d246f75",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "55d49ad5-e669-460b-a43c-fce99827d74d",
"FieldId": "7f3acfa4-3ac2-4faf-802b-0cdc135d5bf5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "55d49ad5-e669-460b-a43c-fce99827d74d",
"FieldId": "7f3acfa4-3ac2-4faf-802b-0cdc135d5bf5",
"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": "a84f1821-9879-4392-be22-4f0bb5651210",
"Section": {
"FormTypeSectionId": "0b4c6e65-d9fa-4d79-bf68-54638506582a",
"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": "6678b88f-c2c8-4ff7-9b30-260314924f8f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "eb95a4fa-4c60-429f-bb4f-4248f93c1337",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7c841ce8-3b3e-434f-82cc-0c558d246f75",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "55d49ad5-e669-460b-a43c-fce99827d74d",
"FieldId": "7f3acfa4-3ac2-4faf-802b-0cdc135d5bf5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "55d49ad5-e669-460b-a43c-fce99827d74d",
"FieldId": "7f3acfa4-3ac2-4faf-802b-0cdc135d5bf5",
"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": "5fca4b68-47e6-432d-a1a5-d2889f431145",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2025-11-08T04:59:23.1245594-08:00",
"Location": "sample string 1",
"TaskId": "246902c8-681c-47f6-bcdb-ff997c6aee35",
"Values": [
{
"FormFieldValueId": "6cdf1774-e968-4c4b-99d5-8e0c16aac36d",
"FormId": "0e061df0-a4a8-4bde-9814-04affd5f6290",
"FormTypeField": {
"FormTypeFieldId": "a84f1821-9879-4392-be22-4f0bb5651210",
"FormType": {
"FormTypeId": "bf096e6f-d61c-42ab-bf54-b47c11f11fef",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b42a2dcc-d9d1-4a54-b0c6-41ca1180492a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "491105fb-bf1d-4a67-a7bd-8173f64e6fef",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-08T04:59:23.1245594-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "5fca4b68-47e6-432d-a1a5-d2889f431145",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "0b4c6e65-d9fa-4d79-bf68-54638506582a",
"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": "6678b88f-c2c8-4ff7-9b30-260314924f8f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "eb95a4fa-4c60-429f-bb4f-4248f93c1337",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7c841ce8-3b3e-434f-82cc-0c558d246f75",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "55d49ad5-e669-460b-a43c-fce99827d74d",
"FieldId": "7f3acfa4-3ac2-4faf-802b-0cdc135d5bf5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "55d49ad5-e669-460b-a43c-fce99827d74d",
"FieldId": "7f3acfa4-3ac2-4faf-802b-0cdc135d5bf5",
"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": "6cdf1774-e968-4c4b-99d5-8e0c16aac36d",
"FormId": "0e061df0-a4a8-4bde-9814-04affd5f6290",
"FormTypeField": {
"FormTypeFieldId": "a84f1821-9879-4392-be22-4f0bb5651210",
"FormType": {
"FormTypeId": "bf096e6f-d61c-42ab-bf54-b47c11f11fef",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b42a2dcc-d9d1-4a54-b0c6-41ca1180492a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "491105fb-bf1d-4a67-a7bd-8173f64e6fef",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-08T04:59:23.1245594-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "5fca4b68-47e6-432d-a1a5-d2889f431145",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "0b4c6e65-d9fa-4d79-bf68-54638506582a",
"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": "6678b88f-c2c8-4ff7-9b30-260314924f8f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "eb95a4fa-4c60-429f-bb4f-4248f93c1337",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7c841ce8-3b3e-434f-82cc-0c558d246f75",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "55d49ad5-e669-460b-a43c-fce99827d74d",
"FieldId": "7f3acfa4-3ac2-4faf-802b-0cdc135d5bf5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "55d49ad5-e669-460b-a43c-fce99827d74d",
"FieldId": "7f3acfa4-3ac2-4faf-802b-0cdc135d5bf5",
"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": "c8384a4d-909d-44a0-bd64-1cee3f0d23b3",
"CreateDate": "2025-11-08T04:59:23.1245594-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-08T04:59:23.1245594-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}