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": "6618473d-2cf9-4d25-881e-b73c87bab537",
"Asset": {
"AssetId": "7c62eab0-d337-48b1-899b-d53f48f6d653",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bfbba7fd-0d88-41fc-b78b-a610dba6c7d0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "deaf1d14-88e2-41c6-afdd-7fbba51818c7",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "72e9108f-3c56-4ab9-ab72-ddb0c32fccba",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-02T17:24:05.8603179-07:00",
"MeasurementValueNeededDate": "2026-04-02T17:24:05.8603179-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b7bddf6f-0d47-4e69-b78b-0f731480fcbc",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a9500214-8867-43cc-86e6-ed1cdf1343e7",
"EffectiveDate": "2026-04-02T17:24:05.8603179-07:00",
"StateType": {
"StateTypeId": "811d6d39-6616-4bd6-8c2a-c259f958083f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bfbba7fd-0d88-41fc-b78b-a610dba6c7d0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "deaf1d14-88e2-41c6-afdd-7fbba51818c7",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c21a4855-6c48-4a37-9ed4-cce6be302ef0",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "85b952bd-471e-4c0d-add6-939f68cade36",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "73364be7-a511-4ff2-9d82-772d108d6f74",
"EffectiveDate": "2026-04-02T17:24:05.8603179-07:00",
"StatusType": {
"StatusTypeId": "4eb3ed7b-cadc-4051-aaa2-8efd3adbef7b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bfbba7fd-0d88-41fc-b78b-a610dba6c7d0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "deaf1d14-88e2-41c6-afdd-7fbba51818c7",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b9380c85-dfb4-46d8-8f19-51220e13a25c",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1425b4f1-71d9-4360-acb9-992bcd956295",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4c209db1-0854-4b16-ac57-6235cbffd3c2",
"EffectiveDate": "2026-04-02T17:24:05.8603179-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "0515828c-1ec1-4ae7-b16d-578d0ead3516",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bdd5ea1f-eaed-4872-b80b-8395df1c8812",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9a2e1059-9818-4f9a-81f2-3e555fc07a4f",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-02T17:24:05.8603179-07:00",
"MeasurementValueNeededDate": "2026-04-02T17:24:05.8603179-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f9c3959b-b692-4464-a685-bdf06622c39a",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "95510bc6-e70d-4007-9f76-ae3130d6a1c4",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bfbba7fd-0d88-41fc-b78b-a610dba6c7d0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "deaf1d14-88e2-41c6-afdd-7fbba51818c7",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-02T17:24:05.8603179-07:00",
"Fields": [
{
"FormTypeFieldId": "32062db7-4bd6-41cb-aae8-005154fe2a74",
"Section": {
"FormTypeSectionId": "54477348-446b-46bd-ba61-3077bc1dd037",
"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": "c9c7402c-3ede-4375-bc22-6182733d44b1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b021a2be-50d2-4295-a98f-c0355d4ff64a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "eeeb1fb3-ae10-471e-8072-72e1996cf3eb",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e738d81f-9b19-41d4-be2d-cf5b69a3c3de",
"FieldId": "49845a7d-be6c-4477-a9f1-5ff2c8c101e8",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e738d81f-9b19-41d4-be2d-cf5b69a3c3de",
"FieldId": "49845a7d-be6c-4477-a9f1-5ff2c8c101e8",
"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": "32062db7-4bd6-41cb-aae8-005154fe2a74",
"Section": {
"FormTypeSectionId": "54477348-446b-46bd-ba61-3077bc1dd037",
"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": "c9c7402c-3ede-4375-bc22-6182733d44b1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b021a2be-50d2-4295-a98f-c0355d4ff64a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "eeeb1fb3-ae10-471e-8072-72e1996cf3eb",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e738d81f-9b19-41d4-be2d-cf5b69a3c3de",
"FieldId": "49845a7d-be6c-4477-a9f1-5ff2c8c101e8",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e738d81f-9b19-41d4-be2d-cf5b69a3c3de",
"FieldId": "49845a7d-be6c-4477-a9f1-5ff2c8c101e8",
"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": "181f7e3f-e3b6-4a3d-98d0-77d10c356ca8",
"CreateDate": "2026-04-02T17:24:05.8759007-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-02T17:24:05.8759007-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-04-02T17:24:05.8759007-07:00",
"Location": "sample string 1",
"TaskId": "2875d370-e8fe-4444-88e4-2f4513650787",
"Values": [
{
"FormFieldValueId": "da206fc7-88fd-4779-8f4c-5b785610bf63",
"FormId": "1cb283e7-87e3-47cb-8ba4-3a2143bb996b",
"FormTypeField": {
"FormTypeFieldId": "32062db7-4bd6-41cb-aae8-005154fe2a74",
"FormType": {
"FormTypeId": "95510bc6-e70d-4007-9f76-ae3130d6a1c4",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bfbba7fd-0d88-41fc-b78b-a610dba6c7d0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "deaf1d14-88e2-41c6-afdd-7fbba51818c7",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-02T17:24:05.8603179-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "181f7e3f-e3b6-4a3d-98d0-77d10c356ca8",
"CreateDate": "2026-04-02T17:24:05.8759007-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-02T17:24:05.8759007-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "54477348-446b-46bd-ba61-3077bc1dd037",
"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": "c9c7402c-3ede-4375-bc22-6182733d44b1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b021a2be-50d2-4295-a98f-c0355d4ff64a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "eeeb1fb3-ae10-471e-8072-72e1996cf3eb",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e738d81f-9b19-41d4-be2d-cf5b69a3c3de",
"FieldId": "49845a7d-be6c-4477-a9f1-5ff2c8c101e8",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e738d81f-9b19-41d4-be2d-cf5b69a3c3de",
"FieldId": "49845a7d-be6c-4477-a9f1-5ff2c8c101e8",
"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": "da206fc7-88fd-4779-8f4c-5b785610bf63",
"FormId": "1cb283e7-87e3-47cb-8ba4-3a2143bb996b",
"FormTypeField": {
"FormTypeFieldId": "32062db7-4bd6-41cb-aae8-005154fe2a74",
"FormType": {
"FormTypeId": "95510bc6-e70d-4007-9f76-ae3130d6a1c4",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bfbba7fd-0d88-41fc-b78b-a610dba6c7d0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "deaf1d14-88e2-41c6-afdd-7fbba51818c7",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-02T17:24:05.8603179-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "181f7e3f-e3b6-4a3d-98d0-77d10c356ca8",
"CreateDate": "2026-04-02T17:24:05.8759007-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-02T17:24:05.8759007-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "54477348-446b-46bd-ba61-3077bc1dd037",
"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": "c9c7402c-3ede-4375-bc22-6182733d44b1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b021a2be-50d2-4295-a98f-c0355d4ff64a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "eeeb1fb3-ae10-471e-8072-72e1996cf3eb",
"CreateDate": "2026-04-02T17:24:05.8603179-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-02T17:24:05.8603179-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e738d81f-9b19-41d4-be2d-cf5b69a3c3de",
"FieldId": "49845a7d-be6c-4477-a9f1-5ff2c8c101e8",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e738d81f-9b19-41d4-be2d-cf5b69a3c3de",
"FieldId": "49845a7d-be6c-4477-a9f1-5ff2c8c101e8",
"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": "fd165c8a-54ad-4980-9df6-e330f75a39e9",
"CreateDate": "2026-04-02T17:24:05.8759007-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-02T17:24:05.8759007-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}