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": "0cf09f3f-ebcc-4c42-b05d-f460781538b1",
"Asset": {
"AssetId": "58f8d87b-21e0-45a2-bc8f-27c9c914589f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "339df1fc-837f-49fd-b223-b3ee2f18c295",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74ddbaef-9897-4574-8f34-83d1bab06b58",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "887873a6-017b-46aa-9f30-0b188f879491",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-21T17:54:33.1958407-07:00",
"MeasurementValueNeededDate": "2026-03-21T17:54:33.1958407-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "49921752-080e-494c-90f5-a4aa166985d0",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7123dbc9-d6e5-4d9e-9fdb-9914721afff5",
"EffectiveDate": "2026-03-21T17:54:33.1958407-07:00",
"StateType": {
"StateTypeId": "ae5837b8-c076-469a-94d4-c5827d8100b3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "339df1fc-837f-49fd-b223-b3ee2f18c295",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74ddbaef-9897-4574-8f34-83d1bab06b58",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "19c82c8b-bc41-45e2-9dd8-a863d76e724f",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "359eb3d7-a383-4503-a381-394753e85eac",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "85735681-7641-4939-90f5-3f259c3e5f08",
"EffectiveDate": "2026-03-21T17:54:33.1958407-07:00",
"StatusType": {
"StatusTypeId": "46f2c093-ff22-4bad-86a1-ef653db10c51",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "339df1fc-837f-49fd-b223-b3ee2f18c295",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74ddbaef-9897-4574-8f34-83d1bab06b58",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "81b0540b-7220-4826-a427-48881dea07dc",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f1b594d1-66ba-4c53-bf92-a92a2ba646d2",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "64cf0de2-5df8-4ae7-97b6-018289442a7c",
"EffectiveDate": "2026-03-21T17:54:33.1958407-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "a589cfe9-2caf-4cc9-9e46-14fd41d95b1c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "341b4ca9-bf85-4787-aea7-058505528db0",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c7d8d6c7-c686-4d35-91b2-50b4408797a9",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-21T17:54:33.1958407-07:00",
"MeasurementValueNeededDate": "2026-03-21T17:54:33.1958407-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3d886625-f18e-4171-8679-ef4158647337",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "c9269ade-d733-4fb5-8d15-c74dfd664d14",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "339df1fc-837f-49fd-b223-b3ee2f18c295",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74ddbaef-9897-4574-8f34-83d1bab06b58",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-21T17:54:33.1958407-07:00",
"Fields": [
{
"FormTypeFieldId": "1cab7e74-2b35-4440-b56b-8ac64d6fe186",
"Section": {
"FormTypeSectionId": "e7c0f781-6f6d-4462-b263-4018762c1455",
"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": "c7d28839-45b0-427e-9602-6bfb4d8bf3cb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ab1f6f17-6aaf-4acf-b4a4-8da26b280ca9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9f3db656-bcd8-4d07-819b-2242fca2b0a2",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f2f95413-4498-4c97-92b1-a37d328331f1",
"FieldId": "eb3ae717-347a-4189-b75c-61f4ad65b3eb",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f2f95413-4498-4c97-92b1-a37d328331f1",
"FieldId": "eb3ae717-347a-4189-b75c-61f4ad65b3eb",
"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": "1cab7e74-2b35-4440-b56b-8ac64d6fe186",
"Section": {
"FormTypeSectionId": "e7c0f781-6f6d-4462-b263-4018762c1455",
"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": "c7d28839-45b0-427e-9602-6bfb4d8bf3cb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ab1f6f17-6aaf-4acf-b4a4-8da26b280ca9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9f3db656-bcd8-4d07-819b-2242fca2b0a2",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f2f95413-4498-4c97-92b1-a37d328331f1",
"FieldId": "eb3ae717-347a-4189-b75c-61f4ad65b3eb",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f2f95413-4498-4c97-92b1-a37d328331f1",
"FieldId": "eb3ae717-347a-4189-b75c-61f4ad65b3eb",
"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": "1b0701ad-7f8b-4f51-a63f-26d96fdda84f",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-03-21T17:54:33.1958407-07:00",
"Location": "sample string 1",
"TaskId": "6e24ed5d-62c2-454d-be0f-fa57ef696a4f",
"Values": [
{
"FormFieldValueId": "c2b03e72-b802-4ac0-9f19-b34e95c20e82",
"FormId": "89be0011-db7e-48c3-9f02-43c69dc41755",
"FormTypeField": {
"FormTypeFieldId": "1cab7e74-2b35-4440-b56b-8ac64d6fe186",
"FormType": {
"FormTypeId": "c9269ade-d733-4fb5-8d15-c74dfd664d14",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "339df1fc-837f-49fd-b223-b3ee2f18c295",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74ddbaef-9897-4574-8f34-83d1bab06b58",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-21T17:54:33.1958407-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "1b0701ad-7f8b-4f51-a63f-26d96fdda84f",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "e7c0f781-6f6d-4462-b263-4018762c1455",
"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": "c7d28839-45b0-427e-9602-6bfb4d8bf3cb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ab1f6f17-6aaf-4acf-b4a4-8da26b280ca9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9f3db656-bcd8-4d07-819b-2242fca2b0a2",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f2f95413-4498-4c97-92b1-a37d328331f1",
"FieldId": "eb3ae717-347a-4189-b75c-61f4ad65b3eb",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f2f95413-4498-4c97-92b1-a37d328331f1",
"FieldId": "eb3ae717-347a-4189-b75c-61f4ad65b3eb",
"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": "c2b03e72-b802-4ac0-9f19-b34e95c20e82",
"FormId": "89be0011-db7e-48c3-9f02-43c69dc41755",
"FormTypeField": {
"FormTypeFieldId": "1cab7e74-2b35-4440-b56b-8ac64d6fe186",
"FormType": {
"FormTypeId": "c9269ade-d733-4fb5-8d15-c74dfd664d14",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "339df1fc-837f-49fd-b223-b3ee2f18c295",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74ddbaef-9897-4574-8f34-83d1bab06b58",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-21T17:54:33.1958407-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "1b0701ad-7f8b-4f51-a63f-26d96fdda84f",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "e7c0f781-6f6d-4462-b263-4018762c1455",
"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": "c7d28839-45b0-427e-9602-6bfb4d8bf3cb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ab1f6f17-6aaf-4acf-b4a4-8da26b280ca9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9f3db656-bcd8-4d07-819b-2242fca2b0a2",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f2f95413-4498-4c97-92b1-a37d328331f1",
"FieldId": "eb3ae717-347a-4189-b75c-61f4ad65b3eb",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f2f95413-4498-4c97-92b1-a37d328331f1",
"FieldId": "eb3ae717-347a-4189-b75c-61f4ad65b3eb",
"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": "960aaf62-9792-4021-83c8-852bd68a9657",
"CreateDate": "2026-03-21T17:54:33.1958407-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-21T17:54:33.1958407-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}