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": "8bbce186-1604-4da1-a311-5cd3db11a672",
"Asset": {
"AssetId": "25c79c54-8e12-4139-a0a2-e9112216e40e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c80e8c54-d6fb-40b7-a115-b2b21268e2a8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ac6dd799-605c-448f-b2d1-25f40d5540b5",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "3220003b-0716-4314-8444-cc852e53ed09",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-19T09:35:07.6811573-08:00",
"MeasurementValueNeededDate": "2026-01-19T09:35:07.6811573-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ca7dfdac-c825-4ff8-bbe6-66505a3678b6",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "aaf06cdc-e803-4589-baa8-05831ddebdec",
"EffectiveDate": "2026-01-19T09:35:07.6811573-08:00",
"StateType": {
"StateTypeId": "156308a9-259e-447f-b3d6-179cad766de5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c80e8c54-d6fb-40b7-a115-b2b21268e2a8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ac6dd799-605c-448f-b2d1-25f40d5540b5",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8fdbc7e1-539f-48af-aa24-a3d55c73dcc8",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2a4fae75-44f0-4bc6-9752-3ba2e6d82379",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "5bce1b53-2a6c-4211-869b-5e6179a5cc42",
"EffectiveDate": "2026-01-19T09:35:07.6811573-08:00",
"StatusType": {
"StatusTypeId": "ab256789-6d11-4a15-b644-c23807866d65",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c80e8c54-d6fb-40b7-a115-b2b21268e2a8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ac6dd799-605c-448f-b2d1-25f40d5540b5",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3a416dc9-dcf3-48a7-b71f-3b78a3b5a951",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "25c52533-a838-44ea-8999-6729cd9fbbe0",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "0d6cd43d-c1e3-4cb6-985f-7324dc4a7ad0",
"EffectiveDate": "2026-01-19T09:35:07.6811573-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "afda6c47-191b-4fb1-a35a-7c177c9bb8e9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "15cd2ac2-993d-4b04-8f75-ded52f810010",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "49e6b886-bd70-4092-a8ac-6b45fed523d9",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-01-19T09:35:07.6811573-08:00",
"MeasurementValueNeededDate": "2026-01-19T09:35:07.6811573-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8f99d5a8-5fe6-487a-9bb0-172230e87420",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "1420b77f-455b-4c7a-8c1a-984d6fcbed19",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c80e8c54-d6fb-40b7-a115-b2b21268e2a8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ac6dd799-605c-448f-b2d1-25f40d5540b5",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-19T09:35:07.6811573-08:00",
"Fields": [
{
"FormTypeFieldId": "f181c640-929f-41c6-a2dd-92e80c9dd9b8",
"Section": {
"FormTypeSectionId": "a7d778dc-1e2c-4554-be8f-fd61cb048187",
"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": "99d034fa-de93-4fbf-8fc5-0772747e55d4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fb9acc80-4ad0-4aee-9f54-7a4c9b13b06b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0b3e89d1-fc97-49c3-b434-be5846ca87bd",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ae3ae854-8ebb-48c3-b0b6-4e7e27f32c71",
"FieldId": "278e7f72-f97c-4927-bc17-b3ff7e7d7e60",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ae3ae854-8ebb-48c3-b0b6-4e7e27f32c71",
"FieldId": "278e7f72-f97c-4927-bc17-b3ff7e7d7e60",
"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": "f181c640-929f-41c6-a2dd-92e80c9dd9b8",
"Section": {
"FormTypeSectionId": "a7d778dc-1e2c-4554-be8f-fd61cb048187",
"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": "99d034fa-de93-4fbf-8fc5-0772747e55d4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fb9acc80-4ad0-4aee-9f54-7a4c9b13b06b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0b3e89d1-fc97-49c3-b434-be5846ca87bd",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ae3ae854-8ebb-48c3-b0b6-4e7e27f32c71",
"FieldId": "278e7f72-f97c-4927-bc17-b3ff7e7d7e60",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ae3ae854-8ebb-48c3-b0b6-4e7e27f32c71",
"FieldId": "278e7f72-f97c-4927-bc17-b3ff7e7d7e60",
"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": "e9696ec3-edee-4d6a-b10b-397d235dca8f",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-01-19T09:35:07.6811573-08:00",
"Location": "sample string 1",
"TaskId": "5e203208-4917-4582-b352-3065b3758ffb",
"Values": [
{
"FormFieldValueId": "7e48eab6-04e9-4c63-b56d-a8694cd4b4d8",
"FormId": "4feec716-7267-4323-83cd-14d8de0733ac",
"FormTypeField": {
"FormTypeFieldId": "f181c640-929f-41c6-a2dd-92e80c9dd9b8",
"FormType": {
"FormTypeId": "1420b77f-455b-4c7a-8c1a-984d6fcbed19",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c80e8c54-d6fb-40b7-a115-b2b21268e2a8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ac6dd799-605c-448f-b2d1-25f40d5540b5",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-19T09:35:07.6811573-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "e9696ec3-edee-4d6a-b10b-397d235dca8f",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "a7d778dc-1e2c-4554-be8f-fd61cb048187",
"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": "99d034fa-de93-4fbf-8fc5-0772747e55d4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fb9acc80-4ad0-4aee-9f54-7a4c9b13b06b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0b3e89d1-fc97-49c3-b434-be5846ca87bd",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ae3ae854-8ebb-48c3-b0b6-4e7e27f32c71",
"FieldId": "278e7f72-f97c-4927-bc17-b3ff7e7d7e60",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ae3ae854-8ebb-48c3-b0b6-4e7e27f32c71",
"FieldId": "278e7f72-f97c-4927-bc17-b3ff7e7d7e60",
"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": "7e48eab6-04e9-4c63-b56d-a8694cd4b4d8",
"FormId": "4feec716-7267-4323-83cd-14d8de0733ac",
"FormTypeField": {
"FormTypeFieldId": "f181c640-929f-41c6-a2dd-92e80c9dd9b8",
"FormType": {
"FormTypeId": "1420b77f-455b-4c7a-8c1a-984d6fcbed19",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c80e8c54-d6fb-40b7-a115-b2b21268e2a8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ac6dd799-605c-448f-b2d1-25f40d5540b5",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-19T09:35:07.6811573-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "e9696ec3-edee-4d6a-b10b-397d235dca8f",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "a7d778dc-1e2c-4554-be8f-fd61cb048187",
"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": "99d034fa-de93-4fbf-8fc5-0772747e55d4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fb9acc80-4ad0-4aee-9f54-7a4c9b13b06b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0b3e89d1-fc97-49c3-b434-be5846ca87bd",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ae3ae854-8ebb-48c3-b0b6-4e7e27f32c71",
"FieldId": "278e7f72-f97c-4927-bc17-b3ff7e7d7e60",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ae3ae854-8ebb-48c3-b0b6-4e7e27f32c71",
"FieldId": "278e7f72-f97c-4927-bc17-b3ff7e7d7e60",
"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": "46138a40-c78a-44eb-bbc5-3df3c8e25fd6",
"CreateDate": "2026-01-19T09:35:07.6811573-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-19T09:35:07.6811573-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}