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": "4a991a27-bdf6-4665-936e-ac49ca1f1750", "Asset": { "AssetId": "41965a1b-e958-4212-b2cd-d78184282a90", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7312df82-d2bb-4378-838d-e2d359a8e753", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3a31c874-6991-436f-9388-e3b17631bffe", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "46eebe04-29e5-42d4-91a8-a7ba7c5e551a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T15:22:17.0640815-07:00", "MeasurementValueNeededDate": "2025-06-30T15:22:17.0640815-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e9bbf63d-9097-46d8-bd48-2d681a5901c2", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "0270a728-f3c6-438c-b57b-89a2a93d8602", "EffectiveDate": "2025-06-30T15:22:17.0640815-07:00", "StateType": { "StateTypeId": "ff94fd76-4469-4b5f-86a6-2e812493b658", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "7312df82-d2bb-4378-838d-e2d359a8e753", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3a31c874-6991-436f-9388-e3b17631bffe", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "66b1ec74-38dc-4fc6-adf1-976d36f631d5", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "ac2a0230-b42c-4e9e-958b-fcd022090a6f", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "e89e6374-4513-404a-a8e6-f3c56c428604", "EffectiveDate": "2025-06-30T15:22:17.0640815-07:00", "StatusType": { "StatusTypeId": "a7317029-c3fd-4b51-aae0-192f27a14c8c", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "7312df82-d2bb-4378-838d-e2d359a8e753", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3a31c874-6991-436f-9388-e3b17631bffe", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "d206474e-77cb-47b4-b4b2-48dfae0842df", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "612d9f67-6ed4-4e0f-9e94-53a8f1095dd8", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "702d22eb-241e-43c1-a1ca-51321e00d7b5", "EffectiveDate": "2025-06-30T15:22:17.0640815-07:00", "WellPurposeType": { "WellPurposeTypeId": "8250a22f-21fd-46f1-b513-f80bebd76b9f", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b566753e-28fb-4c79-bca0-7ca941e38f39", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "e9cc2869-978c-4e22-90c6-36a410b079c3", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-30T15:22:17.0640815-07:00", "MeasurementValueNeededDate": "2025-06-30T15:22:17.0640815-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "9e6a5cec-9f08-4eb2-9997-dc7d8f732256", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "69642bbc-0cd8-4de1-b97d-bbef25b4a555", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7312df82-d2bb-4378-838d-e2d359a8e753", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3a31c874-6991-436f-9388-e3b17631bffe", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-30T15:22:17.0640815-07:00", "Fields": [ { "FormTypeFieldId": "4f844f15-2d02-4b51-9513-aea8323211cd", "Section": { "FormTypeSectionId": "b990407f-f86a-42a0-bbf9-da8563687403", "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": "74286732-9889-4b43-8039-aa9a5d6b8190", "Name": "sample string 1" }, "Unit": { "UnitId": "a9820c31-331b-4528-8be9-a7d3d405b1f0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e6f4655c-6df2-44b7-bd61-e4f90accc911", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "4c84c5a3-1ee3-49ae-96c4-1be0985079e2", "FieldId": "4151bfbb-90dd-4665-862b-6b2a4a1ff7f3", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "4c84c5a3-1ee3-49ae-96c4-1be0985079e2", "FieldId": "4151bfbb-90dd-4665-862b-6b2a4a1ff7f3", "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": "4f844f15-2d02-4b51-9513-aea8323211cd", "Section": { "FormTypeSectionId": "b990407f-f86a-42a0-bbf9-da8563687403", "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": "74286732-9889-4b43-8039-aa9a5d6b8190", "Name": "sample string 1" }, "Unit": { "UnitId": "a9820c31-331b-4528-8be9-a7d3d405b1f0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e6f4655c-6df2-44b7-bd61-e4f90accc911", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "4c84c5a3-1ee3-49ae-96c4-1be0985079e2", "FieldId": "4151bfbb-90dd-4665-862b-6b2a4a1ff7f3", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "4c84c5a3-1ee3-49ae-96c4-1be0985079e2", "FieldId": "4151bfbb-90dd-4665-862b-6b2a4a1ff7f3", "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": "3251d252-47d8-4e13-8f79-4ab2ce4fddb7", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-30T15:22:17.0640815-07:00", "Location": "sample string 1", "TaskId": "a2892227-9344-42ee-9751-0c4cbdfef619", "Values": [ { "FormFieldValueId": "3d74682f-f031-439d-ad62-42d030e5eeb7", "FormId": "27069a66-7660-4493-bf63-66fa37d858d9", "FormTypeField": { "FormTypeFieldId": "4f844f15-2d02-4b51-9513-aea8323211cd", "FormType": { "FormTypeId": "69642bbc-0cd8-4de1-b97d-bbef25b4a555", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7312df82-d2bb-4378-838d-e2d359a8e753", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3a31c874-6991-436f-9388-e3b17631bffe", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-30T15:22:17.0640815-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "3251d252-47d8-4e13-8f79-4ab2ce4fddb7", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "b990407f-f86a-42a0-bbf9-da8563687403", "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": "74286732-9889-4b43-8039-aa9a5d6b8190", "Name": "sample string 1" }, "Unit": { "UnitId": "a9820c31-331b-4528-8be9-a7d3d405b1f0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e6f4655c-6df2-44b7-bd61-e4f90accc911", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "4c84c5a3-1ee3-49ae-96c4-1be0985079e2", "FieldId": "4151bfbb-90dd-4665-862b-6b2a4a1ff7f3", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "4c84c5a3-1ee3-49ae-96c4-1be0985079e2", "FieldId": "4151bfbb-90dd-4665-862b-6b2a4a1ff7f3", "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": "3d74682f-f031-439d-ad62-42d030e5eeb7", "FormId": "27069a66-7660-4493-bf63-66fa37d858d9", "FormTypeField": { "FormTypeFieldId": "4f844f15-2d02-4b51-9513-aea8323211cd", "FormType": { "FormTypeId": "69642bbc-0cd8-4de1-b97d-bbef25b4a555", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7312df82-d2bb-4378-838d-e2d359a8e753", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3a31c874-6991-436f-9388-e3b17631bffe", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-30T15:22:17.0640815-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "3251d252-47d8-4e13-8f79-4ab2ce4fddb7", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "b990407f-f86a-42a0-bbf9-da8563687403", "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": "74286732-9889-4b43-8039-aa9a5d6b8190", "Name": "sample string 1" }, "Unit": { "UnitId": "a9820c31-331b-4528-8be9-a7d3d405b1f0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e6f4655c-6df2-44b7-bd61-e4f90accc911", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "4c84c5a3-1ee3-49ae-96c4-1be0985079e2", "FieldId": "4151bfbb-90dd-4665-862b-6b2a4a1ff7f3", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "4c84c5a3-1ee3-49ae-96c4-1be0985079e2", "FieldId": "4151bfbb-90dd-4665-862b-6b2a4a1ff7f3", "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": "cd1e6851-520a-46de-931b-f526ed35d491", "CreateDate": "2025-06-30T15:22:17.0640815-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-30T15:22:17.0640815-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }