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": "17049f72-5648-4500-9b3f-afaeb8792b2c",
"Asset": {
"AssetId": "6b2bfdd2-c04c-40e8-8aa3-74573c241b01",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6a97d837-96fe-47b7-b66f-3461908d026e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "14083b69-447e-4bad-afea-72f05d3cb5ad",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0f1393b9-a014-48b9-ae91-955b66d2fee6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-29T13:51:47.5115786-07:00",
"MeasurementValueNeededDate": "2026-08-29T13:51:47.5115786-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "00a86ce6-e64b-47a4-b4fa-50f9daae60c4",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "15de826e-c052-4f19-bcef-84453d9962d9",
"EffectiveDate": "2026-08-29T13:51:47.5115786-07:00",
"StateType": {
"StateTypeId": "e0fd15d6-a509-40bb-a7de-2516a05e1970",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "6a97d837-96fe-47b7-b66f-3461908d026e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "14083b69-447e-4bad-afea-72f05d3cb5ad",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "3586d0ee-ad46-4032-a661-7499eb2ab72d",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "87c9bd39-4648-42a8-907b-c11d42e5f0e4",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "3921f34a-b888-4054-9322-1cea20f8d5b4",
"EffectiveDate": "2026-08-29T13:51:47.5115786-07:00",
"StatusType": {
"StatusTypeId": "fa68a8a1-64a2-4fbc-8c3f-700a353c722c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "6a97d837-96fe-47b7-b66f-3461908d026e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "14083b69-447e-4bad-afea-72f05d3cb5ad",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "592cc1c1-2e2a-4dc7-87a8-df01af7aad91",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8ac73262-440b-4495-9766-30c59dd1f606",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9e1a3230-ea91-4cb2-af9a-cb5fdbfdd30c",
"EffectiveDate": "2026-08-29T13:51:47.5115786-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "cec4f9a7-f251-44ca-bbd3-f1d96c0c4c84",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1aac038e-7eed-46ff-a5b7-917be1975f71",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c8313442-b0e5-47e7-af22-f83ce9798cf5",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-29T13:51:47.5115786-07:00",
"MeasurementValueNeededDate": "2026-08-29T13:51:47.5115786-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "966b749b-5179-4356-8cd7-25eb37824332",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "105e41d7-f827-4620-b9df-8966863e8757",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6a97d837-96fe-47b7-b66f-3461908d026e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "14083b69-447e-4bad-afea-72f05d3cb5ad",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-29T13:51:47.5115786-07:00",
"Fields": [
{
"FormTypeFieldId": "a5a86ac5-57ba-4c2c-a747-eaec0dcba816",
"Section": {
"FormTypeSectionId": "dc534d01-36a5-4369-a568-dac2ae156ef3",
"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": "31aa3993-0f9e-4f93-a18b-d4fd59122ab1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3adbab8c-c6a1-467d-82d9-9077bb318027",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "38969d90-221d-4c49-a2bc-5bc994800e97",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6777de92-b107-4db3-8844-e7cf451bfce7",
"FieldId": "346768b3-d300-4568-a7ad-04e3d3f517e5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6777de92-b107-4db3-8844-e7cf451bfce7",
"FieldId": "346768b3-d300-4568-a7ad-04e3d3f517e5",
"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": "a5a86ac5-57ba-4c2c-a747-eaec0dcba816",
"Section": {
"FormTypeSectionId": "dc534d01-36a5-4369-a568-dac2ae156ef3",
"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": "31aa3993-0f9e-4f93-a18b-d4fd59122ab1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3adbab8c-c6a1-467d-82d9-9077bb318027",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "38969d90-221d-4c49-a2bc-5bc994800e97",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6777de92-b107-4db3-8844-e7cf451bfce7",
"FieldId": "346768b3-d300-4568-a7ad-04e3d3f517e5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6777de92-b107-4db3-8844-e7cf451bfce7",
"FieldId": "346768b3-d300-4568-a7ad-04e3d3f517e5",
"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": "7210904f-4b07-4648-9c0b-f16e6f76e190",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-08-29T13:51:47.5115786-07:00",
"Location": "sample string 1",
"TaskId": "595e7a39-1e0e-427f-9642-3dda559a512c",
"Values": [
{
"FormFieldValueId": "cd28048c-5b3b-4dee-8ee3-3b6eca0099c7",
"FormId": "603b6fb1-af01-42c7-8b0a-25b50d261ef5",
"FormTypeField": {
"FormTypeFieldId": "a5a86ac5-57ba-4c2c-a747-eaec0dcba816",
"FormType": {
"FormTypeId": "105e41d7-f827-4620-b9df-8966863e8757",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6a97d837-96fe-47b7-b66f-3461908d026e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "14083b69-447e-4bad-afea-72f05d3cb5ad",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-29T13:51:47.5115786-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "7210904f-4b07-4648-9c0b-f16e6f76e190",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "dc534d01-36a5-4369-a568-dac2ae156ef3",
"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": "31aa3993-0f9e-4f93-a18b-d4fd59122ab1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3adbab8c-c6a1-467d-82d9-9077bb318027",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "38969d90-221d-4c49-a2bc-5bc994800e97",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6777de92-b107-4db3-8844-e7cf451bfce7",
"FieldId": "346768b3-d300-4568-a7ad-04e3d3f517e5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6777de92-b107-4db3-8844-e7cf451bfce7",
"FieldId": "346768b3-d300-4568-a7ad-04e3d3f517e5",
"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": "cd28048c-5b3b-4dee-8ee3-3b6eca0099c7",
"FormId": "603b6fb1-af01-42c7-8b0a-25b50d261ef5",
"FormTypeField": {
"FormTypeFieldId": "a5a86ac5-57ba-4c2c-a747-eaec0dcba816",
"FormType": {
"FormTypeId": "105e41d7-f827-4620-b9df-8966863e8757",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6a97d837-96fe-47b7-b66f-3461908d026e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "14083b69-447e-4bad-afea-72f05d3cb5ad",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-29T13:51:47.5115786-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "7210904f-4b07-4648-9c0b-f16e6f76e190",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "dc534d01-36a5-4369-a568-dac2ae156ef3",
"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": "31aa3993-0f9e-4f93-a18b-d4fd59122ab1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3adbab8c-c6a1-467d-82d9-9077bb318027",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "38969d90-221d-4c49-a2bc-5bc994800e97",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6777de92-b107-4db3-8844-e7cf451bfce7",
"FieldId": "346768b3-d300-4568-a7ad-04e3d3f517e5",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6777de92-b107-4db3-8844-e7cf451bfce7",
"FieldId": "346768b3-d300-4568-a7ad-04e3d3f517e5",
"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": "1f6d1031-e7d4-488b-a4ac-bed5b2601452",
"CreateDate": "2026-08-29T13:51:47.5115786-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-29T13:51:47.5115786-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}