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": "dc036f75-9c7f-452b-9610-e3fb9dc81994",
"Asset": {
"AssetId": "c0f239fa-2f35-4217-8f09-944d8bb7b05e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0f4deb9f-6eec-43a2-a7bd-0a2f59ec0420",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d8963aa6-0903-4d46-ba34-c14f3571f001",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f273d701-76b5-4bad-a57b-b77b926d4489",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-26T18:20:54.3179896-08:00",
"MeasurementValueNeededDate": "2026-02-26T18:20:54.3179896-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c7399e15-84e4-484f-ae81-dbe2d382bbdc",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c7e5feb6-135d-4c41-9769-d25197bea07e",
"EffectiveDate": "2026-02-26T18:20:54.3179896-08:00",
"StateType": {
"StateTypeId": "108774be-9186-4bb0-83d0-fd511c191387",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0f4deb9f-6eec-43a2-a7bd-0a2f59ec0420",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d8963aa6-0903-4d46-ba34-c14f3571f001",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f79fe534-4e63-406a-836f-48279ce171e7",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4c2d73f7-3a19-4ffb-b97f-74d98524cd6a",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "900e5976-de0b-4c0f-995d-27e77da4301f",
"EffectiveDate": "2026-02-26T18:20:54.3179896-08:00",
"StatusType": {
"StatusTypeId": "c2c95494-0683-4dec-a435-f9b753874eb3",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0f4deb9f-6eec-43a2-a7bd-0a2f59ec0420",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d8963aa6-0903-4d46-ba34-c14f3571f001",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "beede17a-3847-4b96-94ab-b7dcef36f32a",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a2176e82-43bf-4bd4-99c6-70c5c14a6660",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b64744f6-48dc-4bef-beff-9d82cf376891",
"EffectiveDate": "2026-02-26T18:20:54.3179896-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "d12a3fb1-eac4-4b2a-afba-222f4a7476c8",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d2805c41-7430-4f86-9575-754be9e616b1",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ae07e229-4b9b-44a3-86ac-25eee7e0d985",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-26T18:20:54.3179896-08:00",
"MeasurementValueNeededDate": "2026-02-26T18:20:54.3179896-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1662c240-c23c-4d5e-90b9-8069127a805b",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "858eef06-5947-4fa0-a47f-3b40fdaa03a7",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0f4deb9f-6eec-43a2-a7bd-0a2f59ec0420",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d8963aa6-0903-4d46-ba34-c14f3571f001",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-26T18:20:54.3179896-08:00",
"Fields": [
{
"FormTypeFieldId": "a1cbe32d-3299-4ffe-9f93-4c21bf2a700e",
"Section": {
"FormTypeSectionId": "15998528-6a1a-40a8-b955-ada2fa0b7467",
"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": "9a02bf5e-8fe0-4cdd-b533-bdb0be3c9ab2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "809993f7-a7be-490e-92e1-ad140dc17fbc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "735f0b4d-b28a-4110-87b1-fb5ca87cabf1",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "140e4aa5-715b-46f5-8e28-37b452499eb1",
"FieldId": "a7d3ee32-c4c8-4ca8-b8c9-129025c6dfdc",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "140e4aa5-715b-46f5-8e28-37b452499eb1",
"FieldId": "a7d3ee32-c4c8-4ca8-b8c9-129025c6dfdc",
"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": "a1cbe32d-3299-4ffe-9f93-4c21bf2a700e",
"Section": {
"FormTypeSectionId": "15998528-6a1a-40a8-b955-ada2fa0b7467",
"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": "9a02bf5e-8fe0-4cdd-b533-bdb0be3c9ab2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "809993f7-a7be-490e-92e1-ad140dc17fbc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "735f0b4d-b28a-4110-87b1-fb5ca87cabf1",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "140e4aa5-715b-46f5-8e28-37b452499eb1",
"FieldId": "a7d3ee32-c4c8-4ca8-b8c9-129025c6dfdc",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "140e4aa5-715b-46f5-8e28-37b452499eb1",
"FieldId": "a7d3ee32-c4c8-4ca8-b8c9-129025c6dfdc",
"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": "53c352a6-237a-4396-aea6-b8a264a19df3",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-02-26T18:20:54.3179896-08:00",
"Location": "sample string 1",
"TaskId": "681fc74d-bddd-4170-8c10-1745e272e7f8",
"Values": [
{
"FormFieldValueId": "9698323c-d959-4ba7-a268-ca9ee6fac71f",
"FormId": "44f535f6-861a-46e0-b3ff-528748423a09",
"FormTypeField": {
"FormTypeFieldId": "a1cbe32d-3299-4ffe-9f93-4c21bf2a700e",
"FormType": {
"FormTypeId": "858eef06-5947-4fa0-a47f-3b40fdaa03a7",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0f4deb9f-6eec-43a2-a7bd-0a2f59ec0420",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d8963aa6-0903-4d46-ba34-c14f3571f001",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-26T18:20:54.3179896-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "53c352a6-237a-4396-aea6-b8a264a19df3",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "15998528-6a1a-40a8-b955-ada2fa0b7467",
"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": "9a02bf5e-8fe0-4cdd-b533-bdb0be3c9ab2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "809993f7-a7be-490e-92e1-ad140dc17fbc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "735f0b4d-b28a-4110-87b1-fb5ca87cabf1",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "140e4aa5-715b-46f5-8e28-37b452499eb1",
"FieldId": "a7d3ee32-c4c8-4ca8-b8c9-129025c6dfdc",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "140e4aa5-715b-46f5-8e28-37b452499eb1",
"FieldId": "a7d3ee32-c4c8-4ca8-b8c9-129025c6dfdc",
"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": "9698323c-d959-4ba7-a268-ca9ee6fac71f",
"FormId": "44f535f6-861a-46e0-b3ff-528748423a09",
"FormTypeField": {
"FormTypeFieldId": "a1cbe32d-3299-4ffe-9f93-4c21bf2a700e",
"FormType": {
"FormTypeId": "858eef06-5947-4fa0-a47f-3b40fdaa03a7",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0f4deb9f-6eec-43a2-a7bd-0a2f59ec0420",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d8963aa6-0903-4d46-ba34-c14f3571f001",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-26T18:20:54.3179896-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "53c352a6-237a-4396-aea6-b8a264a19df3",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "15998528-6a1a-40a8-b955-ada2fa0b7467",
"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": "9a02bf5e-8fe0-4cdd-b533-bdb0be3c9ab2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "809993f7-a7be-490e-92e1-ad140dc17fbc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "735f0b4d-b28a-4110-87b1-fb5ca87cabf1",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "140e4aa5-715b-46f5-8e28-37b452499eb1",
"FieldId": "a7d3ee32-c4c8-4ca8-b8c9-129025c6dfdc",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "140e4aa5-715b-46f5-8e28-37b452499eb1",
"FieldId": "a7d3ee32-c4c8-4ca8-b8c9-129025c6dfdc",
"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": "9478567f-a9b6-4fce-89dd-af76b94c7a57",
"CreateDate": "2026-02-26T18:20:54.3179896-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-26T18:20:54.3179896-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}