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": "70fe8b15-8f86-4aa8-b8a5-a592d2b2592c",
"Asset": {
"AssetId": "63cf27af-e668-4e27-98d4-f1c271f9d077",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "932e8db6-d393-4056-97ae-328fb1642735",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3cbcda9b-f10a-42f4-81e0-b4747d4e9346",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d721a067-6ded-4e91-854a-fa864478563e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:59:10.1701707-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:59:10.1701707-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6cfc473a-e0ec-4641-b322-0a0f0d685e72",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ae70e9ca-bf6e-468c-9a7a-ec5496ca0412",
"EffectiveDate": "2026-09-26T13:59:10.1701707-07:00",
"StateType": {
"StateTypeId": "d9e3fb0b-5d5c-45a2-a37e-1ef3af004ec3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "932e8db6-d393-4056-97ae-328fb1642735",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3cbcda9b-f10a-42f4-81e0-b4747d4e9346",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "91b63824-7f60-41b3-ab99-3982b5af344f",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9c05b078-83ba-4c00-be1d-60ba0c284e59",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "3afc8002-3539-480f-bf19-33da8095c26d",
"EffectiveDate": "2026-09-26T13:59:10.1701707-07:00",
"StatusType": {
"StatusTypeId": "08becbe1-3ab0-441c-bae5-2f04bbf901fb",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "932e8db6-d393-4056-97ae-328fb1642735",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3cbcda9b-f10a-42f4-81e0-b4747d4e9346",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ff20de47-2410-4eae-8c97-b0816490da49",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "284c8fbc-71e3-401d-86b9-42c9ba27b2d3",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4b9c4caf-f54a-408e-a32a-9db98a13bf00",
"EffectiveDate": "2026-09-26T13:59:10.1701707-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "8a614908-570d-4a24-a834-2c139733bb47",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3857a06b-c144-422b-9893-f5d8a1311444",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f4db91a4-0f31-43bc-9a99-b7a4979c08de",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-26T13:59:10.1701707-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:59:10.1701707-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "658b6160-4929-4931-9b23-75154cc736fb",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "9f3be629-117d-4d31-bbb8-982db3ce6be0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "932e8db6-d393-4056-97ae-328fb1642735",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3cbcda9b-f10a-42f4-81e0-b4747d4e9346",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-26T13:59:10.1701707-07:00",
"Fields": [
{
"FormTypeFieldId": "e6c5c05c-ddef-49b0-9589-c2316655cf2e",
"Section": {
"FormTypeSectionId": "50cad9e9-ee43-496f-aa19-fc24807d71cf",
"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": "d1691fa3-c197-466d-8442-b2e4bc9b8c78",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "67427e2a-22fc-4be5-8afc-3286a705e810",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e511c117-2307-4285-8e69-f7943ba54cf9",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "76f8ad1e-5678-4546-9a98-fb6805fb9b2c",
"FieldId": "fd39413a-9188-4078-813a-289aecb888d1",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "76f8ad1e-5678-4546-9a98-fb6805fb9b2c",
"FieldId": "fd39413a-9188-4078-813a-289aecb888d1",
"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": "e6c5c05c-ddef-49b0-9589-c2316655cf2e",
"Section": {
"FormTypeSectionId": "50cad9e9-ee43-496f-aa19-fc24807d71cf",
"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": "d1691fa3-c197-466d-8442-b2e4bc9b8c78",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "67427e2a-22fc-4be5-8afc-3286a705e810",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e511c117-2307-4285-8e69-f7943ba54cf9",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "76f8ad1e-5678-4546-9a98-fb6805fb9b2c",
"FieldId": "fd39413a-9188-4078-813a-289aecb888d1",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "76f8ad1e-5678-4546-9a98-fb6805fb9b2c",
"FieldId": "fd39413a-9188-4078-813a-289aecb888d1",
"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": "af44ac21-a9ae-4734-8321-e7a7174cdc25",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-09-26T13:59:10.1701707-07:00",
"Location": "sample string 1",
"TaskId": "e9653108-de61-443b-bbad-21a5ceba80bc",
"Values": [
{
"FormFieldValueId": "8ca8dd7e-cf35-4198-8b24-e0c29fc9b183",
"FormId": "41dda683-f6c3-4fe4-a08f-0ad4575a684c",
"FormTypeField": {
"FormTypeFieldId": "e6c5c05c-ddef-49b0-9589-c2316655cf2e",
"FormType": {
"FormTypeId": "9f3be629-117d-4d31-bbb8-982db3ce6be0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "932e8db6-d393-4056-97ae-328fb1642735",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3cbcda9b-f10a-42f4-81e0-b4747d4e9346",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-26T13:59:10.1701707-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "af44ac21-a9ae-4734-8321-e7a7174cdc25",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "50cad9e9-ee43-496f-aa19-fc24807d71cf",
"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": "d1691fa3-c197-466d-8442-b2e4bc9b8c78",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "67427e2a-22fc-4be5-8afc-3286a705e810",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e511c117-2307-4285-8e69-f7943ba54cf9",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "76f8ad1e-5678-4546-9a98-fb6805fb9b2c",
"FieldId": "fd39413a-9188-4078-813a-289aecb888d1",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "76f8ad1e-5678-4546-9a98-fb6805fb9b2c",
"FieldId": "fd39413a-9188-4078-813a-289aecb888d1",
"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": "8ca8dd7e-cf35-4198-8b24-e0c29fc9b183",
"FormId": "41dda683-f6c3-4fe4-a08f-0ad4575a684c",
"FormTypeField": {
"FormTypeFieldId": "e6c5c05c-ddef-49b0-9589-c2316655cf2e",
"FormType": {
"FormTypeId": "9f3be629-117d-4d31-bbb8-982db3ce6be0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "932e8db6-d393-4056-97ae-328fb1642735",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3cbcda9b-f10a-42f4-81e0-b4747d4e9346",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-26T13:59:10.1701707-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "af44ac21-a9ae-4734-8321-e7a7174cdc25",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "50cad9e9-ee43-496f-aa19-fc24807d71cf",
"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": "d1691fa3-c197-466d-8442-b2e4bc9b8c78",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "67427e2a-22fc-4be5-8afc-3286a705e810",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e511c117-2307-4285-8e69-f7943ba54cf9",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "76f8ad1e-5678-4546-9a98-fb6805fb9b2c",
"FieldId": "fd39413a-9188-4078-813a-289aecb888d1",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "76f8ad1e-5678-4546-9a98-fb6805fb9b2c",
"FieldId": "fd39413a-9188-4078-813a-289aecb888d1",
"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": "acc0042f-d252-488d-a29c-4c6a925f17db",
"CreateDate": "2026-09-26T13:59:10.1701707-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-26T13:59:10.1701707-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}