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": "4579ac30-0326-4c67-8c67-a0998f3820ec",
"Asset": {
"AssetId": "ad6f8a77-eafd-4c51-8053-9b0791abb656",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ac8e9b4b-5f6a-4b89-8ae4-49c122dba66c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "deaa1887-1ecd-416d-a292-d96272d30591",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7dab67eb-111b-4af5-b95f-83adacac1867",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T09:02:52.5077957-08:00",
"MeasurementValueNeededDate": "2026-11-22T09:02:52.5077957-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1beb45fb-4f60-4280-bce8-f395827623f3",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2770c89a-aecc-4bbb-bb48-5ec2ee73fda9",
"EffectiveDate": "2026-11-22T09:02:52.5077957-08:00",
"StateType": {
"StateTypeId": "bc27ce2c-540c-4bd6-b566-b70083325244",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ac8e9b4b-5f6a-4b89-8ae4-49c122dba66c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "deaa1887-1ecd-416d-a292-d96272d30591",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "496f9ff1-5c97-4cb3-a1c1-2b23e9776b9b",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e0ca830f-2600-49b4-85b8-ed1d4535b116",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fcb114fd-0224-4d01-9908-9f8ef7c87f24",
"EffectiveDate": "2026-11-22T09:02:52.5077957-08:00",
"StatusType": {
"StatusTypeId": "fafad187-ab81-4d16-b78c-d55f419172bf",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ac8e9b4b-5f6a-4b89-8ae4-49c122dba66c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "deaa1887-1ecd-416d-a292-d96272d30591",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "78e2b756-ca97-4355-bce4-c50accb84912",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f8fa9bf8-d2b1-4833-bdf7-dd9a13efdeef",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9e01e992-c01a-4cd7-893a-b1a31b2d2dfa",
"EffectiveDate": "2026-11-22T09:02:52.5077957-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "0d771c97-8fec-46c6-aee9-30e4b25e569b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3bf8b7df-fa6c-40fc-bce0-1bff03ad8d9f",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "db7f6dfb-49bb-4504-8bf3-fa2de7e1b0c8",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T09:02:52.5077957-08:00",
"MeasurementValueNeededDate": "2026-11-22T09:02:52.5077957-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "47bbd11a-5db4-42cf-9658-5b829e73f96a",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "471bd3d7-7740-4c28-a3ee-1e968a187e44",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ac8e9b4b-5f6a-4b89-8ae4-49c122dba66c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "deaa1887-1ecd-416d-a292-d96272d30591",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-22T09:02:52.5077957-08:00",
"Fields": [
{
"FormTypeFieldId": "35b6ab13-66c1-4a87-a464-67ace81cc0ad",
"Section": {
"FormTypeSectionId": "7bab29e9-7629-484f-b263-63159368c9e6",
"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": "b17b55f9-8416-4924-ae02-4fe45f836b2d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f8c8abf7-6610-496f-b0be-864f7f1bfc55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "111e040f-ef6c-4614-95e4-39d2fe8f826e",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "047ca07b-5e68-4b6c-914b-f1a5bdc215ec",
"FieldId": "d078ed33-68d8-4a1f-bab0-efd6b8652cfb",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "047ca07b-5e68-4b6c-914b-f1a5bdc215ec",
"FieldId": "d078ed33-68d8-4a1f-bab0-efd6b8652cfb",
"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": "35b6ab13-66c1-4a87-a464-67ace81cc0ad",
"Section": {
"FormTypeSectionId": "7bab29e9-7629-484f-b263-63159368c9e6",
"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": "b17b55f9-8416-4924-ae02-4fe45f836b2d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f8c8abf7-6610-496f-b0be-864f7f1bfc55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "111e040f-ef6c-4614-95e4-39d2fe8f826e",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "047ca07b-5e68-4b6c-914b-f1a5bdc215ec",
"FieldId": "d078ed33-68d8-4a1f-bab0-efd6b8652cfb",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "047ca07b-5e68-4b6c-914b-f1a5bdc215ec",
"FieldId": "d078ed33-68d8-4a1f-bab0-efd6b8652cfb",
"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": "f356e20b-69b4-47f1-8caf-e339092b48a6",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-11-22T09:02:52.5077957-08:00",
"Location": "sample string 1",
"TaskId": "74950f69-b7a3-4be4-9fb8-ed1c41629114",
"Values": [
{
"FormFieldValueId": "1a748410-4156-446f-8e1d-d2f9491c2333",
"FormId": "c6670b67-9bd4-4fe6-bfdf-5b47fec9115e",
"FormTypeField": {
"FormTypeFieldId": "35b6ab13-66c1-4a87-a464-67ace81cc0ad",
"FormType": {
"FormTypeId": "471bd3d7-7740-4c28-a3ee-1e968a187e44",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ac8e9b4b-5f6a-4b89-8ae4-49c122dba66c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "deaa1887-1ecd-416d-a292-d96272d30591",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-22T09:02:52.5077957-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "f356e20b-69b4-47f1-8caf-e339092b48a6",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "7bab29e9-7629-484f-b263-63159368c9e6",
"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": "b17b55f9-8416-4924-ae02-4fe45f836b2d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f8c8abf7-6610-496f-b0be-864f7f1bfc55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "111e040f-ef6c-4614-95e4-39d2fe8f826e",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "047ca07b-5e68-4b6c-914b-f1a5bdc215ec",
"FieldId": "d078ed33-68d8-4a1f-bab0-efd6b8652cfb",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "047ca07b-5e68-4b6c-914b-f1a5bdc215ec",
"FieldId": "d078ed33-68d8-4a1f-bab0-efd6b8652cfb",
"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": "1a748410-4156-446f-8e1d-d2f9491c2333",
"FormId": "c6670b67-9bd4-4fe6-bfdf-5b47fec9115e",
"FormTypeField": {
"FormTypeFieldId": "35b6ab13-66c1-4a87-a464-67ace81cc0ad",
"FormType": {
"FormTypeId": "471bd3d7-7740-4c28-a3ee-1e968a187e44",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ac8e9b4b-5f6a-4b89-8ae4-49c122dba66c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "deaa1887-1ecd-416d-a292-d96272d30591",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-22T09:02:52.5077957-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "f356e20b-69b4-47f1-8caf-e339092b48a6",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "7bab29e9-7629-484f-b263-63159368c9e6",
"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": "b17b55f9-8416-4924-ae02-4fe45f836b2d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f8c8abf7-6610-496f-b0be-864f7f1bfc55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "111e040f-ef6c-4614-95e4-39d2fe8f826e",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "047ca07b-5e68-4b6c-914b-f1a5bdc215ec",
"FieldId": "d078ed33-68d8-4a1f-bab0-efd6b8652cfb",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "047ca07b-5e68-4b6c-914b-f1a5bdc215ec",
"FieldId": "d078ed33-68d8-4a1f-bab0-efd6b8652cfb",
"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": "d9a649be-682b-4784-aedb-d919aab3bc59",
"CreateDate": "2026-11-22T09:02:52.5077957-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-22T09:02:52.5077957-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}