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": "3fa23af4-b311-41e7-a154-cecb19c523b2",
"Asset": {
"AssetId": "dedc0d67-ca68-496b-96c4-a79f488b164f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e744c4ad-b957-41cc-95e4-67d3c0af7b3a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "47cf7a50-195b-494d-bafd-dfcc40008187",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b0b4f826-3d69-407c-a80d-2579e9dcc6a1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-31T23:38:46.5838143-07:00",
"MeasurementValueNeededDate": "2026-10-31T23:38:46.5838143-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "efd072c1-dbe0-4045-aa10-bf5632413c18",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d76fd509-09cf-48af-ace6-d6b1f81eea93",
"EffectiveDate": "2026-10-31T23:38:46.5838143-07:00",
"StateType": {
"StateTypeId": "2f873227-98ac-452a-a381-967172cceb9c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "e744c4ad-b957-41cc-95e4-67d3c0af7b3a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "47cf7a50-195b-494d-bafd-dfcc40008187",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0167997a-75b3-4588-9b32-f64d3011adec",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0dd8ffa6-e86b-4fb8-84d5-088074425426",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "62cf9998-1c8e-4bea-a009-f602c68a4243",
"EffectiveDate": "2026-10-31T23:38:46.5838143-07:00",
"StatusType": {
"StatusTypeId": "38170833-df9f-4f23-8f0c-c76a7e4c44a5",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "e744c4ad-b957-41cc-95e4-67d3c0af7b3a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "47cf7a50-195b-494d-bafd-dfcc40008187",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "dde38991-f66f-44d4-ab3f-4204e4255f5c",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "128c4888-ae17-497f-8a8e-a9d073523a34",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f67e601f-1576-4461-845a-e4fc62196c74",
"EffectiveDate": "2026-10-31T23:38:46.5838143-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "6af9a2a4-0c91-4e1b-8df5-5efd41b6a092",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7334588f-8558-4d31-84fe-596b5c967eeb",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "784bc860-fbe0-469f-91ae-21f3b6f7a83b",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-31T23:38:46.5838143-07:00",
"MeasurementValueNeededDate": "2026-10-31T23:38:46.5838143-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6176c679-6399-4177-9c8c-0fecae741f7c",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "2cd100c0-0a62-4756-b447-10142e7ad7a1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e744c4ad-b957-41cc-95e4-67d3c0af7b3a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "47cf7a50-195b-494d-bafd-dfcc40008187",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-31T23:38:46.5838143-07:00",
"Fields": [
{
"FormTypeFieldId": "78d9e9ec-67d5-42ea-872b-c6ded198e3d1",
"Section": {
"FormTypeSectionId": "41db1556-578c-4055-9444-c1a2cbe8a0c7",
"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": "a40f357b-379c-417a-82dc-d0e4972d3edd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2e4f2737-462e-4752-b4d1-a5e3fd1b3279",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "11c21172-5951-4ba6-8723-af4bc04cc9a1",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8edc606e-eeca-4883-8638-537eebd272e1",
"FieldId": "86b98fd7-381d-46eb-a0bd-76f6366cf6df",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8edc606e-eeca-4883-8638-537eebd272e1",
"FieldId": "86b98fd7-381d-46eb-a0bd-76f6366cf6df",
"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": "78d9e9ec-67d5-42ea-872b-c6ded198e3d1",
"Section": {
"FormTypeSectionId": "41db1556-578c-4055-9444-c1a2cbe8a0c7",
"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": "a40f357b-379c-417a-82dc-d0e4972d3edd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2e4f2737-462e-4752-b4d1-a5e3fd1b3279",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "11c21172-5951-4ba6-8723-af4bc04cc9a1",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8edc606e-eeca-4883-8638-537eebd272e1",
"FieldId": "86b98fd7-381d-46eb-a0bd-76f6366cf6df",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8edc606e-eeca-4883-8638-537eebd272e1",
"FieldId": "86b98fd7-381d-46eb-a0bd-76f6366cf6df",
"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": "9d5654e9-4f8c-4ad0-8424-d262411a6477",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-10-31T23:38:46.5838143-07:00",
"Location": "sample string 1",
"TaskId": "4d7e5c42-376e-482c-b9e5-2e0fc6daecb9",
"Values": [
{
"FormFieldValueId": "a8ce5174-558a-4ce0-a9aa-d8c14a6e4b98",
"FormId": "5c5a6725-7b35-4b03-b56f-98b8c718eb97",
"FormTypeField": {
"FormTypeFieldId": "78d9e9ec-67d5-42ea-872b-c6ded198e3d1",
"FormType": {
"FormTypeId": "2cd100c0-0a62-4756-b447-10142e7ad7a1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e744c4ad-b957-41cc-95e4-67d3c0af7b3a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "47cf7a50-195b-494d-bafd-dfcc40008187",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-31T23:38:46.5838143-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "9d5654e9-4f8c-4ad0-8424-d262411a6477",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "41db1556-578c-4055-9444-c1a2cbe8a0c7",
"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": "a40f357b-379c-417a-82dc-d0e4972d3edd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2e4f2737-462e-4752-b4d1-a5e3fd1b3279",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "11c21172-5951-4ba6-8723-af4bc04cc9a1",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8edc606e-eeca-4883-8638-537eebd272e1",
"FieldId": "86b98fd7-381d-46eb-a0bd-76f6366cf6df",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8edc606e-eeca-4883-8638-537eebd272e1",
"FieldId": "86b98fd7-381d-46eb-a0bd-76f6366cf6df",
"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": "a8ce5174-558a-4ce0-a9aa-d8c14a6e4b98",
"FormId": "5c5a6725-7b35-4b03-b56f-98b8c718eb97",
"FormTypeField": {
"FormTypeFieldId": "78d9e9ec-67d5-42ea-872b-c6ded198e3d1",
"FormType": {
"FormTypeId": "2cd100c0-0a62-4756-b447-10142e7ad7a1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e744c4ad-b957-41cc-95e4-67d3c0af7b3a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "47cf7a50-195b-494d-bafd-dfcc40008187",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-31T23:38:46.5838143-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "9d5654e9-4f8c-4ad0-8424-d262411a6477",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "41db1556-578c-4055-9444-c1a2cbe8a0c7",
"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": "a40f357b-379c-417a-82dc-d0e4972d3edd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2e4f2737-462e-4752-b4d1-a5e3fd1b3279",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "11c21172-5951-4ba6-8723-af4bc04cc9a1",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8edc606e-eeca-4883-8638-537eebd272e1",
"FieldId": "86b98fd7-381d-46eb-a0bd-76f6366cf6df",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8edc606e-eeca-4883-8638-537eebd272e1",
"FieldId": "86b98fd7-381d-46eb-a0bd-76f6366cf6df",
"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": "47b18d89-ebb0-442e-887e-8deb2dda72e4",
"CreateDate": "2026-10-31T23:38:46.5838143-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-31T23:38:46.5838143-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}