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": "ebd4e95c-bb15-4e1c-8b18-e4949bd8efd6",
"Asset": {
"AssetId": "f75f127f-522a-45a7-b2cb-96d86c2503a0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a4d17613-1a07-45e7-95cf-b0bb15c9d9e1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "14e6386d-3ed3-4b85-8ba8-2e8766bd45d2",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "877fb843-21b5-4689-bd99-175217930e77",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-12T03:29:20.4184045-07:00",
"MeasurementValueNeededDate": "2026-03-12T03:29:20.4184045-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a9f17882-1358-4678-bf52-b1814063a3b4",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "456d5c55-b111-4bfc-8fcf-8d3abcea9756",
"EffectiveDate": "2026-03-12T03:29:20.4184045-07:00",
"StateType": {
"StateTypeId": "411f8335-b631-4541-a538-ea321428a93b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a4d17613-1a07-45e7-95cf-b0bb15c9d9e1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "14e6386d-3ed3-4b85-8ba8-2e8766bd45d2",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "fbf78235-03c4-44df-841f-a11fce115d68",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2abb6aba-8fcc-43fc-bbd6-31512b9bc1d4",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ca259414-235e-4732-bd8b-6ef476c8398c",
"EffectiveDate": "2026-03-12T03:29:20.4184045-07:00",
"StatusType": {
"StatusTypeId": "f3760990-640b-4fd8-ae5f-b911f091990f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a4d17613-1a07-45e7-95cf-b0bb15c9d9e1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "14e6386d-3ed3-4b85-8ba8-2e8766bd45d2",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "2664f671-79c9-40e9-ae1d-2baea157e1ae",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9528e04d-f774-4d33-84b3-75ecf5c3de01",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "3700ecfd-7ea5-4dd8-b88b-b3a94f70d61b",
"EffectiveDate": "2026-03-12T03:29:20.4184045-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d34ebe04-54cf-493f-8c1f-4fe2e9b6a3ee",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1c25ffe8-58b0-4fc9-b3e4-9c0118051ee0",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ffaaca36-3bd3-43d7-8ab5-f8ab21f1e2f6",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-12T03:29:20.4184045-07:00",
"MeasurementValueNeededDate": "2026-03-12T03:29:20.4184045-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a23f78d7-65eb-494a-9e1a-503ab5674bb1",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "25cd45bb-9d59-4eca-b44a-7248e5eb5eed",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a4d17613-1a07-45e7-95cf-b0bb15c9d9e1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "14e6386d-3ed3-4b85-8ba8-2e8766bd45d2",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-12T03:29:20.4184045-07:00",
"Fields": [
{
"FormTypeFieldId": "f3763a99-42cb-4d60-a946-dc360fb29116",
"Section": {
"FormTypeSectionId": "89f7dd9e-cd16-4b12-84a3-6e022df405a2",
"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": "0c67c601-42de-45ae-91d7-c043ceeae92e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c4346d24-2ff8-4e38-8d5d-f494357287e8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1c9c5bb0-1eec-413a-8f51-149518a032b5",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3bafe03b-8ae1-43ec-97c6-126eb7bf86f8",
"FieldId": "0c4a30da-5b2a-49d4-8826-c93d23666bd3",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3bafe03b-8ae1-43ec-97c6-126eb7bf86f8",
"FieldId": "0c4a30da-5b2a-49d4-8826-c93d23666bd3",
"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": "f3763a99-42cb-4d60-a946-dc360fb29116",
"Section": {
"FormTypeSectionId": "89f7dd9e-cd16-4b12-84a3-6e022df405a2",
"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": "0c67c601-42de-45ae-91d7-c043ceeae92e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c4346d24-2ff8-4e38-8d5d-f494357287e8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1c9c5bb0-1eec-413a-8f51-149518a032b5",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3bafe03b-8ae1-43ec-97c6-126eb7bf86f8",
"FieldId": "0c4a30da-5b2a-49d4-8826-c93d23666bd3",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3bafe03b-8ae1-43ec-97c6-126eb7bf86f8",
"FieldId": "0c4a30da-5b2a-49d4-8826-c93d23666bd3",
"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": "f629b179-ee56-4ded-8ee5-bda9c1169bdd",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-03-12T03:29:20.4184045-07:00",
"Location": "sample string 1",
"TaskId": "53706aa0-55fa-4547-bd59-faeec5646719",
"Values": [
{
"FormFieldValueId": "883c685b-441a-4305-9d33-206ca3a1c22d",
"FormId": "ddd21888-f858-4948-98fd-9c6fabb02e61",
"FormTypeField": {
"FormTypeFieldId": "f3763a99-42cb-4d60-a946-dc360fb29116",
"FormType": {
"FormTypeId": "25cd45bb-9d59-4eca-b44a-7248e5eb5eed",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a4d17613-1a07-45e7-95cf-b0bb15c9d9e1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "14e6386d-3ed3-4b85-8ba8-2e8766bd45d2",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-12T03:29:20.4184045-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "f629b179-ee56-4ded-8ee5-bda9c1169bdd",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "89f7dd9e-cd16-4b12-84a3-6e022df405a2",
"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": "0c67c601-42de-45ae-91d7-c043ceeae92e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c4346d24-2ff8-4e38-8d5d-f494357287e8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1c9c5bb0-1eec-413a-8f51-149518a032b5",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3bafe03b-8ae1-43ec-97c6-126eb7bf86f8",
"FieldId": "0c4a30da-5b2a-49d4-8826-c93d23666bd3",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3bafe03b-8ae1-43ec-97c6-126eb7bf86f8",
"FieldId": "0c4a30da-5b2a-49d4-8826-c93d23666bd3",
"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": "883c685b-441a-4305-9d33-206ca3a1c22d",
"FormId": "ddd21888-f858-4948-98fd-9c6fabb02e61",
"FormTypeField": {
"FormTypeFieldId": "f3763a99-42cb-4d60-a946-dc360fb29116",
"FormType": {
"FormTypeId": "25cd45bb-9d59-4eca-b44a-7248e5eb5eed",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a4d17613-1a07-45e7-95cf-b0bb15c9d9e1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "14e6386d-3ed3-4b85-8ba8-2e8766bd45d2",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-12T03:29:20.4184045-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "f629b179-ee56-4ded-8ee5-bda9c1169bdd",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "89f7dd9e-cd16-4b12-84a3-6e022df405a2",
"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": "0c67c601-42de-45ae-91d7-c043ceeae92e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c4346d24-2ff8-4e38-8d5d-f494357287e8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1c9c5bb0-1eec-413a-8f51-149518a032b5",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3bafe03b-8ae1-43ec-97c6-126eb7bf86f8",
"FieldId": "0c4a30da-5b2a-49d4-8826-c93d23666bd3",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3bafe03b-8ae1-43ec-97c6-126eb7bf86f8",
"FieldId": "0c4a30da-5b2a-49d4-8826-c93d23666bd3",
"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": "c0b1e0cb-bfca-4a0f-9e3a-539e2525dc4e",
"CreateDate": "2026-03-12T03:29:20.4184045-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-12T03:29:20.4184045-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}