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": "a6edc524-51c1-4cbc-b739-4b277938fccb",
"Asset": {
"AssetId": "cd4fe389-c147-4bbc-a3d3-3fc408b63c2c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "756b44de-1339-4527-9346-7ecf11c61f6a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "000756e5-7511-4424-8ff3-9fbc313000de",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "be224f79-a0a4-4abc-b986-10a5a7f5fe58",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-05T14:16:06.7165108-07:00",
"MeasurementValueNeededDate": "2026-09-05T14:16:06.7165108-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8dce00e1-8e83-4fc1-8408-82be915b0a37",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "79907116-5017-40cf-9e53-4507bbad0287",
"EffectiveDate": "2026-09-05T14:16:06.7165108-07:00",
"StateType": {
"StateTypeId": "c9174818-a412-449b-b043-539620961581",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "756b44de-1339-4527-9346-7ecf11c61f6a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "000756e5-7511-4424-8ff3-9fbc313000de",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "1eaa3706-7bd4-4e00-824f-0adebefbd935",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a723efcc-bfbf-4342-bf72-c73505cf438e",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d43d99d7-9bc7-4b40-a963-128c255b8508",
"EffectiveDate": "2026-09-05T14:16:06.7165108-07:00",
"StatusType": {
"StatusTypeId": "6f7548ff-04c2-4f79-9746-17ad5fbcb54c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "756b44de-1339-4527-9346-7ecf11c61f6a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "000756e5-7511-4424-8ff3-9fbc313000de",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d1c819f0-a895-4b5f-a026-213a87f81e6c",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4ecc1421-e39e-4409-aa97-eaebef588926",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ff519fd3-83fa-4103-bd07-73b9b9b41d96",
"EffectiveDate": "2026-09-05T14:16:06.7165108-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "80fdad58-f100-4bf7-ad17-2fffd1c24f3c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "652868f9-53f2-4475-8771-f5a494a625ef",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9fe9a2f3-76a9-49b2-9149-9f2cf7ba730b",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-05T14:16:06.7165108-07:00",
"MeasurementValueNeededDate": "2026-09-05T14:16:06.7165108-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f39992e1-11c3-4df0-8a2c-e6bacbc1c0d5",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "74c3e65e-966c-42d3-bbe0-ebaf40242fd1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "756b44de-1339-4527-9346-7ecf11c61f6a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "000756e5-7511-4424-8ff3-9fbc313000de",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-05T14:16:06.7165108-07:00",
"Fields": [
{
"FormTypeFieldId": "b5c5b2d3-e364-4045-9902-0656aff30606",
"Section": {
"FormTypeSectionId": "7730f829-2c9b-4916-9561-8177d150f413",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "16b9b549-a8d3-43f8-b492-0e397e996517",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7b30965d-0976-4d58-b489-384e4a210f92",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2c293108-6a0a-4dc4-a201-59e53835b9f6",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "cfe99983-d1f4-4006-9eb6-2cab106e4c44",
"FieldId": "0715ff57-989d-471a-a789-4121d301414f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "cfe99983-d1f4-4006-9eb6-2cab106e4c44",
"FieldId": "0715ff57-989d-471a-a789-4121d301414f",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
{
"FormTypeFieldId": "b5c5b2d3-e364-4045-9902-0656aff30606",
"Section": {
"FormTypeSectionId": "7730f829-2c9b-4916-9561-8177d150f413",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "16b9b549-a8d3-43f8-b492-0e397e996517",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7b30965d-0976-4d58-b489-384e4a210f92",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2c293108-6a0a-4dc4-a201-59e53835b9f6",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "cfe99983-d1f4-4006-9eb6-2cab106e4c44",
"FieldId": "0715ff57-989d-471a-a789-4121d301414f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "cfe99983-d1f4-4006-9eb6-2cab106e4c44",
"FieldId": "0715ff57-989d-471a-a789-4121d301414f",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d0f1b2f5-125c-4141-b797-f96165586167",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-09-05T14:16:06.7165108-07:00",
"Location": "sample string 1",
"TaskId": "93d7a6b7-616f-4b3d-b4e7-fc300da2fbc8",
"Values": [
{
"FormFieldValueId": "4f87569a-2608-426a-aa17-755641e06dee",
"FormId": "8597b674-b530-4c3a-af3a-34ffaf3d082b",
"FormTypeField": {
"FormTypeFieldId": "b5c5b2d3-e364-4045-9902-0656aff30606",
"FormType": {
"FormTypeId": "74c3e65e-966c-42d3-bbe0-ebaf40242fd1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "756b44de-1339-4527-9346-7ecf11c61f6a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "000756e5-7511-4424-8ff3-9fbc313000de",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-05T14:16:06.7165108-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "d0f1b2f5-125c-4141-b797-f96165586167",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "7730f829-2c9b-4916-9561-8177d150f413",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "16b9b549-a8d3-43f8-b492-0e397e996517",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7b30965d-0976-4d58-b489-384e4a210f92",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2c293108-6a0a-4dc4-a201-59e53835b9f6",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "cfe99983-d1f4-4006-9eb6-2cab106e4c44",
"FieldId": "0715ff57-989d-471a-a789-4121d301414f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "cfe99983-d1f4-4006-9eb6-2cab106e4c44",
"FieldId": "0715ff57-989d-471a-a789-4121d301414f",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
"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": "4f87569a-2608-426a-aa17-755641e06dee",
"FormId": "8597b674-b530-4c3a-af3a-34ffaf3d082b",
"FormTypeField": {
"FormTypeFieldId": "b5c5b2d3-e364-4045-9902-0656aff30606",
"FormType": {
"FormTypeId": "74c3e65e-966c-42d3-bbe0-ebaf40242fd1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "756b44de-1339-4527-9346-7ecf11c61f6a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "000756e5-7511-4424-8ff3-9fbc313000de",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-05T14:16:06.7165108-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "d0f1b2f5-125c-4141-b797-f96165586167",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "7730f829-2c9b-4916-9561-8177d150f413",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "16b9b549-a8d3-43f8-b492-0e397e996517",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7b30965d-0976-4d58-b489-384e4a210f92",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2c293108-6a0a-4dc4-a201-59e53835b9f6",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "cfe99983-d1f4-4006-9eb6-2cab106e4c44",
"FieldId": "0715ff57-989d-471a-a789-4121d301414f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "cfe99983-d1f4-4006-9eb6-2cab106e4c44",
"FieldId": "0715ff57-989d-471a-a789-4121d301414f",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
"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": "da47e8cf-400b-4b2b-bc17-d128b073cbb2",
"CreateDate": "2026-09-05T14:16:06.7165108-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-05T14:16:06.7165108-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}