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": "21c648bf-90c0-4485-ba9f-095579b78b05",
"Asset": {
"AssetId": "da30b67d-5451-47d3-8f34-3677ffd49d0c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1f4fc273-cb42-4dd4-86db-a8ce1be4eb9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "542b1be9-7771-4867-9a13-7a268040ca68",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d9225914-f2bd-42f0-a434-df45e894397c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-11T22:26:36.6605936-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:26:36.6605936-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a85e3153-b6f4-426d-9139-b676f526c036",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "4c3c984b-c7c3-40dc-bc7d-c4755e571068",
"EffectiveDate": "2026-08-11T22:26:36.6605936-07:00",
"StateType": {
"StateTypeId": "35f7e319-bbe1-4cdb-a4c4-8c82ac41e5c8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1f4fc273-cb42-4dd4-86db-a8ce1be4eb9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "542b1be9-7771-4867-9a13-7a268040ca68",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "98caa56b-e98d-4bd2-96ef-8bcbdc5b894b",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5fd5e8fe-4854-46c9-ba8e-3f297f587a40",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "82e17888-d235-416d-8b7d-065250919aeb",
"EffectiveDate": "2026-08-11T22:26:36.6605936-07:00",
"StatusType": {
"StatusTypeId": "a6c6273c-d122-4d68-a7a3-f83db118dbdb",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1f4fc273-cb42-4dd4-86db-a8ce1be4eb9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "542b1be9-7771-4867-9a13-7a268040ca68",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "cdb0267c-b7fe-43db-bec6-283dbbee71de",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b36decb5-2ab4-4efc-b8db-c581be3dfacc",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b426a9d4-c384-48cf-9838-bc0ed04880ff",
"EffectiveDate": "2026-08-11T22:26:36.6605936-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "88e575cc-5437-4238-b8e0-4edd31fe73ed",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "66b3c227-731a-43e8-b0ef-c99114fc6dec",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2bbca389-91c4-4a07-927f-74390dc13b60",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-11T22:26:36.6605936-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:26:36.6605936-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f2cf702b-e0bf-469e-8ab3-1e0adca64f45",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "90e8734a-91c3-46c3-8c05-24a1fd54b7c2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1f4fc273-cb42-4dd4-86db-a8ce1be4eb9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "542b1be9-7771-4867-9a13-7a268040ca68",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-11T22:26:36.6605936-07:00",
"Fields": [
{
"FormTypeFieldId": "0fa61805-be37-48bd-bdc7-138c2b4391f7",
"Section": {
"FormTypeSectionId": "2de73b42-61ef-41ec-a04d-d577670b279b",
"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": "4906a4f6-0f92-4d5a-981c-3004b1679bd7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d5728cea-5995-479c-94f7-346cbf0ee4e4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1b32f91e-43e4-434d-8dfa-1bee8ecd9ffe",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "74866519-88cf-43fd-ae8b-d150dc4e5773",
"FieldId": "60274bc1-d97c-4362-9253-9ea0dd674644",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "74866519-88cf-43fd-ae8b-d150dc4e5773",
"FieldId": "60274bc1-d97c-4362-9253-9ea0dd674644",
"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": "0fa61805-be37-48bd-bdc7-138c2b4391f7",
"Section": {
"FormTypeSectionId": "2de73b42-61ef-41ec-a04d-d577670b279b",
"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": "4906a4f6-0f92-4d5a-981c-3004b1679bd7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d5728cea-5995-479c-94f7-346cbf0ee4e4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1b32f91e-43e4-434d-8dfa-1bee8ecd9ffe",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "74866519-88cf-43fd-ae8b-d150dc4e5773",
"FieldId": "60274bc1-d97c-4362-9253-9ea0dd674644",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "74866519-88cf-43fd-ae8b-d150dc4e5773",
"FieldId": "60274bc1-d97c-4362-9253-9ea0dd674644",
"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": "83900491-9787-4861-9238-c1bab6e1faec",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-08-11T22:26:36.6605936-07:00",
"Location": "sample string 1",
"TaskId": "fc0d2d50-0716-461d-8127-42a450f303ff",
"Values": [
{
"FormFieldValueId": "c3ed9162-bff7-46e6-a83a-6425c0901a49",
"FormId": "c0e264c1-7363-4fe4-94d7-d404ec3f45c9",
"FormTypeField": {
"FormTypeFieldId": "0fa61805-be37-48bd-bdc7-138c2b4391f7",
"FormType": {
"FormTypeId": "90e8734a-91c3-46c3-8c05-24a1fd54b7c2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1f4fc273-cb42-4dd4-86db-a8ce1be4eb9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "542b1be9-7771-4867-9a13-7a268040ca68",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-11T22:26:36.6605936-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "83900491-9787-4861-9238-c1bab6e1faec",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "2de73b42-61ef-41ec-a04d-d577670b279b",
"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": "4906a4f6-0f92-4d5a-981c-3004b1679bd7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d5728cea-5995-479c-94f7-346cbf0ee4e4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1b32f91e-43e4-434d-8dfa-1bee8ecd9ffe",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "74866519-88cf-43fd-ae8b-d150dc4e5773",
"FieldId": "60274bc1-d97c-4362-9253-9ea0dd674644",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "74866519-88cf-43fd-ae8b-d150dc4e5773",
"FieldId": "60274bc1-d97c-4362-9253-9ea0dd674644",
"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": "c3ed9162-bff7-46e6-a83a-6425c0901a49",
"FormId": "c0e264c1-7363-4fe4-94d7-d404ec3f45c9",
"FormTypeField": {
"FormTypeFieldId": "0fa61805-be37-48bd-bdc7-138c2b4391f7",
"FormType": {
"FormTypeId": "90e8734a-91c3-46c3-8c05-24a1fd54b7c2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1f4fc273-cb42-4dd4-86db-a8ce1be4eb9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "542b1be9-7771-4867-9a13-7a268040ca68",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-11T22:26:36.6605936-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "83900491-9787-4861-9238-c1bab6e1faec",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "2de73b42-61ef-41ec-a04d-d577670b279b",
"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": "4906a4f6-0f92-4d5a-981c-3004b1679bd7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d5728cea-5995-479c-94f7-346cbf0ee4e4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1b32f91e-43e4-434d-8dfa-1bee8ecd9ffe",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "74866519-88cf-43fd-ae8b-d150dc4e5773",
"FieldId": "60274bc1-d97c-4362-9253-9ea0dd674644",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "74866519-88cf-43fd-ae8b-d150dc4e5773",
"FieldId": "60274bc1-d97c-4362-9253-9ea0dd674644",
"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": "06b7483f-128c-4787-8d99-d4f329730c89",
"CreateDate": "2026-08-11T22:26:36.6605936-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-11T22:26:36.6605936-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}