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": "a34762fc-fb7f-4f87-b20d-e3b1a22d80fa",
"Asset": {
"AssetId": "bbe3ead2-05eb-43d6-ad2f-20e484da48ae",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d89489a8-2822-4070-a5c8-782a91a43088",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "297eaa65-3fd1-4471-90dc-00860ec2ff26",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "595f76fb-89e1-4d8e-b9fc-560dcfe2c53c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-29T19:47:06.9556881-08:00",
"MeasurementValueNeededDate": "2026-01-29T19:47:06.9556881-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e8621130-ed3b-4efe-b2ec-e6ed8f59c1c5",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "0fd52df3-eec8-4e9f-94f6-af8d94e5a9db",
"EffectiveDate": "2026-01-29T19:47:06.9556881-08:00",
"StateType": {
"StateTypeId": "c97ac2a3-113f-4647-a71e-d44819b3465e",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d89489a8-2822-4070-a5c8-782a91a43088",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "297eaa65-3fd1-4471-90dc-00860ec2ff26",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "87adebbe-d965-4549-b3cb-4bd42c2dd04f",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d783e0f6-a783-499c-a7c8-d83a40f9dbfa",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c05284b3-c54b-4ddd-b5b9-f0b527a7bc96",
"EffectiveDate": "2026-01-29T19:47:06.9556881-08:00",
"StatusType": {
"StatusTypeId": "8ec9b650-0d25-4065-8131-e852257d68c7",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d89489a8-2822-4070-a5c8-782a91a43088",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "297eaa65-3fd1-4471-90dc-00860ec2ff26",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c4a6eca1-187b-4faf-b63b-26b05c1ff93c",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "56c2875d-88af-4525-a0ec-a7eef9f53f49",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4357d81e-581c-4b87-978c-0794e4e3fc73",
"EffectiveDate": "2026-01-29T19:47:06.9556881-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "d01cd90d-46bd-4905-8a72-92c9e1eb88e2",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c93e3ef1-9dd7-4b55-82ee-6f41b927fc49",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "20053e01-1260-4b26-acd2-4d890f80c2a4",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-01-29T19:47:06.9556881-08:00",
"MeasurementValueNeededDate": "2026-01-29T19:47:06.9556881-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "677459b1-94f8-4703-8158-c569919387ba",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "73b9adcf-7dd1-449a-88fa-0b69434e3f01",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d89489a8-2822-4070-a5c8-782a91a43088",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "297eaa65-3fd1-4471-90dc-00860ec2ff26",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-29T19:47:06.9556881-08:00",
"Fields": [
{
"FormTypeFieldId": "2947df14-2447-4194-a0cb-aaf5376c4267",
"Section": {
"FormTypeSectionId": "aa89361e-6a0f-494f-b903-f2893fb3781f",
"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": "a8e25512-788c-451e-8b27-28ab5f2000fa",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "efbb2213-94fe-4334-a911-48475e0e2f17",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c8187ea5-7a92-4879-b82e-e484fd380db9",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fb834302-ed6c-481b-bc53-c08f6e21c667",
"FieldId": "2a48f20c-7dd5-4342-b903-295e4e823b40",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fb834302-ed6c-481b-bc53-c08f6e21c667",
"FieldId": "2a48f20c-7dd5-4342-b903-295e4e823b40",
"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": "2947df14-2447-4194-a0cb-aaf5376c4267",
"Section": {
"FormTypeSectionId": "aa89361e-6a0f-494f-b903-f2893fb3781f",
"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": "a8e25512-788c-451e-8b27-28ab5f2000fa",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "efbb2213-94fe-4334-a911-48475e0e2f17",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c8187ea5-7a92-4879-b82e-e484fd380db9",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fb834302-ed6c-481b-bc53-c08f6e21c667",
"FieldId": "2a48f20c-7dd5-4342-b903-295e4e823b40",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fb834302-ed6c-481b-bc53-c08f6e21c667",
"FieldId": "2a48f20c-7dd5-4342-b903-295e4e823b40",
"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": "e5f08366-de07-4bd8-8fdf-13d85b1e6c41",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-01-29T19:47:06.9556881-08:00",
"Location": "sample string 1",
"TaskId": "50ff0b35-52d5-49d1-8ed1-3b16ed2c2b14",
"Values": [
{
"FormFieldValueId": "bf760ab6-f335-4255-90a5-8f16e3a5f3ba",
"FormId": "e82d12f2-4e19-488a-944c-95fbcb32a4c0",
"FormTypeField": {
"FormTypeFieldId": "2947df14-2447-4194-a0cb-aaf5376c4267",
"FormType": {
"FormTypeId": "73b9adcf-7dd1-449a-88fa-0b69434e3f01",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d89489a8-2822-4070-a5c8-782a91a43088",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "297eaa65-3fd1-4471-90dc-00860ec2ff26",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-29T19:47:06.9556881-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "e5f08366-de07-4bd8-8fdf-13d85b1e6c41",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "aa89361e-6a0f-494f-b903-f2893fb3781f",
"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": "a8e25512-788c-451e-8b27-28ab5f2000fa",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "efbb2213-94fe-4334-a911-48475e0e2f17",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c8187ea5-7a92-4879-b82e-e484fd380db9",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fb834302-ed6c-481b-bc53-c08f6e21c667",
"FieldId": "2a48f20c-7dd5-4342-b903-295e4e823b40",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fb834302-ed6c-481b-bc53-c08f6e21c667",
"FieldId": "2a48f20c-7dd5-4342-b903-295e4e823b40",
"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": "bf760ab6-f335-4255-90a5-8f16e3a5f3ba",
"FormId": "e82d12f2-4e19-488a-944c-95fbcb32a4c0",
"FormTypeField": {
"FormTypeFieldId": "2947df14-2447-4194-a0cb-aaf5376c4267",
"FormType": {
"FormTypeId": "73b9adcf-7dd1-449a-88fa-0b69434e3f01",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d89489a8-2822-4070-a5c8-782a91a43088",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "297eaa65-3fd1-4471-90dc-00860ec2ff26",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-29T19:47:06.9556881-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "e5f08366-de07-4bd8-8fdf-13d85b1e6c41",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "aa89361e-6a0f-494f-b903-f2893fb3781f",
"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": "a8e25512-788c-451e-8b27-28ab5f2000fa",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "efbb2213-94fe-4334-a911-48475e0e2f17",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c8187ea5-7a92-4879-b82e-e484fd380db9",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fb834302-ed6c-481b-bc53-c08f6e21c667",
"FieldId": "2a48f20c-7dd5-4342-b903-295e4e823b40",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fb834302-ed6c-481b-bc53-c08f6e21c667",
"FieldId": "2a48f20c-7dd5-4342-b903-295e4e823b40",
"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": "c23b4166-d9f5-4dd8-a09e-ced3dc230261",
"CreateDate": "2026-01-29T19:47:06.9556881-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-29T19:47:06.9556881-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}