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": "c30ab99b-5761-417d-8bbb-76e66c4f2e26",
"Asset": {
"AssetId": "3b2005bb-771a-40b5-b043-d1fb870919ed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6a067c31-166f-4386-a750-35d177e2a524",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d6691b75-767d-479e-ad1e-2d3e6328f559",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "00f74d3e-e63c-4ab7-adfa-7ba02bd3aac0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-19T14:15:21.8267768-07:00",
"MeasurementValueNeededDate": "2026-06-19T14:15:21.8267768-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "eef19f24-0bb3-4f10-8336-8be84755d625",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1a05a105-cc3d-4cae-a88f-a0b42a9ef993",
"EffectiveDate": "2026-06-19T14:15:21.8267768-07:00",
"StateType": {
"StateTypeId": "acf2f70a-3775-46a4-8dd8-eff2a35b000b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "6a067c31-166f-4386-a750-35d177e2a524",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d6691b75-767d-479e-ad1e-2d3e6328f559",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "a3c5e6b1-597d-40b6-99ab-956fa7dbf50b",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "99b5968d-c2b1-49fc-b5cd-c8f9a2e82a07",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "16532857-8039-4e9f-bef1-fd0fd56fd19b",
"EffectiveDate": "2026-06-19T14:15:21.8267768-07:00",
"StatusType": {
"StatusTypeId": "e7275e07-1037-4621-932a-9f905482c1ba",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "6a067c31-166f-4386-a750-35d177e2a524",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d6691b75-767d-479e-ad1e-2d3e6328f559",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "710c5f28-6bce-4e5c-ba89-21eee9a75c71",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "aeedddf2-51bf-4469-88a6-c5837a67e004",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4ba998c4-aed2-497c-8170-73112cf84dfc",
"EffectiveDate": "2026-06-19T14:15:21.8267768-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "278d2d3c-a9a1-4105-b918-cea45e47f195",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "604d5cde-88cf-4045-bde7-3fa951d1d2a7",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "febec63f-a29b-4979-9ec2-43f128df1371",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-19T14:15:21.8267768-07:00",
"MeasurementValueNeededDate": "2026-06-19T14:15:21.8267768-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6610e6ef-4084-424e-badb-2635791fcb16",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "4d379b2a-4a51-4047-b4b6-51787f61d6fb",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6a067c31-166f-4386-a750-35d177e2a524",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d6691b75-767d-479e-ad1e-2d3e6328f559",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-19T14:15:21.8267768-07:00",
"Fields": [
{
"FormTypeFieldId": "9e1529e4-19c3-44d1-9cf1-3872490772f9",
"Section": {
"FormTypeSectionId": "d01cc9fe-58bd-4bac-b6ec-15207cd95caf",
"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": "819611ea-9d96-41a2-a205-06af1ca10ebe",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1cb9bab2-b996-4f03-9c86-975f5c94097c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dc09ec35-b445-45bc-8dc5-4f24c73371af",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a3a14308-c2a3-4ea2-bf0f-790450db04c4",
"FieldId": "093d5bb0-d058-4307-a5e7-ce1b5fc69c0f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a3a14308-c2a3-4ea2-bf0f-790450db04c4",
"FieldId": "093d5bb0-d058-4307-a5e7-ce1b5fc69c0f",
"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": "9e1529e4-19c3-44d1-9cf1-3872490772f9",
"Section": {
"FormTypeSectionId": "d01cc9fe-58bd-4bac-b6ec-15207cd95caf",
"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": "819611ea-9d96-41a2-a205-06af1ca10ebe",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1cb9bab2-b996-4f03-9c86-975f5c94097c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dc09ec35-b445-45bc-8dc5-4f24c73371af",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a3a14308-c2a3-4ea2-bf0f-790450db04c4",
"FieldId": "093d5bb0-d058-4307-a5e7-ce1b5fc69c0f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a3a14308-c2a3-4ea2-bf0f-790450db04c4",
"FieldId": "093d5bb0-d058-4307-a5e7-ce1b5fc69c0f",
"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": "9db71794-06c7-4f10-8c87-a7f972fba0f8",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-06-19T14:15:21.8267768-07:00",
"Location": "sample string 1",
"TaskId": "4fbbe4d2-df4f-466d-8366-238ef5df5b63",
"Values": [
{
"FormFieldValueId": "b7fba7c6-7d84-4aa4-a650-153cc528b422",
"FormId": "24a34291-a6bf-4f34-b807-8a2b7293117f",
"FormTypeField": {
"FormTypeFieldId": "9e1529e4-19c3-44d1-9cf1-3872490772f9",
"FormType": {
"FormTypeId": "4d379b2a-4a51-4047-b4b6-51787f61d6fb",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6a067c31-166f-4386-a750-35d177e2a524",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d6691b75-767d-479e-ad1e-2d3e6328f559",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-19T14:15:21.8267768-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "9db71794-06c7-4f10-8c87-a7f972fba0f8",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "d01cc9fe-58bd-4bac-b6ec-15207cd95caf",
"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": "819611ea-9d96-41a2-a205-06af1ca10ebe",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1cb9bab2-b996-4f03-9c86-975f5c94097c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dc09ec35-b445-45bc-8dc5-4f24c73371af",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a3a14308-c2a3-4ea2-bf0f-790450db04c4",
"FieldId": "093d5bb0-d058-4307-a5e7-ce1b5fc69c0f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a3a14308-c2a3-4ea2-bf0f-790450db04c4",
"FieldId": "093d5bb0-d058-4307-a5e7-ce1b5fc69c0f",
"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": "b7fba7c6-7d84-4aa4-a650-153cc528b422",
"FormId": "24a34291-a6bf-4f34-b807-8a2b7293117f",
"FormTypeField": {
"FormTypeFieldId": "9e1529e4-19c3-44d1-9cf1-3872490772f9",
"FormType": {
"FormTypeId": "4d379b2a-4a51-4047-b4b6-51787f61d6fb",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6a067c31-166f-4386-a750-35d177e2a524",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d6691b75-767d-479e-ad1e-2d3e6328f559",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-19T14:15:21.8267768-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "9db71794-06c7-4f10-8c87-a7f972fba0f8",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "d01cc9fe-58bd-4bac-b6ec-15207cd95caf",
"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": "819611ea-9d96-41a2-a205-06af1ca10ebe",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1cb9bab2-b996-4f03-9c86-975f5c94097c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dc09ec35-b445-45bc-8dc5-4f24c73371af",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a3a14308-c2a3-4ea2-bf0f-790450db04c4",
"FieldId": "093d5bb0-d058-4307-a5e7-ce1b5fc69c0f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a3a14308-c2a3-4ea2-bf0f-790450db04c4",
"FieldId": "093d5bb0-d058-4307-a5e7-ce1b5fc69c0f",
"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": "0f052943-3252-4b41-b3ac-8e8e8e9a59f3",
"CreateDate": "2026-06-19T14:15:21.8267768-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-19T14:15:21.8267768-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}