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": "b2c2fbbc-0b67-4f2a-8415-c3c34dc2d17e",
"Asset": {
"AssetId": "ede99f19-9b2a-4a74-ba53-e834e2790b5a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "29f10004-ac51-426b-aaa9-9307f59be23e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "88f5bdd1-04b2-4f50-a84e-443a9b6ecd4e",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "86be21da-5eb6-40ee-9aca-04c3f2c9747b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-17T22:33:58.7525434-07:00",
"MeasurementValueNeededDate": "2026-10-17T22:33:58.7525434-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3fe28402-32e3-424a-993b-5f7178190f2e",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1849bcac-5150-472c-a47a-6925b2b0abbc",
"EffectiveDate": "2026-10-17T22:33:58.7525434-07:00",
"StateType": {
"StateTypeId": "72df4181-445d-4690-b1df-efe3b24dea5d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "29f10004-ac51-426b-aaa9-9307f59be23e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "88f5bdd1-04b2-4f50-a84e-443a9b6ecd4e",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ea643a93-59fd-4ac7-ab49-ee47ef042a3d",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "58ddafcd-014a-478c-ae4e-fbccbbda6841",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "341f4a93-a76f-46a6-b0c1-6970713f8bfc",
"EffectiveDate": "2026-10-17T22:33:58.7525434-07:00",
"StatusType": {
"StatusTypeId": "303f3348-77c2-4f62-b1db-85cd1bec77ee",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "29f10004-ac51-426b-aaa9-9307f59be23e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "88f5bdd1-04b2-4f50-a84e-443a9b6ecd4e",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "9248c50f-9a0e-4df8-9f98-45a54cd90cce",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "44f52e13-7e18-41d0-9839-1f8549d6d558",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "565c68ea-66da-4a1d-a3b5-e61bbd815026",
"EffectiveDate": "2026-10-17T22:33:58.7525434-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f5a3a352-9a03-48db-b878-f879de8f9d4c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c9270c99-5199-4da4-bc04-7f426f9e8726",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3b66149f-daa7-4b6b-adf9-5361cb0b51f4",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-17T22:33:58.7525434-07:00",
"MeasurementValueNeededDate": "2026-10-17T22:33:58.7525434-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6065c5f7-3ab3-406c-883f-a121c475d506",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "70a68d39-c5e5-4df7-81b3-098eae1d0a73",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "29f10004-ac51-426b-aaa9-9307f59be23e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "88f5bdd1-04b2-4f50-a84e-443a9b6ecd4e",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-17T22:33:58.7525434-07:00",
"Fields": [
{
"FormTypeFieldId": "3f6be058-ab40-4da0-9d94-62a5aa1b0dfe",
"Section": {
"FormTypeSectionId": "bc90ca80-5583-445a-9f5b-acd3ce0ac2f4",
"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": "b9d93756-ff16-474c-bef0-5e585ad4d048",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "496ce7aa-6167-4ecf-8c37-c2653aa3e108",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fab61cc6-c8ce-488b-ad8c-a7393ecf7c72",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "12d9a371-be97-4ef4-bab7-2dd3c715a179",
"FieldId": "61d7c7d1-f300-4975-9030-a30475b9aefa",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "12d9a371-be97-4ef4-bab7-2dd3c715a179",
"FieldId": "61d7c7d1-f300-4975-9030-a30475b9aefa",
"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": "3f6be058-ab40-4da0-9d94-62a5aa1b0dfe",
"Section": {
"FormTypeSectionId": "bc90ca80-5583-445a-9f5b-acd3ce0ac2f4",
"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": "b9d93756-ff16-474c-bef0-5e585ad4d048",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "496ce7aa-6167-4ecf-8c37-c2653aa3e108",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fab61cc6-c8ce-488b-ad8c-a7393ecf7c72",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "12d9a371-be97-4ef4-bab7-2dd3c715a179",
"FieldId": "61d7c7d1-f300-4975-9030-a30475b9aefa",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "12d9a371-be97-4ef4-bab7-2dd3c715a179",
"FieldId": "61d7c7d1-f300-4975-9030-a30475b9aefa",
"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": "4b6c09c6-8b6d-47d5-8e77-253c2bfe8951",
"CreateDate": "2026-10-17T22:33:58.7681497-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-17T22:33:58.7681497-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-10-17T22:33:58.7681497-07:00",
"Location": "sample string 1",
"TaskId": "5e5cba63-30e9-45be-b0ae-468a7dd2f1cc",
"Values": [
{
"FormFieldValueId": "a73a73a6-05e1-4720-8e97-2dbb4f6ebe75",
"FormId": "6efe8560-3297-46f4-a5c8-ccc3c0bb7674",
"FormTypeField": {
"FormTypeFieldId": "3f6be058-ab40-4da0-9d94-62a5aa1b0dfe",
"FormType": {
"FormTypeId": "70a68d39-c5e5-4df7-81b3-098eae1d0a73",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "29f10004-ac51-426b-aaa9-9307f59be23e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "88f5bdd1-04b2-4f50-a84e-443a9b6ecd4e",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-17T22:33:58.7525434-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "4b6c09c6-8b6d-47d5-8e77-253c2bfe8951",
"CreateDate": "2026-10-17T22:33:58.7681497-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-17T22:33:58.7681497-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "bc90ca80-5583-445a-9f5b-acd3ce0ac2f4",
"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": "b9d93756-ff16-474c-bef0-5e585ad4d048",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "496ce7aa-6167-4ecf-8c37-c2653aa3e108",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fab61cc6-c8ce-488b-ad8c-a7393ecf7c72",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "12d9a371-be97-4ef4-bab7-2dd3c715a179",
"FieldId": "61d7c7d1-f300-4975-9030-a30475b9aefa",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "12d9a371-be97-4ef4-bab7-2dd3c715a179",
"FieldId": "61d7c7d1-f300-4975-9030-a30475b9aefa",
"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": "a73a73a6-05e1-4720-8e97-2dbb4f6ebe75",
"FormId": "6efe8560-3297-46f4-a5c8-ccc3c0bb7674",
"FormTypeField": {
"FormTypeFieldId": "3f6be058-ab40-4da0-9d94-62a5aa1b0dfe",
"FormType": {
"FormTypeId": "70a68d39-c5e5-4df7-81b3-098eae1d0a73",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "29f10004-ac51-426b-aaa9-9307f59be23e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "88f5bdd1-04b2-4f50-a84e-443a9b6ecd4e",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-17T22:33:58.7525434-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "4b6c09c6-8b6d-47d5-8e77-253c2bfe8951",
"CreateDate": "2026-10-17T22:33:58.7681497-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-17T22:33:58.7681497-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "bc90ca80-5583-445a-9f5b-acd3ce0ac2f4",
"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": "b9d93756-ff16-474c-bef0-5e585ad4d048",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "496ce7aa-6167-4ecf-8c37-c2653aa3e108",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fab61cc6-c8ce-488b-ad8c-a7393ecf7c72",
"CreateDate": "2026-10-17T22:33:58.7525434-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-17T22:33:58.7525434-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "12d9a371-be97-4ef4-bab7-2dd3c715a179",
"FieldId": "61d7c7d1-f300-4975-9030-a30475b9aefa",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "12d9a371-be97-4ef4-bab7-2dd3c715a179",
"FieldId": "61d7c7d1-f300-4975-9030-a30475b9aefa",
"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": "2018deb2-0cf2-4e22-8df5-9e88d1307c96",
"CreateDate": "2026-10-17T22:33:58.7681497-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-17T22:33:58.7681497-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}