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": "4361c822-d8ec-4a2a-8230-240adbb9bcac",
"Asset": {
"AssetId": "f9696ab4-f31e-4ea0-8796-eab335d8a85b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2182da1e-447a-4f70-811a-de1c422d10ba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1bbd84d-5279-4f6b-a6ac-bf5e51a8963c",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d45d9a83-b16f-4d55-a5b8-b7ea2c289745",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-29T22:04:00.2668456-07:00",
"MeasurementValueNeededDate": "2026-04-29T22:04:00.2668456-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6ed909c7-0385-4ea3-a666-96482da62663",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "57184d7a-60a1-4b0e-aa0b-735eab80c013",
"EffectiveDate": "2026-04-29T22:04:00.2668456-07:00",
"StateType": {
"StateTypeId": "dd89f960-38b2-4a02-8c89-ea961bc23095",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2182da1e-447a-4f70-811a-de1c422d10ba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1bbd84d-5279-4f6b-a6ac-bf5e51a8963c",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "454d189f-f062-42e3-ad64-8716fec4e277",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "34c1f27c-13f6-4a8b-97b2-d2320f70c332",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "61b953e9-e016-4886-8f17-d928e2fe8e57",
"EffectiveDate": "2026-04-29T22:04:00.2668456-07:00",
"StatusType": {
"StatusTypeId": "4cb2cdfe-3e89-4bd7-b449-8bf6c6e719d4",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2182da1e-447a-4f70-811a-de1c422d10ba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1bbd84d-5279-4f6b-a6ac-bf5e51a8963c",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3ca732e1-ac52-4cd0-a520-b649fd8138e0",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "aaf47b2a-5e94-4378-b441-bf84be7b0b99",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "31dc67bf-3a38-43e0-bcf1-2477c3d61435",
"EffectiveDate": "2026-04-29T22:04:00.2668456-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "077c4fbf-f03c-44c6-8aad-69eca75bdc58",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b56209f8-32a7-41a3-993b-0bced737db5c",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f7b8b5fe-bf35-4eb4-8f6e-fbbdd76b3d33",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-29T22:04:00.2668456-07:00",
"MeasurementValueNeededDate": "2026-04-29T22:04:00.2668456-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c67b1de2-66cf-44b9-971b-3306d177be37",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "0d94a527-eb83-483f-9ae5-effba603d582",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2182da1e-447a-4f70-811a-de1c422d10ba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1bbd84d-5279-4f6b-a6ac-bf5e51a8963c",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-29T22:04:00.2668456-07:00",
"Fields": [
{
"FormTypeFieldId": "1637bf3e-bd1c-40b9-bb93-ead51a76fa72",
"Section": {
"FormTypeSectionId": "d2c45a56-a725-433a-ae07-e6eecd3e4f29",
"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": "7e91ea2f-ee87-4765-9255-905de8eafe5b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "378f0e26-be79-44a4-a95c-59adfecca98c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d41f98a6-b5d2-4b8e-bf3d-138cf01db59a",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fcbafc47-a558-4ba9-8b1d-dd4b533fdd06",
"FieldId": "758f81aa-4e01-4037-bcb2-ce2c002292c2",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fcbafc47-a558-4ba9-8b1d-dd4b533fdd06",
"FieldId": "758f81aa-4e01-4037-bcb2-ce2c002292c2",
"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": "1637bf3e-bd1c-40b9-bb93-ead51a76fa72",
"Section": {
"FormTypeSectionId": "d2c45a56-a725-433a-ae07-e6eecd3e4f29",
"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": "7e91ea2f-ee87-4765-9255-905de8eafe5b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "378f0e26-be79-44a4-a95c-59adfecca98c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d41f98a6-b5d2-4b8e-bf3d-138cf01db59a",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fcbafc47-a558-4ba9-8b1d-dd4b533fdd06",
"FieldId": "758f81aa-4e01-4037-bcb2-ce2c002292c2",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fcbafc47-a558-4ba9-8b1d-dd4b533fdd06",
"FieldId": "758f81aa-4e01-4037-bcb2-ce2c002292c2",
"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": "6eec22ed-d393-438b-bb7a-317a17515ea0",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-04-29T22:04:00.2668456-07:00",
"Location": "sample string 1",
"TaskId": "9e1c3297-1dd5-487f-9860-f02c3da58f5f",
"Values": [
{
"FormFieldValueId": "44243459-ef46-41cf-a442-d90ac70e07bf",
"FormId": "4ff13f75-4abe-4437-aefc-ab850624350d",
"FormTypeField": {
"FormTypeFieldId": "1637bf3e-bd1c-40b9-bb93-ead51a76fa72",
"FormType": {
"FormTypeId": "0d94a527-eb83-483f-9ae5-effba603d582",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2182da1e-447a-4f70-811a-de1c422d10ba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1bbd84d-5279-4f6b-a6ac-bf5e51a8963c",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-29T22:04:00.2668456-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "6eec22ed-d393-438b-bb7a-317a17515ea0",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "d2c45a56-a725-433a-ae07-e6eecd3e4f29",
"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": "7e91ea2f-ee87-4765-9255-905de8eafe5b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "378f0e26-be79-44a4-a95c-59adfecca98c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d41f98a6-b5d2-4b8e-bf3d-138cf01db59a",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fcbafc47-a558-4ba9-8b1d-dd4b533fdd06",
"FieldId": "758f81aa-4e01-4037-bcb2-ce2c002292c2",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fcbafc47-a558-4ba9-8b1d-dd4b533fdd06",
"FieldId": "758f81aa-4e01-4037-bcb2-ce2c002292c2",
"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": "44243459-ef46-41cf-a442-d90ac70e07bf",
"FormId": "4ff13f75-4abe-4437-aefc-ab850624350d",
"FormTypeField": {
"FormTypeFieldId": "1637bf3e-bd1c-40b9-bb93-ead51a76fa72",
"FormType": {
"FormTypeId": "0d94a527-eb83-483f-9ae5-effba603d582",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2182da1e-447a-4f70-811a-de1c422d10ba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1bbd84d-5279-4f6b-a6ac-bf5e51a8963c",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-29T22:04:00.2668456-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "6eec22ed-d393-438b-bb7a-317a17515ea0",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "d2c45a56-a725-433a-ae07-e6eecd3e4f29",
"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": "7e91ea2f-ee87-4765-9255-905de8eafe5b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "378f0e26-be79-44a4-a95c-59adfecca98c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d41f98a6-b5d2-4b8e-bf3d-138cf01db59a",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fcbafc47-a558-4ba9-8b1d-dd4b533fdd06",
"FieldId": "758f81aa-4e01-4037-bcb2-ce2c002292c2",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fcbafc47-a558-4ba9-8b1d-dd4b533fdd06",
"FieldId": "758f81aa-4e01-4037-bcb2-ce2c002292c2",
"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": "0c1665e7-5009-4819-b21f-4f72bfe09233",
"CreateDate": "2026-04-29T22:04:00.2668456-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-29T22:04:00.2668456-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}