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": "4b752e96-f427-4a38-9047-5df3425fb949",
"Asset": {
"AssetId": "2e79b4b2-fa28-43fd-8fd8-4ab3227b4d14",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a2c5c088-1078-4a39-9bf1-f7661ba8ceb0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3db6728f-95db-4b3e-bb7d-3bf595c1e133",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7e4e1fdc-d35d-4419-ae11-8ad00e9e4494",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-16T02:58:35.4063225-07:00",
"MeasurementValueNeededDate": "2026-05-16T02:58:35.4063225-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9c455f15-84d0-4e33-90e6-a01bd3df8efd",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3e144c9a-4849-4886-b029-070fb2748f89",
"EffectiveDate": "2026-05-16T02:58:35.4063225-07:00",
"StateType": {
"StateTypeId": "8f666370-21dc-405c-877e-820ad9891cc5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a2c5c088-1078-4a39-9bf1-f7661ba8ceb0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3db6728f-95db-4b3e-bb7d-3bf595c1e133",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "856c2313-5183-41ac-9616-4faa0c508212",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ade80a17-650b-470d-9eeb-7447fbc80423",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b8bc4035-85b8-4454-a54d-ce507a218cc1",
"EffectiveDate": "2026-05-16T02:58:35.4063225-07:00",
"StatusType": {
"StatusTypeId": "c5914d60-5eff-4ed8-b8a3-09728eca448c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a2c5c088-1078-4a39-9bf1-f7661ba8ceb0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3db6728f-95db-4b3e-bb7d-3bf595c1e133",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f57d2126-f754-4318-a82e-4b88b30d40b8",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1ac334a5-3ad2-469b-b097-6cbde0023cbc",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "36f12b64-bf79-476f-89b1-51bbc7538cc0",
"EffectiveDate": "2026-05-16T02:58:35.4063225-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b1dd1120-b178-43a5-9cf5-801522b70fbf",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3ebc5d5c-b5de-4517-97df-4e153d283577",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c5d02875-84ed-4c92-ba2a-fde18b089399",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-16T02:58:35.4063225-07:00",
"MeasurementValueNeededDate": "2026-05-16T02:58:35.4063225-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "df16c887-ce50-454c-a8a2-464ebc7a2f53",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "479a8e47-fd64-49c3-a336-f59d56c2db2f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a2c5c088-1078-4a39-9bf1-f7661ba8ceb0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3db6728f-95db-4b3e-bb7d-3bf595c1e133",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-16T02:58:35.4063225-07:00",
"Fields": [
{
"FormTypeFieldId": "6781a007-490c-4a5b-ae8a-2d08df59f899",
"Section": {
"FormTypeSectionId": "6930102a-a214-4f10-9297-a3733e899a0b",
"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": "9dd8a663-86ee-4601-b92e-624c4818edc7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0687715c-5d15-476e-8dbb-f15896e451f8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9527b172-b41f-490f-8bde-c7daa8bc424d",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e17bb72d-c0b2-4718-a719-c8b044ec5907",
"FieldId": "94f6e3e1-4e4e-4ee4-a562-da63a620dbce",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e17bb72d-c0b2-4718-a719-c8b044ec5907",
"FieldId": "94f6e3e1-4e4e-4ee4-a562-da63a620dbce",
"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": "6781a007-490c-4a5b-ae8a-2d08df59f899",
"Section": {
"FormTypeSectionId": "6930102a-a214-4f10-9297-a3733e899a0b",
"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": "9dd8a663-86ee-4601-b92e-624c4818edc7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0687715c-5d15-476e-8dbb-f15896e451f8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9527b172-b41f-490f-8bde-c7daa8bc424d",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e17bb72d-c0b2-4718-a719-c8b044ec5907",
"FieldId": "94f6e3e1-4e4e-4ee4-a562-da63a620dbce",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e17bb72d-c0b2-4718-a719-c8b044ec5907",
"FieldId": "94f6e3e1-4e4e-4ee4-a562-da63a620dbce",
"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": "97f96163-28ad-4868-aa19-cfcd823e566f",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-05-16T02:58:35.4063225-07:00",
"Location": "sample string 1",
"TaskId": "c28df520-055b-4de0-a7c6-b0dc83513050",
"Values": [
{
"FormFieldValueId": "20db65c2-0ad6-4193-a92f-6769597fb1a5",
"FormId": "96bdd913-6c81-4790-a35f-400323af5516",
"FormTypeField": {
"FormTypeFieldId": "6781a007-490c-4a5b-ae8a-2d08df59f899",
"FormType": {
"FormTypeId": "479a8e47-fd64-49c3-a336-f59d56c2db2f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a2c5c088-1078-4a39-9bf1-f7661ba8ceb0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3db6728f-95db-4b3e-bb7d-3bf595c1e133",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-16T02:58:35.4063225-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "97f96163-28ad-4868-aa19-cfcd823e566f",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "6930102a-a214-4f10-9297-a3733e899a0b",
"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": "9dd8a663-86ee-4601-b92e-624c4818edc7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0687715c-5d15-476e-8dbb-f15896e451f8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9527b172-b41f-490f-8bde-c7daa8bc424d",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e17bb72d-c0b2-4718-a719-c8b044ec5907",
"FieldId": "94f6e3e1-4e4e-4ee4-a562-da63a620dbce",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e17bb72d-c0b2-4718-a719-c8b044ec5907",
"FieldId": "94f6e3e1-4e4e-4ee4-a562-da63a620dbce",
"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": "20db65c2-0ad6-4193-a92f-6769597fb1a5",
"FormId": "96bdd913-6c81-4790-a35f-400323af5516",
"FormTypeField": {
"FormTypeFieldId": "6781a007-490c-4a5b-ae8a-2d08df59f899",
"FormType": {
"FormTypeId": "479a8e47-fd64-49c3-a336-f59d56c2db2f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a2c5c088-1078-4a39-9bf1-f7661ba8ceb0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3db6728f-95db-4b3e-bb7d-3bf595c1e133",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-16T02:58:35.4063225-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "97f96163-28ad-4868-aa19-cfcd823e566f",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "6930102a-a214-4f10-9297-a3733e899a0b",
"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": "9dd8a663-86ee-4601-b92e-624c4818edc7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0687715c-5d15-476e-8dbb-f15896e451f8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9527b172-b41f-490f-8bde-c7daa8bc424d",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e17bb72d-c0b2-4718-a719-c8b044ec5907",
"FieldId": "94f6e3e1-4e4e-4ee4-a562-da63a620dbce",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e17bb72d-c0b2-4718-a719-c8b044ec5907",
"FieldId": "94f6e3e1-4e4e-4ee4-a562-da63a620dbce",
"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": "f2d65d5f-f967-4eb8-9d16-9a5abee9cc0e",
"CreateDate": "2026-05-16T02:58:35.4063225-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-16T02:58:35.4063225-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}