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": "e1bba136-50fd-4426-88d8-2d54c1da40be", "Asset": { "AssetId": "2992c359-9941-43aa-a581-29cacb592985", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "70e25c60-ef53-43ba-ae89-75d4f0ce6926", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b336c44f-5bc0-49fe-90a6-54a92988a6a6", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "91fabc9d-328c-4ff2-b72f-34730001c992", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T15:19:35.544825-07:00", "MeasurementValueNeededDate": "2025-10-13T15:19:35.544825-07:00", "SourceSystemId": "sample string 3", "CompanyId": "64124ef6-929e-4798-8dca-c20b9b349979", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "ae847827-3059-4d5b-bb29-0310a85d33d8", "EffectiveDate": "2025-10-13T15:19:35.544825-07:00", "StateType": { "StateTypeId": "7a9462fe-4842-41a4-b196-5b7b0ab05e4c", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "70e25c60-ef53-43ba-ae89-75d4f0ce6926", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b336c44f-5bc0-49fe-90a6-54a92988a6a6", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "97e98dab-8ded-4d7f-b392-177edec051cd", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "01ce47fe-4688-4c17-9152-709f97734860", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "13cbc983-9fe6-45f6-97a5-a8c74aa3ac66", "EffectiveDate": "2025-10-13T15:19:35.544825-07:00", "StatusType": { "StatusTypeId": "6f2a569d-36a7-4683-a7bd-7547d1d57fa2", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "70e25c60-ef53-43ba-ae89-75d4f0ce6926", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b336c44f-5bc0-49fe-90a6-54a92988a6a6", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "48512408-4048-42b6-8f5e-f30c505d0e56", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "b473e218-ddd7-458b-837d-5e312d6ab410", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "5ba5a69c-2350-4e45-8739-6669b45d3088", "EffectiveDate": "2025-10-13T15:19:35.544825-07:00", "WellPurposeType": { "WellPurposeTypeId": "da825278-1f0d-4f9e-8a25-6060eceb7300", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b0f754d5-2389-46d6-afde-d4c84f485d20", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "cc23d46a-4c7a-472c-beaa-3e32585192e4", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-10-13T15:19:35.544825-07:00", "MeasurementValueNeededDate": "2025-10-13T15:19:35.544825-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "626dbc56-dad4-4597-977d-c30d28d81b5e", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "a131a61e-c440-4512-a4a2-12586d35603a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "70e25c60-ef53-43ba-ae89-75d4f0ce6926", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b336c44f-5bc0-49fe-90a6-54a92988a6a6", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T15:19:35.544825-07:00", "Fields": [ { "FormTypeFieldId": "48303e41-ba87-48b0-bf52-b4d2ac6f7fe1", "Section": { "FormTypeSectionId": "01133a1e-618c-41a6-8d14-05e889c5b472", "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": "4dd312bf-0dfd-4aac-bbff-040c1af1aba0", "Name": "sample string 1" }, "Unit": { "UnitId": "6ab4ee92-fc15-40ea-b248-bf3328120fb4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "27d8c745-98f4-4deb-9f51-e55d350ecd07", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "eae82508-4b31-4a61-8e3e-826c5d2b6872", "FieldId": "7e6dae3c-5aa2-4d20-b1ec-66aee2821180", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "eae82508-4b31-4a61-8e3e-826c5d2b6872", "FieldId": "7e6dae3c-5aa2-4d20-b1ec-66aee2821180", "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": "48303e41-ba87-48b0-bf52-b4d2ac6f7fe1", "Section": { "FormTypeSectionId": "01133a1e-618c-41a6-8d14-05e889c5b472", "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": "4dd312bf-0dfd-4aac-bbff-040c1af1aba0", "Name": "sample string 1" }, "Unit": { "UnitId": "6ab4ee92-fc15-40ea-b248-bf3328120fb4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "27d8c745-98f4-4deb-9f51-e55d350ecd07", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "eae82508-4b31-4a61-8e3e-826c5d2b6872", "FieldId": "7e6dae3c-5aa2-4d20-b1ec-66aee2821180", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "eae82508-4b31-4a61-8e3e-826c5d2b6872", "FieldId": "7e6dae3c-5aa2-4d20-b1ec-66aee2821180", "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": "fb82cd14-107c-423b-afd5-80751f1fccc2", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-10-13T15:19:35.544825-07:00", "Location": "sample string 1", "TaskId": "d5a4d6d2-acb6-44bb-8874-c5b5248bf787", "Values": [ { "FormFieldValueId": "b8667fc3-a00e-41e9-b8e4-d2dad068faeb", "FormId": "1c0b13d2-6c3b-404c-a0ee-b15fc58f87e5", "FormTypeField": { "FormTypeFieldId": "48303e41-ba87-48b0-bf52-b4d2ac6f7fe1", "FormType": { "FormTypeId": "a131a61e-c440-4512-a4a2-12586d35603a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "70e25c60-ef53-43ba-ae89-75d4f0ce6926", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b336c44f-5bc0-49fe-90a6-54a92988a6a6", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T15:19:35.544825-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "fb82cd14-107c-423b-afd5-80751f1fccc2", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "01133a1e-618c-41a6-8d14-05e889c5b472", "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": "4dd312bf-0dfd-4aac-bbff-040c1af1aba0", "Name": "sample string 1" }, "Unit": { "UnitId": "6ab4ee92-fc15-40ea-b248-bf3328120fb4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "27d8c745-98f4-4deb-9f51-e55d350ecd07", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "eae82508-4b31-4a61-8e3e-826c5d2b6872", "FieldId": "7e6dae3c-5aa2-4d20-b1ec-66aee2821180", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "eae82508-4b31-4a61-8e3e-826c5d2b6872", "FieldId": "7e6dae3c-5aa2-4d20-b1ec-66aee2821180", "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": "b8667fc3-a00e-41e9-b8e4-d2dad068faeb", "FormId": "1c0b13d2-6c3b-404c-a0ee-b15fc58f87e5", "FormTypeField": { "FormTypeFieldId": "48303e41-ba87-48b0-bf52-b4d2ac6f7fe1", "FormType": { "FormTypeId": "a131a61e-c440-4512-a4a2-12586d35603a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "70e25c60-ef53-43ba-ae89-75d4f0ce6926", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b336c44f-5bc0-49fe-90a6-54a92988a6a6", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T15:19:35.544825-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "fb82cd14-107c-423b-afd5-80751f1fccc2", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "01133a1e-618c-41a6-8d14-05e889c5b472", "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": "4dd312bf-0dfd-4aac-bbff-040c1af1aba0", "Name": "sample string 1" }, "Unit": { "UnitId": "6ab4ee92-fc15-40ea-b248-bf3328120fb4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "27d8c745-98f4-4deb-9f51-e55d350ecd07", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "eae82508-4b31-4a61-8e3e-826c5d2b6872", "FieldId": "7e6dae3c-5aa2-4d20-b1ec-66aee2821180", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "eae82508-4b31-4a61-8e3e-826c5d2b6872", "FieldId": "7e6dae3c-5aa2-4d20-b1ec-66aee2821180", "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": "7d99c016-bada-4127-b970-1c54c88a5c7b", "CreateDate": "2025-10-13T15:19:35.544825-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-10-13T15:19:35.544825-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }