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": "5b98036c-1488-4906-8afb-3d3fe17201b9",
"Asset": {
"AssetId": "e11380ae-fa1a-45e0-927e-89ce34ce6543",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bb07d1bb-daa8-40a4-aa11-226a1aa5fe0a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25932180-18e9-4729-b060-e69ca0575925",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "cd96f0d6-306e-46d1-be76-f6a95094e606",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-10T21:54:08.6730522-07:00",
"MeasurementValueNeededDate": "2026-10-10T21:54:08.6730522-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "47799917-23a7-4c1d-9f41-c39414c2f5f3",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "056fab0b-7887-4fba-81bc-b04aaa6db54f",
"EffectiveDate": "2026-10-10T21:54:08.6730522-07:00",
"StateType": {
"StateTypeId": "0260f8ea-55ba-4b0d-8420-53d013989ebc",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bb07d1bb-daa8-40a4-aa11-226a1aa5fe0a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25932180-18e9-4729-b060-e69ca0575925",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "088706f0-d558-494e-ae94-3183bfae3ae2",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "06faca32-777a-4f08-b34a-a458a72adc7f",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "768f8158-644d-4d19-a999-313744c86a13",
"EffectiveDate": "2026-10-10T21:54:08.6730522-07:00",
"StatusType": {
"StatusTypeId": "4868b3e1-fe3f-4469-87a4-fc94df3bb024",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bb07d1bb-daa8-40a4-aa11-226a1aa5fe0a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25932180-18e9-4729-b060-e69ca0575925",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "04e62fb0-e462-49a2-b2bf-1b8928cf952a",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2d683d50-6a32-4405-ae6c-9863b55c034f",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9700de2f-3736-4701-adf2-8f6a20e548e0",
"EffectiveDate": "2026-10-10T21:54:08.6730522-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "700e4901-393c-4ba2-84fe-a98cc2177408",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a7251314-ad5a-4b91-ba51-e57a1c86b50d",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "92dde926-f4f2-4f91-8294-16fdaf2cef73",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-10T21:54:08.6730522-07:00",
"MeasurementValueNeededDate": "2026-10-10T21:54:08.6730522-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6974a1cd-a43a-4d48-be33-b48a50b9040d",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "dd8712d6-ee23-448d-bfe1-b441f47d8ad5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bb07d1bb-daa8-40a4-aa11-226a1aa5fe0a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25932180-18e9-4729-b060-e69ca0575925",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-10T21:54:08.6730522-07:00",
"Fields": [
{
"FormTypeFieldId": "d2ec3501-ed81-4147-ba04-e39b9e8fc2a9",
"Section": {
"FormTypeSectionId": "f8dd8b91-6fe6-4167-adb4-4dc45d126652",
"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": "b9dada06-aa53-479e-85b6-8ab9fe3b98ef",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e1571b9a-c66e-4d58-9c42-0fbfbfc0fb00",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6fafd0b2-b8cb-4609-b380-733eae3a404b",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "965e3fe8-fba7-46c8-8f76-931c1519d62c",
"FieldId": "6b53fe27-65fd-44b5-9ca6-05efcb13076d",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "965e3fe8-fba7-46c8-8f76-931c1519d62c",
"FieldId": "6b53fe27-65fd-44b5-9ca6-05efcb13076d",
"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": "d2ec3501-ed81-4147-ba04-e39b9e8fc2a9",
"Section": {
"FormTypeSectionId": "f8dd8b91-6fe6-4167-adb4-4dc45d126652",
"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": "b9dada06-aa53-479e-85b6-8ab9fe3b98ef",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e1571b9a-c66e-4d58-9c42-0fbfbfc0fb00",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6fafd0b2-b8cb-4609-b380-733eae3a404b",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "965e3fe8-fba7-46c8-8f76-931c1519d62c",
"FieldId": "6b53fe27-65fd-44b5-9ca6-05efcb13076d",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "965e3fe8-fba7-46c8-8f76-931c1519d62c",
"FieldId": "6b53fe27-65fd-44b5-9ca6-05efcb13076d",
"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": "5f292f31-41a1-40db-9809-71b06cd909b3",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-10-10T21:54:08.6730522-07:00",
"Location": "sample string 1",
"TaskId": "23cdda51-08ce-47cc-ad96-7b0bd986b0b2",
"Values": [
{
"FormFieldValueId": "fbf0dddb-9f4a-4fc3-93b6-053a8afdc314",
"FormId": "3e738ba3-b674-495f-af5c-946babd47139",
"FormTypeField": {
"FormTypeFieldId": "d2ec3501-ed81-4147-ba04-e39b9e8fc2a9",
"FormType": {
"FormTypeId": "dd8712d6-ee23-448d-bfe1-b441f47d8ad5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bb07d1bb-daa8-40a4-aa11-226a1aa5fe0a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25932180-18e9-4729-b060-e69ca0575925",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-10T21:54:08.6730522-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "5f292f31-41a1-40db-9809-71b06cd909b3",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "f8dd8b91-6fe6-4167-adb4-4dc45d126652",
"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": "b9dada06-aa53-479e-85b6-8ab9fe3b98ef",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e1571b9a-c66e-4d58-9c42-0fbfbfc0fb00",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6fafd0b2-b8cb-4609-b380-733eae3a404b",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "965e3fe8-fba7-46c8-8f76-931c1519d62c",
"FieldId": "6b53fe27-65fd-44b5-9ca6-05efcb13076d",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "965e3fe8-fba7-46c8-8f76-931c1519d62c",
"FieldId": "6b53fe27-65fd-44b5-9ca6-05efcb13076d",
"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": "fbf0dddb-9f4a-4fc3-93b6-053a8afdc314",
"FormId": "3e738ba3-b674-495f-af5c-946babd47139",
"FormTypeField": {
"FormTypeFieldId": "d2ec3501-ed81-4147-ba04-e39b9e8fc2a9",
"FormType": {
"FormTypeId": "dd8712d6-ee23-448d-bfe1-b441f47d8ad5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bb07d1bb-daa8-40a4-aa11-226a1aa5fe0a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25932180-18e9-4729-b060-e69ca0575925",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-10T21:54:08.6730522-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "5f292f31-41a1-40db-9809-71b06cd909b3",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "f8dd8b91-6fe6-4167-adb4-4dc45d126652",
"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": "b9dada06-aa53-479e-85b6-8ab9fe3b98ef",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e1571b9a-c66e-4d58-9c42-0fbfbfc0fb00",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6fafd0b2-b8cb-4609-b380-733eae3a404b",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "965e3fe8-fba7-46c8-8f76-931c1519d62c",
"FieldId": "6b53fe27-65fd-44b5-9ca6-05efcb13076d",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "965e3fe8-fba7-46c8-8f76-931c1519d62c",
"FieldId": "6b53fe27-65fd-44b5-9ca6-05efcb13076d",
"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": "beec48a1-71d3-4dc1-b95d-aae41cf74e3e",
"CreateDate": "2026-10-10T21:54:08.6730522-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-10T21:54:08.6730522-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}