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": "003860f0-b955-46db-accd-7756c7c605dd",
"Asset": {
"AssetId": "6c8324c5-f2d8-45ba-b435-08269a36feab",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8c69350a-7ecf-46c0-98df-309194341ff4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1b506ced-f18b-4683-b317-71d86a42838b",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "6859cbab-8cd1-4323-b8d4-20a2341bcfe6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-27T08:10:47.0240462-07:00",
"MeasurementValueNeededDate": "2026-06-27T08:10:47.0240462-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1509ae09-45de-44d7-bf3b-f6a615f10ccd",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "91fc63f5-e889-427d-8b47-19d41ce4fd5f",
"EffectiveDate": "2026-06-27T08:10:47.0240462-07:00",
"StateType": {
"StateTypeId": "5cdaf282-8cc1-40bb-8899-19762fb2b2f1",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8c69350a-7ecf-46c0-98df-309194341ff4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1b506ced-f18b-4683-b317-71d86a42838b",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "027ad6ab-8d03-4b63-b50f-446c370b667b",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1ee326c7-15c6-49f2-9dfd-80aa21aa7ecb",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d01bdf58-c2db-4d86-b969-4f81efd0199f",
"EffectiveDate": "2026-06-27T08:10:47.0240462-07:00",
"StatusType": {
"StatusTypeId": "1d068467-6a26-4601-8e1b-bf743752cd06",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8c69350a-7ecf-46c0-98df-309194341ff4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1b506ced-f18b-4683-b317-71d86a42838b",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3cc61e47-4005-4da7-b5f1-e4b10ca748ea",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3ff7b598-d9d1-49b4-a3e8-b69670889ebb",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "34616db6-5f10-44e5-868f-c5bcd101e462",
"EffectiveDate": "2026-06-27T08:10:47.0240462-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e8f426d1-15b3-40aa-95b4-f79377b0e0f3",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bcc6d34e-9d4c-4487-9c6e-9774e4e6ce1f",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4ab1d1b0-f6f2-4835-96a5-3bb4f0f71678",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-27T08:10:47.0240462-07:00",
"MeasurementValueNeededDate": "2026-06-27T08:10:47.0240462-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2212ea2f-bfcf-491f-8141-c7bde783ec18",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "c9570107-ad5e-412a-a981-9df50ba01131",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8c69350a-7ecf-46c0-98df-309194341ff4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1b506ced-f18b-4683-b317-71d86a42838b",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-27T08:10:47.0240462-07:00",
"Fields": [
{
"FormTypeFieldId": "c14d6abd-2609-4439-b9f4-30a53bf1a8c3",
"Section": {
"FormTypeSectionId": "39f0b47b-7afa-42a3-92a4-6e612d4682fa",
"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": "844e3a1d-03e5-4b7a-b721-d97dcb8ed8ee",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b26eeffe-a7d4-4902-82db-8bb12a4728da",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7497f761-1af8-4198-bfd4-93a83c07febc",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8c8c0907-0630-44fe-82d0-122a5bee0f9c",
"FieldId": "6a606d1f-7330-4dc3-86dd-c8c4388dba17",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8c8c0907-0630-44fe-82d0-122a5bee0f9c",
"FieldId": "6a606d1f-7330-4dc3-86dd-c8c4388dba17",
"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": "c14d6abd-2609-4439-b9f4-30a53bf1a8c3",
"Section": {
"FormTypeSectionId": "39f0b47b-7afa-42a3-92a4-6e612d4682fa",
"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": "844e3a1d-03e5-4b7a-b721-d97dcb8ed8ee",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b26eeffe-a7d4-4902-82db-8bb12a4728da",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7497f761-1af8-4198-bfd4-93a83c07febc",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8c8c0907-0630-44fe-82d0-122a5bee0f9c",
"FieldId": "6a606d1f-7330-4dc3-86dd-c8c4388dba17",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8c8c0907-0630-44fe-82d0-122a5bee0f9c",
"FieldId": "6a606d1f-7330-4dc3-86dd-c8c4388dba17",
"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": "85885c57-7d6f-4a85-b473-ae47c5c3f812",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-06-27T08:10:47.0240462-07:00",
"Location": "sample string 1",
"TaskId": "c3d50f53-89a2-4590-ae12-d3a3ee8f05b2",
"Values": [
{
"FormFieldValueId": "98a021b3-6003-4aea-8b47-aa088762fd05",
"FormId": "72beb40d-1f21-4d2c-9a96-27c243ffb308",
"FormTypeField": {
"FormTypeFieldId": "c14d6abd-2609-4439-b9f4-30a53bf1a8c3",
"FormType": {
"FormTypeId": "c9570107-ad5e-412a-a981-9df50ba01131",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8c69350a-7ecf-46c0-98df-309194341ff4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1b506ced-f18b-4683-b317-71d86a42838b",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-27T08:10:47.0240462-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "85885c57-7d6f-4a85-b473-ae47c5c3f812",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "39f0b47b-7afa-42a3-92a4-6e612d4682fa",
"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": "844e3a1d-03e5-4b7a-b721-d97dcb8ed8ee",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b26eeffe-a7d4-4902-82db-8bb12a4728da",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7497f761-1af8-4198-bfd4-93a83c07febc",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8c8c0907-0630-44fe-82d0-122a5bee0f9c",
"FieldId": "6a606d1f-7330-4dc3-86dd-c8c4388dba17",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8c8c0907-0630-44fe-82d0-122a5bee0f9c",
"FieldId": "6a606d1f-7330-4dc3-86dd-c8c4388dba17",
"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": "98a021b3-6003-4aea-8b47-aa088762fd05",
"FormId": "72beb40d-1f21-4d2c-9a96-27c243ffb308",
"FormTypeField": {
"FormTypeFieldId": "c14d6abd-2609-4439-b9f4-30a53bf1a8c3",
"FormType": {
"FormTypeId": "c9570107-ad5e-412a-a981-9df50ba01131",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8c69350a-7ecf-46c0-98df-309194341ff4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1b506ced-f18b-4683-b317-71d86a42838b",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-27T08:10:47.0240462-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "85885c57-7d6f-4a85-b473-ae47c5c3f812",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "39f0b47b-7afa-42a3-92a4-6e612d4682fa",
"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": "844e3a1d-03e5-4b7a-b721-d97dcb8ed8ee",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b26eeffe-a7d4-4902-82db-8bb12a4728da",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7497f761-1af8-4198-bfd4-93a83c07febc",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8c8c0907-0630-44fe-82d0-122a5bee0f9c",
"FieldId": "6a606d1f-7330-4dc3-86dd-c8c4388dba17",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8c8c0907-0630-44fe-82d0-122a5bee0f9c",
"FieldId": "6a606d1f-7330-4dc3-86dd-c8c4388dba17",
"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": "9981c87d-5bf5-45c3-8ac0-bfd3af99a494",
"CreateDate": "2026-06-27T08:10:47.0240462-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-27T08:10:47.0240462-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}