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": "c5cf4f6f-87db-4506-b1af-f50026efbd28",
"Asset": {
"AssetId": "9c0e31d1-b84c-4640-8260-55dee497430e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3b4cc072-88dd-429c-b1ae-13085d6dc0ae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dae29748-ca98-447c-979d-a8acdf0f48a9",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e0f10dec-0bc3-4ef7-af08-1335ec85449c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-18T08:29:40.0227868-07:00",
"MeasurementValueNeededDate": "2026-07-18T08:29:40.0227868-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a8e3b2bd-6f01-4d33-b555-03fb48719efb",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a597ec6c-1b81-4cd6-98d6-2361deacd724",
"EffectiveDate": "2026-07-18T08:29:40.0227868-07:00",
"StateType": {
"StateTypeId": "d5a1277c-5505-45bf-b9d9-35a44d4786fd",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "3b4cc072-88dd-429c-b1ae-13085d6dc0ae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dae29748-ca98-447c-979d-a8acdf0f48a9",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e643c7a8-5160-4d5f-b6aa-fdaf205facd5",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3a7d73bc-f8a1-4d6d-9219-eb8e56708476",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c4e8bb42-2674-48e3-a76a-00cddb5579d2",
"EffectiveDate": "2026-07-18T08:29:40.0227868-07:00",
"StatusType": {
"StatusTypeId": "2253c5fc-b11d-48b4-8fc7-0af3d61607a0",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "3b4cc072-88dd-429c-b1ae-13085d6dc0ae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dae29748-ca98-447c-979d-a8acdf0f48a9",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "32f945ae-488c-4258-a4c8-31281c5ce4bc",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4a160c75-c586-466c-ad37-bac7ef9a38dd",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "62d7ceb9-4a42-4730-8a92-a7a893ffa860",
"EffectiveDate": "2026-07-18T08:29:40.0227868-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "dc501d42-2f06-4a40-af85-d02f5fb9b01c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cde3d663-ee19-4a45-8316-214ab5c2a3e9",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "78759b63-0a32-45c0-b01f-89371e04c80c",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-18T08:29:40.0227868-07:00",
"MeasurementValueNeededDate": "2026-07-18T08:29:40.0227868-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3e43fa97-f6be-4673-b405-689135b2aadf",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "d0120d1a-1207-45d9-8ec3-5b39386065c8",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3b4cc072-88dd-429c-b1ae-13085d6dc0ae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dae29748-ca98-447c-979d-a8acdf0f48a9",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-18T08:29:40.0384606-07:00",
"Fields": [
{
"FormTypeFieldId": "8c322286-9483-4ec4-a289-1cd368c24fe5",
"Section": {
"FormTypeSectionId": "6d89b8ea-1c2c-4787-9e3e-a6ca0935cc68",
"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": "70a95c81-0b26-4b97-9e94-2daf233685b1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "838ce84f-b808-4655-a1d3-192e296bf745",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea6953bc-b047-4447-8fea-8239f3eeb454",
"CreateDate": "2026-07-18T08:29:40.0384606-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T08:29:40.0384606-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "83bf01ac-3606-4353-acf8-b6b7f28117be",
"FieldId": "3a70bd7e-8426-43b4-b80c-e70c15a2c653",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "83bf01ac-3606-4353-acf8-b6b7f28117be",
"FieldId": "3a70bd7e-8426-43b4-b80c-e70c15a2c653",
"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": "8c322286-9483-4ec4-a289-1cd368c24fe5",
"Section": {
"FormTypeSectionId": "6d89b8ea-1c2c-4787-9e3e-a6ca0935cc68",
"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": "70a95c81-0b26-4b97-9e94-2daf233685b1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "838ce84f-b808-4655-a1d3-192e296bf745",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea6953bc-b047-4447-8fea-8239f3eeb454",
"CreateDate": "2026-07-18T08:29:40.0384606-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T08:29:40.0384606-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "83bf01ac-3606-4353-acf8-b6b7f28117be",
"FieldId": "3a70bd7e-8426-43b4-b80c-e70c15a2c653",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "83bf01ac-3606-4353-acf8-b6b7f28117be",
"FieldId": "3a70bd7e-8426-43b4-b80c-e70c15a2c653",
"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": "93e06709-9c79-445e-91c8-9e993dd20458",
"CreateDate": "2026-07-18T08:29:40.0384606-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T08:29:40.0384606-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-07-18T08:29:40.0384606-07:00",
"Location": "sample string 1",
"TaskId": "1e6e1925-1730-436a-97da-92b40a310da9",
"Values": [
{
"FormFieldValueId": "39a14fac-b724-4d86-bc66-7db724ed7a10",
"FormId": "432f47e8-41f5-4992-a63e-7657ba53ae80",
"FormTypeField": {
"FormTypeFieldId": "8c322286-9483-4ec4-a289-1cd368c24fe5",
"FormType": {
"FormTypeId": "d0120d1a-1207-45d9-8ec3-5b39386065c8",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3b4cc072-88dd-429c-b1ae-13085d6dc0ae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dae29748-ca98-447c-979d-a8acdf0f48a9",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-18T08:29:40.0384606-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "93e06709-9c79-445e-91c8-9e993dd20458",
"CreateDate": "2026-07-18T08:29:40.0384606-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T08:29:40.0384606-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "6d89b8ea-1c2c-4787-9e3e-a6ca0935cc68",
"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": "70a95c81-0b26-4b97-9e94-2daf233685b1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "838ce84f-b808-4655-a1d3-192e296bf745",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea6953bc-b047-4447-8fea-8239f3eeb454",
"CreateDate": "2026-07-18T08:29:40.0384606-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T08:29:40.0384606-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "83bf01ac-3606-4353-acf8-b6b7f28117be",
"FieldId": "3a70bd7e-8426-43b4-b80c-e70c15a2c653",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "83bf01ac-3606-4353-acf8-b6b7f28117be",
"FieldId": "3a70bd7e-8426-43b4-b80c-e70c15a2c653",
"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": "39a14fac-b724-4d86-bc66-7db724ed7a10",
"FormId": "432f47e8-41f5-4992-a63e-7657ba53ae80",
"FormTypeField": {
"FormTypeFieldId": "8c322286-9483-4ec4-a289-1cd368c24fe5",
"FormType": {
"FormTypeId": "d0120d1a-1207-45d9-8ec3-5b39386065c8",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3b4cc072-88dd-429c-b1ae-13085d6dc0ae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dae29748-ca98-447c-979d-a8acdf0f48a9",
"CreateDate": "2026-07-18T08:29:40.0227868-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-18T08:29:40.0227868-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-18T08:29:40.0384606-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "93e06709-9c79-445e-91c8-9e993dd20458",
"CreateDate": "2026-07-18T08:29:40.0384606-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T08:29:40.0384606-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "6d89b8ea-1c2c-4787-9e3e-a6ca0935cc68",
"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": "70a95c81-0b26-4b97-9e94-2daf233685b1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "838ce84f-b808-4655-a1d3-192e296bf745",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea6953bc-b047-4447-8fea-8239f3eeb454",
"CreateDate": "2026-07-18T08:29:40.0384606-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T08:29:40.0384606-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "83bf01ac-3606-4353-acf8-b6b7f28117be",
"FieldId": "3a70bd7e-8426-43b4-b80c-e70c15a2c653",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "83bf01ac-3606-4353-acf8-b6b7f28117be",
"FieldId": "3a70bd7e-8426-43b4-b80c-e70c15a2c653",
"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": "453a65a8-92e4-431d-9b3b-8378efca2405",
"CreateDate": "2026-07-18T08:29:40.0384606-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-18T08:29:40.0384606-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}