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": "745760c8-7e3f-4a11-be31-4b2406435b09",
"Asset": {
"AssetId": "c29aeada-83fd-4744-9946-68c95ff933c3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9edbab4b-d160-41cc-8589-a642137e3994",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d0f554f3-e42b-4daf-822e-b37b93c0a8fe",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9fca961f-5dfb-4cef-9757-efe2abe87e51",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-29T09:50:34.8585562-08:00",
"MeasurementValueNeededDate": "2025-11-29T09:50:34.8585562-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3d80e5c5-80d5-4efb-a9d7-9c5c17adcc28",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a44403be-3564-4a62-beb7-2d2fa373f165",
"EffectiveDate": "2025-11-29T09:50:34.8585562-08:00",
"StateType": {
"StateTypeId": "88ddee80-ef5a-48d3-b646-52fe36f4f7a1",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9edbab4b-d160-41cc-8589-a642137e3994",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d0f554f3-e42b-4daf-822e-b37b93c0a8fe",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "dfcab4ad-84d7-43a8-8123-6433437f2f7d",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "27ae4af8-d3e7-4eaf-8a7b-84de17f80107",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "3f9bef80-bb72-4642-8222-add61fb68f66",
"EffectiveDate": "2025-11-29T09:50:34.8585562-08:00",
"StatusType": {
"StatusTypeId": "a476c445-cd31-401b-a07e-1afc0dfb9e6a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9edbab4b-d160-41cc-8589-a642137e3994",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d0f554f3-e42b-4daf-822e-b37b93c0a8fe",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c84b70a5-a811-408f-a92a-082267d18e0f",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7cf6c623-d912-4f30-b9e6-744004e894cb",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "47a3ce5c-b182-4f57-94f6-7e72ad89491e",
"EffectiveDate": "2025-11-29T09:50:34.8585562-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "dcefbc77-ec57-4013-a024-08dccd98491d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e7a5570c-5b07-467b-b29d-d85692df3bf8",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6fb5857d-931c-4de7-9674-ac35bac9ab63",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-29T09:50:34.8585562-08:00",
"MeasurementValueNeededDate": "2025-11-29T09:50:34.8585562-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b8418a23-0518-4e32-9701-aedf3e68c1c9",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "3d69d98e-1581-49bb-82b2-dd253c9de1f9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9edbab4b-d160-41cc-8589-a642137e3994",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d0f554f3-e42b-4daf-822e-b37b93c0a8fe",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-29T09:50:34.8585562-08:00",
"Fields": [
{
"FormTypeFieldId": "32251166-9a80-454c-b4ca-1cd8d5b22b6e",
"Section": {
"FormTypeSectionId": "a48127f9-f9c2-4afe-8a84-5733e6947278",
"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": "4ac379e7-5a02-4e32-8e72-727d6643519f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "66ee1a62-4fd0-42c6-bc47-387505627814",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1f6367d6-e3d0-4e77-aa3a-631050c6cbcd",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6a40ae46-d466-4cef-8b17-f03f96e6ddbf",
"FieldId": "e4c4d5e2-0f0f-434e-9beb-bcd1c55b8641",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6a40ae46-d466-4cef-8b17-f03f96e6ddbf",
"FieldId": "e4c4d5e2-0f0f-434e-9beb-bcd1c55b8641",
"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": "32251166-9a80-454c-b4ca-1cd8d5b22b6e",
"Section": {
"FormTypeSectionId": "a48127f9-f9c2-4afe-8a84-5733e6947278",
"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": "4ac379e7-5a02-4e32-8e72-727d6643519f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "66ee1a62-4fd0-42c6-bc47-387505627814",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1f6367d6-e3d0-4e77-aa3a-631050c6cbcd",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6a40ae46-d466-4cef-8b17-f03f96e6ddbf",
"FieldId": "e4c4d5e2-0f0f-434e-9beb-bcd1c55b8641",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6a40ae46-d466-4cef-8b17-f03f96e6ddbf",
"FieldId": "e4c4d5e2-0f0f-434e-9beb-bcd1c55b8641",
"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": "52606692-d434-448a-8b2e-b1099969129f",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2025-11-29T09:50:34.8585562-08:00",
"Location": "sample string 1",
"TaskId": "d7746671-7ed4-4251-89f2-3eb974f54504",
"Values": [
{
"FormFieldValueId": "73077e59-a7c0-4aff-afef-a89882754592",
"FormId": "ef758a73-ce6a-4bc1-9ee3-6fa19e761c6b",
"FormTypeField": {
"FormTypeFieldId": "32251166-9a80-454c-b4ca-1cd8d5b22b6e",
"FormType": {
"FormTypeId": "3d69d98e-1581-49bb-82b2-dd253c9de1f9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9edbab4b-d160-41cc-8589-a642137e3994",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d0f554f3-e42b-4daf-822e-b37b93c0a8fe",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-29T09:50:34.8585562-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "52606692-d434-448a-8b2e-b1099969129f",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "a48127f9-f9c2-4afe-8a84-5733e6947278",
"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": "4ac379e7-5a02-4e32-8e72-727d6643519f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "66ee1a62-4fd0-42c6-bc47-387505627814",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1f6367d6-e3d0-4e77-aa3a-631050c6cbcd",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6a40ae46-d466-4cef-8b17-f03f96e6ddbf",
"FieldId": "e4c4d5e2-0f0f-434e-9beb-bcd1c55b8641",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6a40ae46-d466-4cef-8b17-f03f96e6ddbf",
"FieldId": "e4c4d5e2-0f0f-434e-9beb-bcd1c55b8641",
"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": "73077e59-a7c0-4aff-afef-a89882754592",
"FormId": "ef758a73-ce6a-4bc1-9ee3-6fa19e761c6b",
"FormTypeField": {
"FormTypeFieldId": "32251166-9a80-454c-b4ca-1cd8d5b22b6e",
"FormType": {
"FormTypeId": "3d69d98e-1581-49bb-82b2-dd253c9de1f9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9edbab4b-d160-41cc-8589-a642137e3994",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d0f554f3-e42b-4daf-822e-b37b93c0a8fe",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-29T09:50:34.8585562-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "52606692-d434-448a-8b2e-b1099969129f",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "a48127f9-f9c2-4afe-8a84-5733e6947278",
"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": "4ac379e7-5a02-4e32-8e72-727d6643519f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "66ee1a62-4fd0-42c6-bc47-387505627814",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1f6367d6-e3d0-4e77-aa3a-631050c6cbcd",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6a40ae46-d466-4cef-8b17-f03f96e6ddbf",
"FieldId": "e4c4d5e2-0f0f-434e-9beb-bcd1c55b8641",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6a40ae46-d466-4cef-8b17-f03f96e6ddbf",
"FieldId": "e4c4d5e2-0f0f-434e-9beb-bcd1c55b8641",
"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": "03e3f81f-5938-4ed5-8d27-8c8ceaf2bf72",
"CreateDate": "2025-11-29T09:50:34.8585562-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-29T09:50:34.8585562-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}