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": "f50f7e59-53ac-411c-b5ce-fcacbf99f6a9",
"Asset": {
"AssetId": "afb1bc18-87fa-403c-a254-f07813526399",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "df9140b8-188f-4c1f-ae88-765dcd2b48eb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0a2af43b-3838-4718-95be-ed13d3d99c4e",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d3dc31c6-0b0f-46ee-a5ad-0c6b33573aaa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-17T17:29:00.5963945-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:29:00.5963945-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9e86e2ef-cab8-4d72-bac3-8339acbfebc3",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "658d1da8-d844-4c2b-a882-c52d618d4a21",
"EffectiveDate": "2026-06-17T17:29:00.5963945-07:00",
"StateType": {
"StateTypeId": "256d0138-97b6-48be-b379-c9c32f97b15e",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "df9140b8-188f-4c1f-ae88-765dcd2b48eb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0a2af43b-3838-4718-95be-ed13d3d99c4e",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e43c5bcd-04da-489f-8e49-53c78ec68d5c",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4b6fad1f-6eb7-454e-8bcc-25134cf3adec",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "53572dbe-0dab-4f56-b408-f678099d8b6a",
"EffectiveDate": "2026-06-17T17:29:00.5963945-07:00",
"StatusType": {
"StatusTypeId": "a43dd0c8-d036-49b9-9bc5-5d3a98209996",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "df9140b8-188f-4c1f-ae88-765dcd2b48eb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0a2af43b-3838-4718-95be-ed13d3d99c4e",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5e152dad-654d-4a0e-8880-949e5840ca27",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "349e64eb-1d0d-4713-bf21-361f28a06905",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b7c1c052-9817-444c-b638-363fb1ba8d76",
"EffectiveDate": "2026-06-17T17:29:00.5963945-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "545f12a8-e139-4ee8-8d15-fe9a6a158f9d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ad7ac1ea-8e47-462c-b247-57b623983805",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6ee644d1-7afb-4009-8977-1f0274813814",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-17T17:29:00.5963945-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:29:00.5963945-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6f8ebb1d-e90c-4113-9f3b-e2c82f76886f",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "bd83db0c-3959-4197-b485-b5139131034c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "df9140b8-188f-4c1f-ae88-765dcd2b48eb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0a2af43b-3838-4718-95be-ed13d3d99c4e",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-17T17:29:00.5963945-07:00",
"Fields": [
{
"FormTypeFieldId": "664fcba7-8f06-4646-9747-fabac08424c2",
"Section": {
"FormTypeSectionId": "6daecfae-22ed-4256-9665-b5e2b2842046",
"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": "9cdfa917-52a0-45bb-a591-73808dfc319d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "83410620-c7fb-4892-b00a-46f38269e362",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "25c2b4af-ef4b-4bc3-b6fe-4a0c30256443",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "57f5be6b-9fbe-45b8-87a6-2110559a93bb",
"FieldId": "6d79a8c3-997f-4885-b2c8-1d5001a7d6f1",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "57f5be6b-9fbe-45b8-87a6-2110559a93bb",
"FieldId": "6d79a8c3-997f-4885-b2c8-1d5001a7d6f1",
"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": "664fcba7-8f06-4646-9747-fabac08424c2",
"Section": {
"FormTypeSectionId": "6daecfae-22ed-4256-9665-b5e2b2842046",
"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": "9cdfa917-52a0-45bb-a591-73808dfc319d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "83410620-c7fb-4892-b00a-46f38269e362",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "25c2b4af-ef4b-4bc3-b6fe-4a0c30256443",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "57f5be6b-9fbe-45b8-87a6-2110559a93bb",
"FieldId": "6d79a8c3-997f-4885-b2c8-1d5001a7d6f1",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "57f5be6b-9fbe-45b8-87a6-2110559a93bb",
"FieldId": "6d79a8c3-997f-4885-b2c8-1d5001a7d6f1",
"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": "e452c533-dfab-418d-a74e-4e7c988619b8",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-06-17T17:29:00.5963945-07:00",
"Location": "sample string 1",
"TaskId": "5a57aaaa-052f-4785-b350-ffe578ca8afa",
"Values": [
{
"FormFieldValueId": "79bd4108-5102-479e-874a-e24fb9a63fe5",
"FormId": "380ad7b3-d1b5-448e-8fd9-8af8295014ad",
"FormTypeField": {
"FormTypeFieldId": "664fcba7-8f06-4646-9747-fabac08424c2",
"FormType": {
"FormTypeId": "bd83db0c-3959-4197-b485-b5139131034c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "df9140b8-188f-4c1f-ae88-765dcd2b48eb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0a2af43b-3838-4718-95be-ed13d3d99c4e",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-17T17:29:00.5963945-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "e452c533-dfab-418d-a74e-4e7c988619b8",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "6daecfae-22ed-4256-9665-b5e2b2842046",
"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": "9cdfa917-52a0-45bb-a591-73808dfc319d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "83410620-c7fb-4892-b00a-46f38269e362",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "25c2b4af-ef4b-4bc3-b6fe-4a0c30256443",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "57f5be6b-9fbe-45b8-87a6-2110559a93bb",
"FieldId": "6d79a8c3-997f-4885-b2c8-1d5001a7d6f1",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "57f5be6b-9fbe-45b8-87a6-2110559a93bb",
"FieldId": "6d79a8c3-997f-4885-b2c8-1d5001a7d6f1",
"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": "79bd4108-5102-479e-874a-e24fb9a63fe5",
"FormId": "380ad7b3-d1b5-448e-8fd9-8af8295014ad",
"FormTypeField": {
"FormTypeFieldId": "664fcba7-8f06-4646-9747-fabac08424c2",
"FormType": {
"FormTypeId": "bd83db0c-3959-4197-b485-b5139131034c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "df9140b8-188f-4c1f-ae88-765dcd2b48eb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0a2af43b-3838-4718-95be-ed13d3d99c4e",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-17T17:29:00.5963945-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "e452c533-dfab-418d-a74e-4e7c988619b8",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "6daecfae-22ed-4256-9665-b5e2b2842046",
"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": "9cdfa917-52a0-45bb-a591-73808dfc319d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "83410620-c7fb-4892-b00a-46f38269e362",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "25c2b4af-ef4b-4bc3-b6fe-4a0c30256443",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "57f5be6b-9fbe-45b8-87a6-2110559a93bb",
"FieldId": "6d79a8c3-997f-4885-b2c8-1d5001a7d6f1",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "57f5be6b-9fbe-45b8-87a6-2110559a93bb",
"FieldId": "6d79a8c3-997f-4885-b2c8-1d5001a7d6f1",
"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": "828e137c-b78b-4cfc-9552-0ac9aeb434cd",
"CreateDate": "2026-06-17T17:29:00.5963945-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-17T17:29:00.5963945-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}