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": "73fb4238-5e25-47ea-8a13-62a852cbc7fc",
"Asset": {
"AssetId": "c671a8cf-d49d-42f7-b460-66be35fa6a81",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9794702a-413b-41fa-a9b2-81cb83737d89",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b004fd48-d5da-40e0-ab44-3e97367de535",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "6423a906-3d0f-4ec7-b7a3-239db54a8d85",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-24T20:36:55.3224551-07:00",
"MeasurementValueNeededDate": "2026-10-24T20:36:55.3224551-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9758839e-d552-46d6-922b-6c9e28deb617",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "affe09d3-555c-444b-a665-f24b89ebbdff",
"EffectiveDate": "2026-10-24T20:36:55.3224551-07:00",
"StateType": {
"StateTypeId": "fec2246c-862d-4121-b883-fac3330de440",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9794702a-413b-41fa-a9b2-81cb83737d89",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b004fd48-d5da-40e0-ab44-3e97367de535",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "cf3d6443-aae9-4b45-bd8e-000a2bf13d1b",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "eefb595a-140d-479c-8549-dc1d7f955542",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "050b4dff-e5d3-43fe-8616-9e2ac0d9571e",
"EffectiveDate": "2026-10-24T20:36:55.3224551-07:00",
"StatusType": {
"StatusTypeId": "c91ee484-56b3-41ad-abfd-e71269566f9a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9794702a-413b-41fa-a9b2-81cb83737d89",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b004fd48-d5da-40e0-ab44-3e97367de535",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "315f840e-7176-42a3-aee7-a569740ef635",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bb95c869-fb4c-4b27-9e83-f154a54a3d90",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "13ce7d22-743b-4c85-abdc-fdf26f357edb",
"EffectiveDate": "2026-10-24T20:36:55.3224551-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "84496e71-7a9b-4f7b-9a37-4fa72f6843d9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b877856a-acc5-4409-9ac8-14b99fe4e0fd",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4ced02f0-447c-4777-b6a9-ea6b29ff2db3",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-24T20:36:55.3224551-07:00",
"MeasurementValueNeededDate": "2026-10-24T20:36:55.3224551-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "422fd9d5-2690-4574-8db7-361f29a4fc44",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "0eb03af4-8773-423f-a5a7-e057ae4f36f1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9794702a-413b-41fa-a9b2-81cb83737d89",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b004fd48-d5da-40e0-ab44-3e97367de535",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-24T20:36:55.3224551-07:00",
"Fields": [
{
"FormTypeFieldId": "ac970240-28a7-4d2f-b33e-18fbb75c988c",
"Section": {
"FormTypeSectionId": "66867b73-97a8-491d-a6ff-5304ae25104e",
"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": "0c2b0475-2ea4-43dc-a152-b38ff2305571",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1d3b864d-7d60-4f2c-8d08-4a20fb47fb37",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dc0ded3d-562d-42c5-a9b4-a0786bd622bf",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4b797df4-4b86-40b1-bea4-6ce5ddd0f0e3",
"FieldId": "153c1778-9343-473b-ac2f-6b6f86d3624f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4b797df4-4b86-40b1-bea4-6ce5ddd0f0e3",
"FieldId": "153c1778-9343-473b-ac2f-6b6f86d3624f",
"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": "ac970240-28a7-4d2f-b33e-18fbb75c988c",
"Section": {
"FormTypeSectionId": "66867b73-97a8-491d-a6ff-5304ae25104e",
"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": "0c2b0475-2ea4-43dc-a152-b38ff2305571",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1d3b864d-7d60-4f2c-8d08-4a20fb47fb37",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dc0ded3d-562d-42c5-a9b4-a0786bd622bf",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4b797df4-4b86-40b1-bea4-6ce5ddd0f0e3",
"FieldId": "153c1778-9343-473b-ac2f-6b6f86d3624f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4b797df4-4b86-40b1-bea4-6ce5ddd0f0e3",
"FieldId": "153c1778-9343-473b-ac2f-6b6f86d3624f",
"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": "2d813487-496d-4f9f-ae5e-c5177f9b20c2",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-10-24T20:36:55.3224551-07:00",
"Location": "sample string 1",
"TaskId": "6ff7085c-1b54-4ef9-aab2-85e2caf7efbc",
"Values": [
{
"FormFieldValueId": "9ebf5428-3337-4fd7-b259-2cb9b4f857d1",
"FormId": "123e2bdc-4fe7-4cbb-910c-a2ed2ea73a9e",
"FormTypeField": {
"FormTypeFieldId": "ac970240-28a7-4d2f-b33e-18fbb75c988c",
"FormType": {
"FormTypeId": "0eb03af4-8773-423f-a5a7-e057ae4f36f1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9794702a-413b-41fa-a9b2-81cb83737d89",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b004fd48-d5da-40e0-ab44-3e97367de535",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-24T20:36:55.3224551-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "2d813487-496d-4f9f-ae5e-c5177f9b20c2",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "66867b73-97a8-491d-a6ff-5304ae25104e",
"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": "0c2b0475-2ea4-43dc-a152-b38ff2305571",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1d3b864d-7d60-4f2c-8d08-4a20fb47fb37",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dc0ded3d-562d-42c5-a9b4-a0786bd622bf",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4b797df4-4b86-40b1-bea4-6ce5ddd0f0e3",
"FieldId": "153c1778-9343-473b-ac2f-6b6f86d3624f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4b797df4-4b86-40b1-bea4-6ce5ddd0f0e3",
"FieldId": "153c1778-9343-473b-ac2f-6b6f86d3624f",
"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": "9ebf5428-3337-4fd7-b259-2cb9b4f857d1",
"FormId": "123e2bdc-4fe7-4cbb-910c-a2ed2ea73a9e",
"FormTypeField": {
"FormTypeFieldId": "ac970240-28a7-4d2f-b33e-18fbb75c988c",
"FormType": {
"FormTypeId": "0eb03af4-8773-423f-a5a7-e057ae4f36f1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9794702a-413b-41fa-a9b2-81cb83737d89",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b004fd48-d5da-40e0-ab44-3e97367de535",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-24T20:36:55.3224551-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "2d813487-496d-4f9f-ae5e-c5177f9b20c2",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "66867b73-97a8-491d-a6ff-5304ae25104e",
"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": "0c2b0475-2ea4-43dc-a152-b38ff2305571",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1d3b864d-7d60-4f2c-8d08-4a20fb47fb37",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dc0ded3d-562d-42c5-a9b4-a0786bd622bf",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4b797df4-4b86-40b1-bea4-6ce5ddd0f0e3",
"FieldId": "153c1778-9343-473b-ac2f-6b6f86d3624f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4b797df4-4b86-40b1-bea4-6ce5ddd0f0e3",
"FieldId": "153c1778-9343-473b-ac2f-6b6f86d3624f",
"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": "7b6c6b27-e1ec-4119-b52a-eff1af84c099",
"CreateDate": "2026-10-24T20:36:55.3224551-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-24T20:36:55.3224551-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}