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": "54634de1-ee3b-4ba2-ba44-3cd3b272747e",
"Asset": {
"AssetId": "ac17e194-12d6-46de-9661-3716edc16dd1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5c92b6f8-00d2-4772-9c89-534c79b49616",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6897baa4-f092-46b6-946b-0f34e0568109",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b9105bf3-8bb9-440e-a5f4-b95995744332",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-13T09:44:20.1139947-07:00",
"MeasurementValueNeededDate": "2026-05-13T09:44:20.1139947-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c4ff00b8-69c9-43eb-aacd-1d81414ed113",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f6f37aa9-0566-42c4-bd8c-4cf4295dd8e9",
"EffectiveDate": "2026-05-13T09:44:20.1139947-07:00",
"StateType": {
"StateTypeId": "1662c460-757c-43e5-8786-55d9517b44f5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5c92b6f8-00d2-4772-9c89-534c79b49616",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6897baa4-f092-46b6-946b-0f34e0568109",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "fa89b230-ea7b-4865-a6e7-b6aac78cb060",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a81c7db3-a616-468a-93c3-19e352a6596c",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1d9dd214-6d47-4ee2-99e1-8aa1d7065756",
"EffectiveDate": "2026-05-13T09:44:20.1139947-07:00",
"StatusType": {
"StatusTypeId": "3ac43d02-1562-43cb-9496-6833539faa33",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5c92b6f8-00d2-4772-9c89-534c79b49616",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6897baa4-f092-46b6-946b-0f34e0568109",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b1c70b39-e41c-460b-be2f-f56a384d3131",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "695d898b-81bf-4f0d-9f69-2066031e1c52",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "04063a80-2035-44b1-9215-aab8756517a6",
"EffectiveDate": "2026-05-13T09:44:20.1139947-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "4fcffcb6-5c27-4e29-9a51-1cf0c3f3c2fc",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6116cb43-32c6-4d9f-bbdb-b08cbfa5b84f",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "62cd3137-035e-4508-9b13-b152135b9bcf",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-13T09:44:20.1139947-07:00",
"MeasurementValueNeededDate": "2026-05-13T09:44:20.1139947-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "70abd404-57f3-40d3-b140-3d8a516125e9",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "b143e114-cb1f-4f16-bda2-f591b676869a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5c92b6f8-00d2-4772-9c89-534c79b49616",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6897baa4-f092-46b6-946b-0f34e0568109",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-13T09:44:20.1139947-07:00",
"Fields": [
{
"FormTypeFieldId": "3ae84334-7983-4a64-9f66-5cd1571feea7",
"Section": {
"FormTypeSectionId": "42b87ce0-6784-46b8-bf07-ca5fd288e30f",
"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": "de4b69dc-c442-4327-8ea8-5e3eba303c76",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bc866a87-b26b-46fa-a8f3-1a166971c658",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d0786fdd-e907-498d-80dc-02e432b0dd83",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b2b1669a-a409-4ac8-9f40-20633bc7342e",
"FieldId": "dbdd4a13-d2e9-4eb1-be41-e9f013f27d68",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b2b1669a-a409-4ac8-9f40-20633bc7342e",
"FieldId": "dbdd4a13-d2e9-4eb1-be41-e9f013f27d68",
"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": "3ae84334-7983-4a64-9f66-5cd1571feea7",
"Section": {
"FormTypeSectionId": "42b87ce0-6784-46b8-bf07-ca5fd288e30f",
"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": "de4b69dc-c442-4327-8ea8-5e3eba303c76",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bc866a87-b26b-46fa-a8f3-1a166971c658",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d0786fdd-e907-498d-80dc-02e432b0dd83",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b2b1669a-a409-4ac8-9f40-20633bc7342e",
"FieldId": "dbdd4a13-d2e9-4eb1-be41-e9f013f27d68",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b2b1669a-a409-4ac8-9f40-20633bc7342e",
"FieldId": "dbdd4a13-d2e9-4eb1-be41-e9f013f27d68",
"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": "11b8c19a-e473-4d3d-9cff-0525171f5924",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-05-13T09:44:20.1139947-07:00",
"Location": "sample string 1",
"TaskId": "0bc12739-0bf7-4905-980d-b64b7124e516",
"Values": [
{
"FormFieldValueId": "7b54b7b1-f906-4670-8809-38fe221340bb",
"FormId": "d8639c83-85d7-47b2-a89f-ebeca00d117c",
"FormTypeField": {
"FormTypeFieldId": "3ae84334-7983-4a64-9f66-5cd1571feea7",
"FormType": {
"FormTypeId": "b143e114-cb1f-4f16-bda2-f591b676869a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5c92b6f8-00d2-4772-9c89-534c79b49616",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6897baa4-f092-46b6-946b-0f34e0568109",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-13T09:44:20.1139947-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "11b8c19a-e473-4d3d-9cff-0525171f5924",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "42b87ce0-6784-46b8-bf07-ca5fd288e30f",
"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": "de4b69dc-c442-4327-8ea8-5e3eba303c76",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bc866a87-b26b-46fa-a8f3-1a166971c658",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d0786fdd-e907-498d-80dc-02e432b0dd83",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b2b1669a-a409-4ac8-9f40-20633bc7342e",
"FieldId": "dbdd4a13-d2e9-4eb1-be41-e9f013f27d68",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b2b1669a-a409-4ac8-9f40-20633bc7342e",
"FieldId": "dbdd4a13-d2e9-4eb1-be41-e9f013f27d68",
"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": "7b54b7b1-f906-4670-8809-38fe221340bb",
"FormId": "d8639c83-85d7-47b2-a89f-ebeca00d117c",
"FormTypeField": {
"FormTypeFieldId": "3ae84334-7983-4a64-9f66-5cd1571feea7",
"FormType": {
"FormTypeId": "b143e114-cb1f-4f16-bda2-f591b676869a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5c92b6f8-00d2-4772-9c89-534c79b49616",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6897baa4-f092-46b6-946b-0f34e0568109",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-13T09:44:20.1139947-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "11b8c19a-e473-4d3d-9cff-0525171f5924",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "42b87ce0-6784-46b8-bf07-ca5fd288e30f",
"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": "de4b69dc-c442-4327-8ea8-5e3eba303c76",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bc866a87-b26b-46fa-a8f3-1a166971c658",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d0786fdd-e907-498d-80dc-02e432b0dd83",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b2b1669a-a409-4ac8-9f40-20633bc7342e",
"FieldId": "dbdd4a13-d2e9-4eb1-be41-e9f013f27d68",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b2b1669a-a409-4ac8-9f40-20633bc7342e",
"FieldId": "dbdd4a13-d2e9-4eb1-be41-e9f013f27d68",
"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": "7297b06c-c55d-45d9-ac6e-6144c001afec",
"CreateDate": "2026-05-13T09:44:20.1139947-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-13T09:44:20.1139947-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}