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": "f0c3b8dd-0942-47a9-8d64-52fc77c59bcc",
"Asset": {
"AssetId": "1f00865f-743d-4fdd-9be8-bb087d2d3950",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fe51441b-b43b-4233-b32c-6a5d3dd9380e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f39c03b-3428-441e-84a0-ca28dfcebcd9",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e9075076-6d6f-4ec2-8030-6dd59cd97848",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-30T04:49:43.9771769-07:00",
"MeasurementValueNeededDate": "2026-05-30T04:49:43.9771769-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f8c39972-714a-4d66-bb1e-5e613dcdf12e",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b09eb984-2209-41f5-a8b7-487008d9f136",
"EffectiveDate": "2026-05-30T04:49:43.9771769-07:00",
"StateType": {
"StateTypeId": "48f30196-71d5-4d12-89f9-dd45f204e454",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "fe51441b-b43b-4233-b32c-6a5d3dd9380e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f39c03b-3428-441e-84a0-ca28dfcebcd9",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e85f9f6a-5411-4a78-b623-c3e00543820d",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e3df9ade-26b2-4893-a9cd-346f387c582d",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8ee4270c-f5fe-4cb9-97a8-10146a23b1f5",
"EffectiveDate": "2026-05-30T04:49:43.9771769-07:00",
"StatusType": {
"StatusTypeId": "4b8022ec-2569-47a7-8609-864369fe3227",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "fe51441b-b43b-4233-b32c-6a5d3dd9380e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f39c03b-3428-441e-84a0-ca28dfcebcd9",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "90b3c480-4532-435b-b7c7-a3bcb460e3a3",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dcccb93a-a094-4163-b845-c6e759ae2c8b",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e92dc983-4f2d-4904-aa9e-3f6df4a1c9d6",
"EffectiveDate": "2026-05-30T04:49:43.9771769-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "12e09c47-733d-4e92-b949-2fbc02a06d6e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5c9bcf82-373f-4d31-8a8f-40b0e682f0b5",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6050cd62-5e6c-479b-9975-e81881287fff",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-30T04:49:43.9771769-07:00",
"MeasurementValueNeededDate": "2026-05-30T04:49:43.9771769-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "66fd5832-b067-4f72-84ae-37f180d3d9a4",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "60decb67-51b7-4974-bcd8-012e27476f34",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fe51441b-b43b-4233-b32c-6a5d3dd9380e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f39c03b-3428-441e-84a0-ca28dfcebcd9",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-30T04:49:43.9771769-07:00",
"Fields": [
{
"FormTypeFieldId": "10048058-384a-4335-8a0d-5394b8d7a1e1",
"Section": {
"FormTypeSectionId": "9f26859c-a28c-48b4-b8f5-4d1ee0734c68",
"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": "ee3dfd28-3d7f-400c-bb03-38fe2dc49eee",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "48251cb6-d99f-43c8-aefb-a9757d3747a9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea9ed33f-3220-4be8-9a58-f8c62b4d2e7c",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a2f08d3e-e412-4d03-8c0f-8ce8f85a8e4a",
"FieldId": "01bbb121-106c-47ac-b6b2-cd691f6520a2",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a2f08d3e-e412-4d03-8c0f-8ce8f85a8e4a",
"FieldId": "01bbb121-106c-47ac-b6b2-cd691f6520a2",
"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": "10048058-384a-4335-8a0d-5394b8d7a1e1",
"Section": {
"FormTypeSectionId": "9f26859c-a28c-48b4-b8f5-4d1ee0734c68",
"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": "ee3dfd28-3d7f-400c-bb03-38fe2dc49eee",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "48251cb6-d99f-43c8-aefb-a9757d3747a9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea9ed33f-3220-4be8-9a58-f8c62b4d2e7c",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a2f08d3e-e412-4d03-8c0f-8ce8f85a8e4a",
"FieldId": "01bbb121-106c-47ac-b6b2-cd691f6520a2",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a2f08d3e-e412-4d03-8c0f-8ce8f85a8e4a",
"FieldId": "01bbb121-106c-47ac-b6b2-cd691f6520a2",
"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": "9999b447-4235-4652-a2a0-73839f7de672",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-05-30T04:49:43.9771769-07:00",
"Location": "sample string 1",
"TaskId": "a61a689f-4481-407d-88c7-b4ed2a21f934",
"Values": [
{
"FormFieldValueId": "47a298b1-6e1b-45f5-970a-66d2aa5e138c",
"FormId": "54388c82-6bba-4d77-b985-db81239cb6cf",
"FormTypeField": {
"FormTypeFieldId": "10048058-384a-4335-8a0d-5394b8d7a1e1",
"FormType": {
"FormTypeId": "60decb67-51b7-4974-bcd8-012e27476f34",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fe51441b-b43b-4233-b32c-6a5d3dd9380e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f39c03b-3428-441e-84a0-ca28dfcebcd9",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-30T04:49:43.9771769-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "9999b447-4235-4652-a2a0-73839f7de672",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "9f26859c-a28c-48b4-b8f5-4d1ee0734c68",
"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": "ee3dfd28-3d7f-400c-bb03-38fe2dc49eee",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "48251cb6-d99f-43c8-aefb-a9757d3747a9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea9ed33f-3220-4be8-9a58-f8c62b4d2e7c",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a2f08d3e-e412-4d03-8c0f-8ce8f85a8e4a",
"FieldId": "01bbb121-106c-47ac-b6b2-cd691f6520a2",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a2f08d3e-e412-4d03-8c0f-8ce8f85a8e4a",
"FieldId": "01bbb121-106c-47ac-b6b2-cd691f6520a2",
"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": "47a298b1-6e1b-45f5-970a-66d2aa5e138c",
"FormId": "54388c82-6bba-4d77-b985-db81239cb6cf",
"FormTypeField": {
"FormTypeFieldId": "10048058-384a-4335-8a0d-5394b8d7a1e1",
"FormType": {
"FormTypeId": "60decb67-51b7-4974-bcd8-012e27476f34",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fe51441b-b43b-4233-b32c-6a5d3dd9380e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f39c03b-3428-441e-84a0-ca28dfcebcd9",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-30T04:49:43.9771769-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "9999b447-4235-4652-a2a0-73839f7de672",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "9f26859c-a28c-48b4-b8f5-4d1ee0734c68",
"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": "ee3dfd28-3d7f-400c-bb03-38fe2dc49eee",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "48251cb6-d99f-43c8-aefb-a9757d3747a9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea9ed33f-3220-4be8-9a58-f8c62b4d2e7c",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a2f08d3e-e412-4d03-8c0f-8ce8f85a8e4a",
"FieldId": "01bbb121-106c-47ac-b6b2-cd691f6520a2",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a2f08d3e-e412-4d03-8c0f-8ce8f85a8e4a",
"FieldId": "01bbb121-106c-47ac-b6b2-cd691f6520a2",
"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": "c1ab517c-a5a7-4eb3-8a6d-562f1066cf52",
"CreateDate": "2026-05-30T04:49:43.9771769-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-30T04:49:43.9771769-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}