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": "8fdc2b5c-0487-40f2-b762-d9c8aa5f8dda",
"Asset": {
"AssetId": "8c7748a6-07e1-446f-a0ad-4a9ca0bd7a59",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d637dd9e-ac2e-4dfa-b93a-0938f714605d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "83e8d93f-b97d-4e97-b707-0489db495d04",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "1c3643a3-e4a5-4a6a-bd51-c0dd33e0c063",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-08T12:06:24.692348-07:00",
"MeasurementValueNeededDate": "2026-08-08T12:06:24.692348-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4c394ba0-8237-44dd-b0fc-535ed436ae12",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "44d53146-b3e7-47d7-a9ac-a1e28001a05f",
"EffectiveDate": "2026-08-08T12:06:24.692348-07:00",
"StateType": {
"StateTypeId": "e46cd4ab-c3de-4c95-b0be-feabf9b58b48",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d637dd9e-ac2e-4dfa-b93a-0938f714605d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "83e8d93f-b97d-4e97-b707-0489db495d04",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "cf12cff4-3188-4cc5-8aeb-c8bad3bd4e04",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "131def1e-3a29-4a41-ac03-ac0fe46ce999",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "90f3de3a-e63b-42a6-8e76-6057f7e9e219",
"EffectiveDate": "2026-08-08T12:06:24.692348-07:00",
"StatusType": {
"StatusTypeId": "7d6a0f04-c444-4db9-b5ca-b4f06a7b68d9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d637dd9e-ac2e-4dfa-b93a-0938f714605d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "83e8d93f-b97d-4e97-b707-0489db495d04",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "16680c11-877f-4ede-93c4-5dd02a984c4b",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cbff226b-c1dc-4ddc-851e-3c884e5a4318",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "be66a25f-b2fd-4d91-bc13-6e2d1eb8271b",
"EffectiveDate": "2026-08-08T12:06:24.692348-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d6dbcf05-d4dc-409a-a677-37c70bdbd182",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4ae0148d-0c1f-4aff-80a6-5bf3d8e604ad",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "59cf0b24-a48b-4871-95cc-8f15fb6c59d9",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-08T12:06:24.692348-07:00",
"MeasurementValueNeededDate": "2026-08-08T12:06:24.692348-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "36c6e469-5e56-48b6-a11d-eedde57f1ed9",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "abe920c0-7634-4442-b659-9e2b4aa600c0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d637dd9e-ac2e-4dfa-b93a-0938f714605d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "83e8d93f-b97d-4e97-b707-0489db495d04",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-08T12:06:24.692348-07:00",
"Fields": [
{
"FormTypeFieldId": "0d65e92d-cf45-4895-a9a3-493d5e50a6ec",
"Section": {
"FormTypeSectionId": "8e768e02-d534-4707-a636-10d17e98c685",
"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": "02b67e97-d34c-412f-9055-1e80e1a76aa9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8ac8bf1e-eb8c-407b-a4ad-97fca3e03e19",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "efdcd3d2-d049-45ca-a379-fda3fd388bf9",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "cffbcfe6-e390-4ce4-b170-dad370dadd67",
"FieldId": "d3ba9b57-9d74-4f14-a47b-2e6d2f2f40f5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "cffbcfe6-e390-4ce4-b170-dad370dadd67",
"FieldId": "d3ba9b57-9d74-4f14-a47b-2e6d2f2f40f5",
"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": "0d65e92d-cf45-4895-a9a3-493d5e50a6ec",
"Section": {
"FormTypeSectionId": "8e768e02-d534-4707-a636-10d17e98c685",
"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": "02b67e97-d34c-412f-9055-1e80e1a76aa9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8ac8bf1e-eb8c-407b-a4ad-97fca3e03e19",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "efdcd3d2-d049-45ca-a379-fda3fd388bf9",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "cffbcfe6-e390-4ce4-b170-dad370dadd67",
"FieldId": "d3ba9b57-9d74-4f14-a47b-2e6d2f2f40f5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "cffbcfe6-e390-4ce4-b170-dad370dadd67",
"FieldId": "d3ba9b57-9d74-4f14-a47b-2e6d2f2f40f5",
"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": "dc3293ef-cea4-4073-bbdc-2af5b73a7cab",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-08-08T12:06:24.692348-07:00",
"Location": "sample string 1",
"TaskId": "43b3c0d1-2e6f-40ff-9a72-6d300bb720d4",
"Values": [
{
"FormFieldValueId": "3cae179c-d48e-4585-a620-af8573f37b00",
"FormId": "9d43a1b8-7beb-469e-92ee-5fde5c4dcc76",
"FormTypeField": {
"FormTypeFieldId": "0d65e92d-cf45-4895-a9a3-493d5e50a6ec",
"FormType": {
"FormTypeId": "abe920c0-7634-4442-b659-9e2b4aa600c0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d637dd9e-ac2e-4dfa-b93a-0938f714605d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "83e8d93f-b97d-4e97-b707-0489db495d04",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-08T12:06:24.692348-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "dc3293ef-cea4-4073-bbdc-2af5b73a7cab",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "8e768e02-d534-4707-a636-10d17e98c685",
"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": "02b67e97-d34c-412f-9055-1e80e1a76aa9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8ac8bf1e-eb8c-407b-a4ad-97fca3e03e19",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "efdcd3d2-d049-45ca-a379-fda3fd388bf9",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "cffbcfe6-e390-4ce4-b170-dad370dadd67",
"FieldId": "d3ba9b57-9d74-4f14-a47b-2e6d2f2f40f5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "cffbcfe6-e390-4ce4-b170-dad370dadd67",
"FieldId": "d3ba9b57-9d74-4f14-a47b-2e6d2f2f40f5",
"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": "3cae179c-d48e-4585-a620-af8573f37b00",
"FormId": "9d43a1b8-7beb-469e-92ee-5fde5c4dcc76",
"FormTypeField": {
"FormTypeFieldId": "0d65e92d-cf45-4895-a9a3-493d5e50a6ec",
"FormType": {
"FormTypeId": "abe920c0-7634-4442-b659-9e2b4aa600c0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d637dd9e-ac2e-4dfa-b93a-0938f714605d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "83e8d93f-b97d-4e97-b707-0489db495d04",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-08T12:06:24.692348-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "dc3293ef-cea4-4073-bbdc-2af5b73a7cab",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "8e768e02-d534-4707-a636-10d17e98c685",
"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": "02b67e97-d34c-412f-9055-1e80e1a76aa9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8ac8bf1e-eb8c-407b-a4ad-97fca3e03e19",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "efdcd3d2-d049-45ca-a379-fda3fd388bf9",
"CreateDate": "2026-08-08T12:06:24.692348-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T12:06:24.692348-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "cffbcfe6-e390-4ce4-b170-dad370dadd67",
"FieldId": "d3ba9b57-9d74-4f14-a47b-2e6d2f2f40f5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "cffbcfe6-e390-4ce4-b170-dad370dadd67",
"FieldId": "d3ba9b57-9d74-4f14-a47b-2e6d2f2f40f5",
"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": "2e6a2954-fa69-42b1-b567-b80a70ccc798",
"CreateDate": "2026-08-08T12:06:24.7079188-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-08T12:06:24.7079188-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}