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": "422280a4-c269-47db-94ab-75ca876f5102",
"Asset": {
"AssetId": "d2eb8276-8aa4-42ff-92a6-85e527919284",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2be89262-2201-46c8-8003-2c6deb9250e3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "568c983e-b214-4149-b46f-bc0b89b2a44c",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a9590aef-eb42-4dc3-8338-ffdc1db1d05a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T15:56:36.1876779-07:00",
"MeasurementValueNeededDate": "2026-03-30T15:56:36.1876779-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c2800d03-acca-430a-b52f-eda900f3f1cb",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "0be771c3-4bc4-4891-a0d6-f0bd28402dd3",
"EffectiveDate": "2026-03-30T15:56:36.1876779-07:00",
"StateType": {
"StateTypeId": "f3d493b4-0e7f-4835-99e0-5e76981cfc1b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2be89262-2201-46c8-8003-2c6deb9250e3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "568c983e-b214-4149-b46f-bc0b89b2a44c",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6642b0d2-024a-4125-8e67-80623cc85199",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "848bef40-10ad-4a98-a52a-c37afe23db36",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "28a72d84-721f-4bae-85e6-4d57716415a9",
"EffectiveDate": "2026-03-30T15:56:36.1876779-07:00",
"StatusType": {
"StatusTypeId": "23309117-b0a5-4b99-852a-2a6011fea33d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2be89262-2201-46c8-8003-2c6deb9250e3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "568c983e-b214-4149-b46f-bc0b89b2a44c",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "bac1f828-d153-49ee-a254-2d5229c21d22",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "43518c0a-bed9-48f0-9e37-be5ac4cd33b9",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "07c0cef7-0b53-4f0c-98f9-d39fe4b2f3a6",
"EffectiveDate": "2026-03-30T15:56:36.1876779-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "82cd6bf6-45c7-41c1-8b88-c07da451ae80",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c7a64227-cda6-43d9-86a3-35b80f184aa5",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "71d5d775-b526-4efb-9e55-1574c4b57a57",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-30T15:56:36.1876779-07:00",
"MeasurementValueNeededDate": "2026-03-30T15:56:36.1876779-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bb42573f-4ca0-4c7b-abaa-1c14ae35b2fb",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "a0f45137-e10a-4521-a008-93cad7b7beaa",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2be89262-2201-46c8-8003-2c6deb9250e3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "568c983e-b214-4149-b46f-bc0b89b2a44c",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-30T15:56:36.1876779-07:00",
"Fields": [
{
"FormTypeFieldId": "97eaa729-3d74-4976-896d-ac18194e508c",
"Section": {
"FormTypeSectionId": "1885405c-152d-4cc4-932e-ee8fe5552250",
"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": "0e0f0c39-ff58-4498-b7bd-0bbd4cef8c9f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8e09f8ad-8e2b-4101-9120-e1eee60ab8b4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "eed2e63a-9e54-4ffa-b87b-52da55376977",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6246aec0-69b1-4b53-a367-bf937add9382",
"FieldId": "0b3286be-10d3-48c2-9ebb-bacbc92e6918",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6246aec0-69b1-4b53-a367-bf937add9382",
"FieldId": "0b3286be-10d3-48c2-9ebb-bacbc92e6918",
"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": "97eaa729-3d74-4976-896d-ac18194e508c",
"Section": {
"FormTypeSectionId": "1885405c-152d-4cc4-932e-ee8fe5552250",
"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": "0e0f0c39-ff58-4498-b7bd-0bbd4cef8c9f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8e09f8ad-8e2b-4101-9120-e1eee60ab8b4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "eed2e63a-9e54-4ffa-b87b-52da55376977",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6246aec0-69b1-4b53-a367-bf937add9382",
"FieldId": "0b3286be-10d3-48c2-9ebb-bacbc92e6918",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6246aec0-69b1-4b53-a367-bf937add9382",
"FieldId": "0b3286be-10d3-48c2-9ebb-bacbc92e6918",
"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": "028db3f8-6314-4ef8-ae54-883c64862b16",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-03-30T15:56:36.1876779-07:00",
"Location": "sample string 1",
"TaskId": "c6046792-11b4-4cd2-b007-cbc58004e002",
"Values": [
{
"FormFieldValueId": "eee88d6c-5de9-4177-bdf2-e8ef857613bf",
"FormId": "295b832d-1f32-4361-ba7e-ee74746444b6",
"FormTypeField": {
"FormTypeFieldId": "97eaa729-3d74-4976-896d-ac18194e508c",
"FormType": {
"FormTypeId": "a0f45137-e10a-4521-a008-93cad7b7beaa",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2be89262-2201-46c8-8003-2c6deb9250e3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "568c983e-b214-4149-b46f-bc0b89b2a44c",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-30T15:56:36.1876779-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "028db3f8-6314-4ef8-ae54-883c64862b16",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "1885405c-152d-4cc4-932e-ee8fe5552250",
"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": "0e0f0c39-ff58-4498-b7bd-0bbd4cef8c9f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8e09f8ad-8e2b-4101-9120-e1eee60ab8b4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "eed2e63a-9e54-4ffa-b87b-52da55376977",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6246aec0-69b1-4b53-a367-bf937add9382",
"FieldId": "0b3286be-10d3-48c2-9ebb-bacbc92e6918",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6246aec0-69b1-4b53-a367-bf937add9382",
"FieldId": "0b3286be-10d3-48c2-9ebb-bacbc92e6918",
"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": "eee88d6c-5de9-4177-bdf2-e8ef857613bf",
"FormId": "295b832d-1f32-4361-ba7e-ee74746444b6",
"FormTypeField": {
"FormTypeFieldId": "97eaa729-3d74-4976-896d-ac18194e508c",
"FormType": {
"FormTypeId": "a0f45137-e10a-4521-a008-93cad7b7beaa",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2be89262-2201-46c8-8003-2c6deb9250e3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "568c983e-b214-4149-b46f-bc0b89b2a44c",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-30T15:56:36.1876779-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "028db3f8-6314-4ef8-ae54-883c64862b16",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "1885405c-152d-4cc4-932e-ee8fe5552250",
"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": "0e0f0c39-ff58-4498-b7bd-0bbd4cef8c9f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8e09f8ad-8e2b-4101-9120-e1eee60ab8b4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "eed2e63a-9e54-4ffa-b87b-52da55376977",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6246aec0-69b1-4b53-a367-bf937add9382",
"FieldId": "0b3286be-10d3-48c2-9ebb-bacbc92e6918",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6246aec0-69b1-4b53-a367-bf937add9382",
"FieldId": "0b3286be-10d3-48c2-9ebb-bacbc92e6918",
"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": "eb8de3d9-1e2d-4388-b9f7-f2203ad36ecb",
"CreateDate": "2026-03-30T15:56:36.1876779-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-30T15:56:36.1876779-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}