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": "b9ff952f-eee3-422f-a501-86e9bfaa17a8",
"Asset": {
"AssetId": "36967056-3db9-4a3f-b98c-4e0e8319b3f3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4bbdcd1d-32c1-4537-8735-f0e03d22e35c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5867aa2-b5d8-4620-a0be-ce9ff577dfb8",
"CreateDate": "2026-05-23T02:16:02.7297763-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-23T02:16:02.7297763-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "420f1c03-f7d1-4378-97c5-98db4edf53c5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-23T02:16:02.7297763-07:00",
"MeasurementValueNeededDate": "2026-05-23T02:16:02.7297763-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a29571b6-71ba-470c-84a7-3b62233ce4fe",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "e61fd619-378f-4e17-8c5a-5426d0548bfe",
"EffectiveDate": "2026-05-23T02:16:02.7454631-07:00",
"StateType": {
"StateTypeId": "80142c5e-1983-4473-8fea-70a47df84e77",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4bbdcd1d-32c1-4537-8735-f0e03d22e35c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5867aa2-b5d8-4620-a0be-ce9ff577dfb8",
"CreateDate": "2026-05-23T02:16:02.7297763-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-23T02:16:02.7297763-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6d3543b8-e6be-4a85-acf0-26b415e4c464",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "aae6827e-d254-4ee3-b872-ac9d1f6ba217",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d4c103bb-09b3-4ffb-af07-b61670de98e1",
"EffectiveDate": "2026-05-23T02:16:02.7454631-07:00",
"StatusType": {
"StatusTypeId": "379c5073-580f-48d4-81d5-02995e208378",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4bbdcd1d-32c1-4537-8735-f0e03d22e35c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5867aa2-b5d8-4620-a0be-ce9ff577dfb8",
"CreateDate": "2026-05-23T02:16:02.7297763-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-23T02:16:02.7297763-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "0c86bae2-89b3-495e-8219-bd4901110359",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "110f1734-c4e1-4d42-bee5-668b158cfa61",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1c7ede65-6c85-490c-815d-16aaa5cec2ed",
"EffectiveDate": "2026-05-23T02:16:02.7454631-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "25982528-1768-4fbb-92b8-245487454828",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9484cc5f-5916-4515-a98c-ae1bc91b4eaa",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "96aa496c-5fa2-46f0-b1bc-62b4a7fb9657",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-23T02:16:02.7454631-07:00",
"MeasurementValueNeededDate": "2026-05-23T02:16:02.7454631-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cd2663bc-2b03-41d6-8ff6-761b90083701",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "3c2a068d-9668-45f2-ba4b-a091e49c3350",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "4bbdcd1d-32c1-4537-8735-f0e03d22e35c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5867aa2-b5d8-4620-a0be-ce9ff577dfb8",
"CreateDate": "2026-05-23T02:16:02.7297763-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-23T02:16:02.7297763-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-23T02:16:02.7454631-07:00",
"Fields": [
{
"FormTypeFieldId": "b6fb7a52-9665-4ee6-8fa0-a2bebd128b2e",
"Section": {
"FormTypeSectionId": "87475e2a-4286-433d-9be6-a6b566dbd871",
"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": "50f816fd-9954-446a-a61a-af9f22e4f830",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e4160135-bfc6-4842-a3a6-86b0084284bf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "96dee9ad-f579-4889-bd8f-85bcb2f3bbb8",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fbfe1141-0195-4016-8191-0e8c5b52a2f6",
"FieldId": "d70e5b19-1b8a-4197-96f5-749ad35d7439",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fbfe1141-0195-4016-8191-0e8c5b52a2f6",
"FieldId": "d70e5b19-1b8a-4197-96f5-749ad35d7439",
"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": "b6fb7a52-9665-4ee6-8fa0-a2bebd128b2e",
"Section": {
"FormTypeSectionId": "87475e2a-4286-433d-9be6-a6b566dbd871",
"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": "50f816fd-9954-446a-a61a-af9f22e4f830",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e4160135-bfc6-4842-a3a6-86b0084284bf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "96dee9ad-f579-4889-bd8f-85bcb2f3bbb8",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fbfe1141-0195-4016-8191-0e8c5b52a2f6",
"FieldId": "d70e5b19-1b8a-4197-96f5-749ad35d7439",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fbfe1141-0195-4016-8191-0e8c5b52a2f6",
"FieldId": "d70e5b19-1b8a-4197-96f5-749ad35d7439",
"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": "d785d7b0-995a-4d8d-bdfb-c82b29a00467",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-05-23T02:16:02.7454631-07:00",
"Location": "sample string 1",
"TaskId": "d86757a7-8f15-491d-840b-7c7b24ee8746",
"Values": [
{
"FormFieldValueId": "20e6198c-f97f-4983-8ae3-044f694d31ab",
"FormId": "920d70c7-ba58-4c91-a1c8-cf85c922c299",
"FormTypeField": {
"FormTypeFieldId": "b6fb7a52-9665-4ee6-8fa0-a2bebd128b2e",
"FormType": {
"FormTypeId": "3c2a068d-9668-45f2-ba4b-a091e49c3350",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "4bbdcd1d-32c1-4537-8735-f0e03d22e35c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5867aa2-b5d8-4620-a0be-ce9ff577dfb8",
"CreateDate": "2026-05-23T02:16:02.7297763-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-23T02:16:02.7297763-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-23T02:16:02.7454631-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "d785d7b0-995a-4d8d-bdfb-c82b29a00467",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "87475e2a-4286-433d-9be6-a6b566dbd871",
"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": "50f816fd-9954-446a-a61a-af9f22e4f830",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e4160135-bfc6-4842-a3a6-86b0084284bf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "96dee9ad-f579-4889-bd8f-85bcb2f3bbb8",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fbfe1141-0195-4016-8191-0e8c5b52a2f6",
"FieldId": "d70e5b19-1b8a-4197-96f5-749ad35d7439",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fbfe1141-0195-4016-8191-0e8c5b52a2f6",
"FieldId": "d70e5b19-1b8a-4197-96f5-749ad35d7439",
"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": "20e6198c-f97f-4983-8ae3-044f694d31ab",
"FormId": "920d70c7-ba58-4c91-a1c8-cf85c922c299",
"FormTypeField": {
"FormTypeFieldId": "b6fb7a52-9665-4ee6-8fa0-a2bebd128b2e",
"FormType": {
"FormTypeId": "3c2a068d-9668-45f2-ba4b-a091e49c3350",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "4bbdcd1d-32c1-4537-8735-f0e03d22e35c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5867aa2-b5d8-4620-a0be-ce9ff577dfb8",
"CreateDate": "2026-05-23T02:16:02.7297763-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-23T02:16:02.7297763-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-23T02:16:02.7454631-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "d785d7b0-995a-4d8d-bdfb-c82b29a00467",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "87475e2a-4286-433d-9be6-a6b566dbd871",
"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": "50f816fd-9954-446a-a61a-af9f22e4f830",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e4160135-bfc6-4842-a3a6-86b0084284bf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "96dee9ad-f579-4889-bd8f-85bcb2f3bbb8",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fbfe1141-0195-4016-8191-0e8c5b52a2f6",
"FieldId": "d70e5b19-1b8a-4197-96f5-749ad35d7439",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fbfe1141-0195-4016-8191-0e8c5b52a2f6",
"FieldId": "d70e5b19-1b8a-4197-96f5-749ad35d7439",
"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": "1088ab74-f283-4196-a889-708794d8cb0f",
"CreateDate": "2026-05-23T02:16:02.7454631-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-23T02:16:02.7454631-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}