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": "f8992d3c-d3d5-47d5-9669-d58a5707a4d4",
"Asset": {
"AssetId": "c0fd1932-880c-4647-aa26-e7e98e44d512",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5660f4f9-2b02-40b4-a8eb-3bb53ecef28f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5eedb76-781c-4f90-aa84-96dbe9d0bef5",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5a59473f-7ae0-4aa5-915e-eed1e5654d86",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-03T20:24:48.9291511-07:00",
"MeasurementValueNeededDate": "2026-10-03T20:24:48.9291511-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "40355713-ddf8-48bb-8f70-f444f6b897a4",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a69adad0-68ba-4674-be49-9bd83e29383c",
"EffectiveDate": "2026-10-03T20:24:48.9291511-07:00",
"StateType": {
"StateTypeId": "61736a92-7619-4765-85e8-8d748e1d89ee",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5660f4f9-2b02-40b4-a8eb-3bb53ecef28f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5eedb76-781c-4f90-aa84-96dbe9d0bef5",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "fb0f91a6-c894-4a7a-b534-fc94afa85b2e",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "988f5c4d-dc3d-4dae-8287-7b7582f6a067",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8e3fa335-df7d-4525-a9bd-5c67d9c1ee9f",
"EffectiveDate": "2026-10-03T20:24:48.9291511-07:00",
"StatusType": {
"StatusTypeId": "d60bdce6-555b-4a9e-8abd-2bf524a9443e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5660f4f9-2b02-40b4-a8eb-3bb53ecef28f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5eedb76-781c-4f90-aa84-96dbe9d0bef5",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "27095149-4aec-445e-b810-488697238b0a",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5d49c51d-0da6-4b98-92bf-391ab09ea104",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d833621a-5aad-499b-9ccd-a7b076d746ba",
"EffectiveDate": "2026-10-03T20:24:48.9291511-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "5820b4b1-e020-4155-809a-9d3136f6a85f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "75bfbe7b-62a4-4c07-b37c-d51839f5ff63",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "94a1b0b9-f38c-4643-9aa8-3218f45e25f3",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-03T20:24:48.9291511-07:00",
"MeasurementValueNeededDate": "2026-10-03T20:24:48.9291511-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e6ceeb1c-256d-46c6-94d1-28abae46f68c",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "458e4a66-9880-473a-b332-31e9236a1d24",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5660f4f9-2b02-40b4-a8eb-3bb53ecef28f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5eedb76-781c-4f90-aa84-96dbe9d0bef5",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-03T20:24:48.9291511-07:00",
"Fields": [
{
"FormTypeFieldId": "c9286e34-d9b9-4803-9845-5a5363f63f5f",
"Section": {
"FormTypeSectionId": "dfee5ee2-8a6c-4847-91d3-24585ab06da0",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "e8298c8a-8bdd-4fae-a79c-d7224446bb85",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b894fede-0c56-4673-ace5-17e21593217b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fa9f2f33-7636-4c13-a4ef-b4964e90e961",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "81231bfb-980c-4dc3-85c7-bcdedb472620",
"FieldId": "b645c400-4a5f-402d-8e58-310da104b762",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "81231bfb-980c-4dc3-85c7-bcdedb472620",
"FieldId": "b645c400-4a5f-402d-8e58-310da104b762",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
{
"FormTypeFieldId": "c9286e34-d9b9-4803-9845-5a5363f63f5f",
"Section": {
"FormTypeSectionId": "dfee5ee2-8a6c-4847-91d3-24585ab06da0",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "e8298c8a-8bdd-4fae-a79c-d7224446bb85",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b894fede-0c56-4673-ace5-17e21593217b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fa9f2f33-7636-4c13-a4ef-b4964e90e961",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "81231bfb-980c-4dc3-85c7-bcdedb472620",
"FieldId": "b645c400-4a5f-402d-8e58-310da104b762",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "81231bfb-980c-4dc3-85c7-bcdedb472620",
"FieldId": "b645c400-4a5f-402d-8e58-310da104b762",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "1c30dd45-761f-4dae-a108-9a9aa365d466",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-10-03T20:24:48.9291511-07:00",
"Location": "sample string 1",
"TaskId": "820642aa-5b53-4ddc-8671-049c1efa1c05",
"Values": [
{
"FormFieldValueId": "2a9c9846-08c8-49dc-8d2e-84dec55eba1d",
"FormId": "0f2a8082-c400-4e74-99d3-1b97b51dad2e",
"FormTypeField": {
"FormTypeFieldId": "c9286e34-d9b9-4803-9845-5a5363f63f5f",
"FormType": {
"FormTypeId": "458e4a66-9880-473a-b332-31e9236a1d24",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5660f4f9-2b02-40b4-a8eb-3bb53ecef28f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5eedb76-781c-4f90-aa84-96dbe9d0bef5",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-03T20:24:48.9291511-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "1c30dd45-761f-4dae-a108-9a9aa365d466",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "dfee5ee2-8a6c-4847-91d3-24585ab06da0",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "e8298c8a-8bdd-4fae-a79c-d7224446bb85",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b894fede-0c56-4673-ace5-17e21593217b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fa9f2f33-7636-4c13-a4ef-b4964e90e961",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "81231bfb-980c-4dc3-85c7-bcdedb472620",
"FieldId": "b645c400-4a5f-402d-8e58-310da104b762",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "81231bfb-980c-4dc3-85c7-bcdedb472620",
"FieldId": "b645c400-4a5f-402d-8e58-310da104b762",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
"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": "2a9c9846-08c8-49dc-8d2e-84dec55eba1d",
"FormId": "0f2a8082-c400-4e74-99d3-1b97b51dad2e",
"FormTypeField": {
"FormTypeFieldId": "c9286e34-d9b9-4803-9845-5a5363f63f5f",
"FormType": {
"FormTypeId": "458e4a66-9880-473a-b332-31e9236a1d24",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5660f4f9-2b02-40b4-a8eb-3bb53ecef28f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a5eedb76-781c-4f90-aa84-96dbe9d0bef5",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-03T20:24:48.9291511-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "1c30dd45-761f-4dae-a108-9a9aa365d466",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "dfee5ee2-8a6c-4847-91d3-24585ab06da0",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "e8298c8a-8bdd-4fae-a79c-d7224446bb85",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b894fede-0c56-4673-ace5-17e21593217b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fa9f2f33-7636-4c13-a4ef-b4964e90e961",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "81231bfb-980c-4dc3-85c7-bcdedb472620",
"FieldId": "b645c400-4a5f-402d-8e58-310da104b762",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "81231bfb-980c-4dc3-85c7-bcdedb472620",
"FieldId": "b645c400-4a5f-402d-8e58-310da104b762",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
"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": "312d1b88-b50c-41a7-958f-ebf9097a5162",
"CreateDate": "2026-10-03T20:24:48.9291511-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-03T20:24:48.9291511-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}