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": "e47d3d79-8860-4b8a-84e3-d3a4ae41fb8e",
"Asset": {
"AssetId": "635dd26f-4352-4c47-a977-416fcb808269",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9a146546-d1fe-48be-96ca-1f4b5bb2f074",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30bca22b-6e52-4b55-9fdb-2ce7a82a8312",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "615d6df4-ff78-4e3a-97c2-c7c7a91e49af",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T07:27:06.784699-08:00",
"MeasurementValueNeededDate": "2026-11-21T07:27:06.784699-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "300b1cff-206a-4ff8-82de-01c5a1ed9485",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "9b62b6c1-b942-48e5-ab22-e659a8fac135",
"EffectiveDate": "2026-11-21T07:27:06.784699-08:00",
"StateType": {
"StateTypeId": "5ccaf8dd-f879-493a-89e2-bce72a9d3ec4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9a146546-d1fe-48be-96ca-1f4b5bb2f074",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30bca22b-6e52-4b55-9fdb-2ce7a82a8312",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2f94f6e6-03e3-471d-bdb4-1dedc5a83edb",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "68411f19-d752-456d-a311-4bb8633711e3",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b81dafd5-d15f-484d-b7cc-23a00f652e35",
"EffectiveDate": "2026-11-21T07:27:06.784699-08:00",
"StatusType": {
"StatusTypeId": "e8d71c3c-e407-42f5-b09f-f1e3c7237761",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9a146546-d1fe-48be-96ca-1f4b5bb2f074",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30bca22b-6e52-4b55-9fdb-2ce7a82a8312",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c4df93e0-8e41-47f8-8986-2a5fc188a4be",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "91ba4011-5b3f-4c03-b96a-d8be51c8a568",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "459fe7e4-74e3-4663-8476-99b08f70e0d4",
"EffectiveDate": "2026-11-21T07:27:06.784699-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "93626c65-8fc6-4369-b625-f3cfbd6d5676",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "be989a0c-6981-4770-8600-18df0196124b",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e98bb4b9-bf7c-4939-bba2-7c83c2a645b4",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T07:27:06.784699-08:00",
"MeasurementValueNeededDate": "2026-11-21T07:27:06.784699-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8399906b-fab5-45cc-93ef-cc2fd3defe07",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "bcdebc4e-ddfc-4b75-a2e1-0c13c4f9964b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9a146546-d1fe-48be-96ca-1f4b5bb2f074",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30bca22b-6e52-4b55-9fdb-2ce7a82a8312",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T07:27:06.784699-08:00",
"Fields": [
{
"FormTypeFieldId": "534cef01-bf78-4384-b7a2-c4b631d5c732",
"Section": {
"FormTypeSectionId": "193e1c26-4279-43a3-8735-f6882da06a09",
"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": "0c4a5a86-3a7b-411d-909b-595d68fb917d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0b720de0-aa6d-48e0-b60d-604234b704d0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6c61b664-e8cb-48f0-9a78-4d6f32dfbafc",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e8f2682e-2489-4890-8950-95dd1926713a",
"FieldId": "0e34f5af-5b46-4c9a-9b25-0280bba1fb8e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e8f2682e-2489-4890-8950-95dd1926713a",
"FieldId": "0e34f5af-5b46-4c9a-9b25-0280bba1fb8e",
"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": "534cef01-bf78-4384-b7a2-c4b631d5c732",
"Section": {
"FormTypeSectionId": "193e1c26-4279-43a3-8735-f6882da06a09",
"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": "0c4a5a86-3a7b-411d-909b-595d68fb917d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0b720de0-aa6d-48e0-b60d-604234b704d0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6c61b664-e8cb-48f0-9a78-4d6f32dfbafc",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e8f2682e-2489-4890-8950-95dd1926713a",
"FieldId": "0e34f5af-5b46-4c9a-9b25-0280bba1fb8e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e8f2682e-2489-4890-8950-95dd1926713a",
"FieldId": "0e34f5af-5b46-4c9a-9b25-0280bba1fb8e",
"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": "7b9d4efb-ea3f-41db-a732-0b9a04d4fb97",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-11-21T07:27:06.784699-08:00",
"Location": "sample string 1",
"TaskId": "63284a77-6386-474f-a2bd-6fd898f7757f",
"Values": [
{
"FormFieldValueId": "de725e7b-4b47-4884-be37-05339f76c4ad",
"FormId": "7db4a8f5-a32f-438a-98b0-2b1c4b3f47a3",
"FormTypeField": {
"FormTypeFieldId": "534cef01-bf78-4384-b7a2-c4b631d5c732",
"FormType": {
"FormTypeId": "bcdebc4e-ddfc-4b75-a2e1-0c13c4f9964b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9a146546-d1fe-48be-96ca-1f4b5bb2f074",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30bca22b-6e52-4b55-9fdb-2ce7a82a8312",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T07:27:06.784699-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "7b9d4efb-ea3f-41db-a732-0b9a04d4fb97",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "193e1c26-4279-43a3-8735-f6882da06a09",
"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": "0c4a5a86-3a7b-411d-909b-595d68fb917d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0b720de0-aa6d-48e0-b60d-604234b704d0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6c61b664-e8cb-48f0-9a78-4d6f32dfbafc",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e8f2682e-2489-4890-8950-95dd1926713a",
"FieldId": "0e34f5af-5b46-4c9a-9b25-0280bba1fb8e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e8f2682e-2489-4890-8950-95dd1926713a",
"FieldId": "0e34f5af-5b46-4c9a-9b25-0280bba1fb8e",
"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": "de725e7b-4b47-4884-be37-05339f76c4ad",
"FormId": "7db4a8f5-a32f-438a-98b0-2b1c4b3f47a3",
"FormTypeField": {
"FormTypeFieldId": "534cef01-bf78-4384-b7a2-c4b631d5c732",
"FormType": {
"FormTypeId": "bcdebc4e-ddfc-4b75-a2e1-0c13c4f9964b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9a146546-d1fe-48be-96ca-1f4b5bb2f074",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30bca22b-6e52-4b55-9fdb-2ce7a82a8312",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T07:27:06.784699-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "7b9d4efb-ea3f-41db-a732-0b9a04d4fb97",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "193e1c26-4279-43a3-8735-f6882da06a09",
"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": "0c4a5a86-3a7b-411d-909b-595d68fb917d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0b720de0-aa6d-48e0-b60d-604234b704d0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6c61b664-e8cb-48f0-9a78-4d6f32dfbafc",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e8f2682e-2489-4890-8950-95dd1926713a",
"FieldId": "0e34f5af-5b46-4c9a-9b25-0280bba1fb8e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e8f2682e-2489-4890-8950-95dd1926713a",
"FieldId": "0e34f5af-5b46-4c9a-9b25-0280bba1fb8e",
"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": "e306dc97-a97f-4591-a49c-581f2b118d46",
"CreateDate": "2026-11-21T07:27:06.784699-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T07:27:06.784699-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}