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": "56892f98-17b5-4921-a1fa-86b90c055da3",
"Asset": {
"AssetId": "8a60999c-d49e-4948-9b07-53a305c03d91",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "15a29f84-88ef-41c3-a166-9c1ace92e324",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2c686c64-2b96-4da6-a653-838663a928d7",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f311335d-c672-4a49-9bf2-e868187fdd8d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-14T22:52:21.3766752-08:00",
"MeasurementValueNeededDate": "2026-11-14T22:52:21.3766752-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c4a8ea3e-e523-48ad-a123-bc83e9fc1b62",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "22c4b391-2867-4498-9075-e85f8a9e1c3e",
"EffectiveDate": "2026-11-14T22:52:21.3766752-08:00",
"StateType": {
"StateTypeId": "547a4ffd-c744-4e7e-bea8-0a68cb7cc7c4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "15a29f84-88ef-41c3-a166-9c1ace92e324",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2c686c64-2b96-4da6-a653-838663a928d7",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "952636f3-595d-44bb-8fb9-7c3076138624",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "85080da4-ae66-4f94-b6b7-2b7e7596ae98",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "79631c7f-2d6c-465c-b579-a116f28f452d",
"EffectiveDate": "2026-11-14T22:52:21.3766752-08:00",
"StatusType": {
"StatusTypeId": "873c1444-82cc-442c-91a4-9830fa1bd233",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "15a29f84-88ef-41c3-a166-9c1ace92e324",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2c686c64-2b96-4da6-a653-838663a928d7",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "af6f5c72-ed55-43cb-ae7d-c9facb0e6f9c",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3d0f78b9-b6dc-4213-b3af-438ab0b03e6b",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2cfe2b85-eb50-4741-8aab-2077c1bb74fc",
"EffectiveDate": "2026-11-14T22:52:21.3766752-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "6933fd54-2956-4492-bf07-eb44670a761b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9e0bc1ad-fdc4-47d8-a5c0-62b171155821",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e68199bc-491b-41de-bfb7-073094bb4df7",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-14T22:52:21.3766752-08:00",
"MeasurementValueNeededDate": "2026-11-14T22:52:21.3766752-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "763862d1-9e2d-435f-a2f2-848b3ee33ce7",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "10a23d53-6424-45b0-83c3-ae5f866da656",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "15a29f84-88ef-41c3-a166-9c1ace92e324",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2c686c64-2b96-4da6-a653-838663a928d7",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-14T22:52:21.3766752-08:00",
"Fields": [
{
"FormTypeFieldId": "ff02f0c2-d380-4968-a218-61ae6cb3c683",
"Section": {
"FormTypeSectionId": "a425c65f-d67e-42f7-a979-ecdf02f9465b",
"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": "54887c7b-d70f-4a4d-b36f-4ca4da2c4986",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "23d0aeab-a522-4907-b91f-a3a17362637d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2e5bc60a-f275-4d30-8d00-88584ea6b52c",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "68089740-20a3-4f76-9906-36cdcecd0eaf",
"FieldId": "7555b6b9-3d07-4f1b-8efc-3ce217079ec4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "68089740-20a3-4f76-9906-36cdcecd0eaf",
"FieldId": "7555b6b9-3d07-4f1b-8efc-3ce217079ec4",
"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": "ff02f0c2-d380-4968-a218-61ae6cb3c683",
"Section": {
"FormTypeSectionId": "a425c65f-d67e-42f7-a979-ecdf02f9465b",
"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": "54887c7b-d70f-4a4d-b36f-4ca4da2c4986",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "23d0aeab-a522-4907-b91f-a3a17362637d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2e5bc60a-f275-4d30-8d00-88584ea6b52c",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "68089740-20a3-4f76-9906-36cdcecd0eaf",
"FieldId": "7555b6b9-3d07-4f1b-8efc-3ce217079ec4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "68089740-20a3-4f76-9906-36cdcecd0eaf",
"FieldId": "7555b6b9-3d07-4f1b-8efc-3ce217079ec4",
"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": "ef6783d4-935d-431a-9743-febc51b5b169",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-11-14T22:52:21.3766752-08:00",
"Location": "sample string 1",
"TaskId": "8f27e9a0-af3c-4f89-89fa-126a4fd23baf",
"Values": [
{
"FormFieldValueId": "845ad902-fe4f-4ed9-950a-444dd2bb076d",
"FormId": "c23dee6f-9b6c-4cee-8796-a9b7dc934c25",
"FormTypeField": {
"FormTypeFieldId": "ff02f0c2-d380-4968-a218-61ae6cb3c683",
"FormType": {
"FormTypeId": "10a23d53-6424-45b0-83c3-ae5f866da656",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "15a29f84-88ef-41c3-a166-9c1ace92e324",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2c686c64-2b96-4da6-a653-838663a928d7",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-14T22:52:21.3766752-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "ef6783d4-935d-431a-9743-febc51b5b169",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "a425c65f-d67e-42f7-a979-ecdf02f9465b",
"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": "54887c7b-d70f-4a4d-b36f-4ca4da2c4986",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "23d0aeab-a522-4907-b91f-a3a17362637d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2e5bc60a-f275-4d30-8d00-88584ea6b52c",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "68089740-20a3-4f76-9906-36cdcecd0eaf",
"FieldId": "7555b6b9-3d07-4f1b-8efc-3ce217079ec4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "68089740-20a3-4f76-9906-36cdcecd0eaf",
"FieldId": "7555b6b9-3d07-4f1b-8efc-3ce217079ec4",
"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": "845ad902-fe4f-4ed9-950a-444dd2bb076d",
"FormId": "c23dee6f-9b6c-4cee-8796-a9b7dc934c25",
"FormTypeField": {
"FormTypeFieldId": "ff02f0c2-d380-4968-a218-61ae6cb3c683",
"FormType": {
"FormTypeId": "10a23d53-6424-45b0-83c3-ae5f866da656",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "15a29f84-88ef-41c3-a166-9c1ace92e324",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2c686c64-2b96-4da6-a653-838663a928d7",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-14T22:52:21.3766752-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "ef6783d4-935d-431a-9743-febc51b5b169",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "a425c65f-d67e-42f7-a979-ecdf02f9465b",
"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": "54887c7b-d70f-4a4d-b36f-4ca4da2c4986",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "23d0aeab-a522-4907-b91f-a3a17362637d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2e5bc60a-f275-4d30-8d00-88584ea6b52c",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "68089740-20a3-4f76-9906-36cdcecd0eaf",
"FieldId": "7555b6b9-3d07-4f1b-8efc-3ce217079ec4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "68089740-20a3-4f76-9906-36cdcecd0eaf",
"FieldId": "7555b6b9-3d07-4f1b-8efc-3ce217079ec4",
"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": "1000585b-8966-4c37-89f8-0663eeb44c82",
"CreateDate": "2026-11-14T22:52:21.3766752-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-14T22:52:21.3766752-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}