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": "066ed0a2-aac2-4501-9f32-93a1d7219e36",
"Asset": {
"AssetId": "62d8e5b2-58f7-4a10-b193-c06c2cb9c19a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bec4e51a-6676-42fd-9143-f3361c5d2313",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30fb0dcf-4d20-4cbd-a69a-d8741e9625ed",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "12545675-d35f-4c6d-9a7a-11d2d25b40ff",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-12T15:40:23.8960358-07:00",
"MeasurementValueNeededDate": "2026-09-12T15:40:23.8960358-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "49193331-d204-4234-aa86-4eb7e29d212e",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "aba1cbee-6e78-46d0-8de7-3df379e78afb",
"EffectiveDate": "2026-09-12T15:40:23.8960358-07:00",
"StateType": {
"StateTypeId": "609e7094-759c-4707-82d7-91148d60131d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bec4e51a-6676-42fd-9143-f3361c5d2313",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30fb0dcf-4d20-4cbd-a69a-d8741e9625ed",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c1afcd8e-57d1-4a15-b6cf-dd8e04767a46",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "376b3d4f-285d-4f26-813a-ecbadd898b49",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f8cb0539-5f2a-468f-9d44-27c192f351a7",
"EffectiveDate": "2026-09-12T15:40:23.8960358-07:00",
"StatusType": {
"StatusTypeId": "481fe636-f71f-408d-8f83-427c21c8b6e5",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bec4e51a-6676-42fd-9143-f3361c5d2313",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30fb0dcf-4d20-4cbd-a69a-d8741e9625ed",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "af236c43-3afc-4bd4-9485-0837149cb16d",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3d41ba61-0015-4cc7-9d2e-cc0dbeb83911",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "79b533cd-bd23-4c97-bdfe-45c6dd67da53",
"EffectiveDate": "2026-09-12T15:40:23.8960358-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c85b29b4-9d10-46bc-928b-9c5f3d7985a4",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ef573bfa-b668-434d-8e8f-ff724fa176e3",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1e300828-a154-453e-9a76-b6b98e6f85e7",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-12T15:40:23.8960358-07:00",
"MeasurementValueNeededDate": "2026-09-12T15:40:23.8960358-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "079f26bd-acbb-437a-82d4-954f2799f403",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "521c93cc-563d-4fa9-a812-73339fa38677",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bec4e51a-6676-42fd-9143-f3361c5d2313",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30fb0dcf-4d20-4cbd-a69a-d8741e9625ed",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-12T15:40:23.8960358-07:00",
"Fields": [
{
"FormTypeFieldId": "a29b590c-17ad-49f3-b492-7248e1407a28",
"Section": {
"FormTypeSectionId": "65fd86bc-bed1-4e31-8ea3-f3861c8f7775",
"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": "51c36f9b-7de8-4910-acc9-e1b896bce2c4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "654f633f-be57-4b51-a9d2-cbc502b32d65",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b0ef5fbe-ffda-48ca-8eac-f775a67c6140",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7ed0e6e5-b0b8-4d5e-9f67-c760820e3d99",
"FieldId": "ecd4bc9b-ce68-4aa0-8b62-09814641d431",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7ed0e6e5-b0b8-4d5e-9f67-c760820e3d99",
"FieldId": "ecd4bc9b-ce68-4aa0-8b62-09814641d431",
"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": "a29b590c-17ad-49f3-b492-7248e1407a28",
"Section": {
"FormTypeSectionId": "65fd86bc-bed1-4e31-8ea3-f3861c8f7775",
"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": "51c36f9b-7de8-4910-acc9-e1b896bce2c4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "654f633f-be57-4b51-a9d2-cbc502b32d65",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b0ef5fbe-ffda-48ca-8eac-f775a67c6140",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7ed0e6e5-b0b8-4d5e-9f67-c760820e3d99",
"FieldId": "ecd4bc9b-ce68-4aa0-8b62-09814641d431",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7ed0e6e5-b0b8-4d5e-9f67-c760820e3d99",
"FieldId": "ecd4bc9b-ce68-4aa0-8b62-09814641d431",
"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": "4e3b0d4c-e1bd-4a90-8ed0-8bf2e166d4b0",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-09-12T15:40:23.8960358-07:00",
"Location": "sample string 1",
"TaskId": "3d57532f-4e39-41b2-aa1f-876793f9eaaf",
"Values": [
{
"FormFieldValueId": "e2b90118-a8b6-4499-80f1-ad7c7efc17d8",
"FormId": "6b096f05-dfaa-40fe-8b90-abb11a10909c",
"FormTypeField": {
"FormTypeFieldId": "a29b590c-17ad-49f3-b492-7248e1407a28",
"FormType": {
"FormTypeId": "521c93cc-563d-4fa9-a812-73339fa38677",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bec4e51a-6676-42fd-9143-f3361c5d2313",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30fb0dcf-4d20-4cbd-a69a-d8741e9625ed",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-12T15:40:23.8960358-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "4e3b0d4c-e1bd-4a90-8ed0-8bf2e166d4b0",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "65fd86bc-bed1-4e31-8ea3-f3861c8f7775",
"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": "51c36f9b-7de8-4910-acc9-e1b896bce2c4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "654f633f-be57-4b51-a9d2-cbc502b32d65",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b0ef5fbe-ffda-48ca-8eac-f775a67c6140",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7ed0e6e5-b0b8-4d5e-9f67-c760820e3d99",
"FieldId": "ecd4bc9b-ce68-4aa0-8b62-09814641d431",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7ed0e6e5-b0b8-4d5e-9f67-c760820e3d99",
"FieldId": "ecd4bc9b-ce68-4aa0-8b62-09814641d431",
"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": "e2b90118-a8b6-4499-80f1-ad7c7efc17d8",
"FormId": "6b096f05-dfaa-40fe-8b90-abb11a10909c",
"FormTypeField": {
"FormTypeFieldId": "a29b590c-17ad-49f3-b492-7248e1407a28",
"FormType": {
"FormTypeId": "521c93cc-563d-4fa9-a812-73339fa38677",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bec4e51a-6676-42fd-9143-f3361c5d2313",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30fb0dcf-4d20-4cbd-a69a-d8741e9625ed",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-12T15:40:23.8960358-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "4e3b0d4c-e1bd-4a90-8ed0-8bf2e166d4b0",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "65fd86bc-bed1-4e31-8ea3-f3861c8f7775",
"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": "51c36f9b-7de8-4910-acc9-e1b896bce2c4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "654f633f-be57-4b51-a9d2-cbc502b32d65",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b0ef5fbe-ffda-48ca-8eac-f775a67c6140",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7ed0e6e5-b0b8-4d5e-9f67-c760820e3d99",
"FieldId": "ecd4bc9b-ce68-4aa0-8b62-09814641d431",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7ed0e6e5-b0b8-4d5e-9f67-c760820e3d99",
"FieldId": "ecd4bc9b-ce68-4aa0-8b62-09814641d431",
"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": "7633ca99-9105-42cd-aa9a-ba11fd339473",
"CreateDate": "2026-09-12T15:40:23.8960358-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-12T15:40:23.8960358-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}