How to Retrieve a Dynamics 365 Report GUID Using the Web API

 In Microsoft Dynamics 365, reports play a crucial role in visualizing and summarizing business data. Sometimes, you may need to programmatically access these reports, for instance, to integrate report links into custom user interfaces or automated workflows. This article guides you through the process of retrieving a report GUID (Globally Unique Identifier) using the Dynamics 365 Web API, which is essential for any automation or integration task involving reports.

Prerequisites

• Access to a Dynamics 365 environment
• Appropriate permissions to query the Report entity
• Basic understanding of JavaScript and web APIs

Step-by-Step Guide

Here’s how you can retrieve the exact report GUID by matching the report name using the Dynamics 365 Web API:

1. Open your Dynamics 365 environment in a web browser.

2. Access the Developer Tools in your browser (usually accessible via F12 key or right-clicking on the page and selecting "Inspect").

3. Navigate to the Console tab in the Developer Tools.

4. Implement the JavaScript function:

async function getExactReportGUID(reportName) {

    var baseUrl = Xrm.Utility.getGlobalContext().getClientUrl();

    var query = `/api/data/v9.0/reports?$select=reportid,name&$filter=name eq '${reportName}'`;

    try {

        var reportResponse = await fetch(baseUrl + query, {

            method: "GET",

            headers: {

                "Accept": "application/json",

                "Content-Type": "application/json; charset=utf-8",

                "OData-MaxVersion": "4.0",

                "OData-Version": "4.0"

            }

        });

        var reportData = await reportResponse.json();

        if (reportData.value && reportData.value.length > 0) {

            var reportId = reportData.value[0].reportid;

            var reportName = reportData.value[0].name;

            console.log("Exact Report Name: " + reportName + " | Report GUID: " + reportId);

            return reportId;

        } else {

            console.log("No report found with the exact name: " + reportName);

        }

    } catch (error) {

        console.error("Error fetching report data: ", error);

    }

}

5. Run the function by calling it with the exact name of the report:

getExactReportGUID("Order"); // Replace "Order" with the exact name of the report

Test Result:

This function searches for a report by its exact name and logs the name and GUID to the console. You can use this GUID to access the report directly via URL or integrate it into your custom applications or workflows.

Conclusion

Retrieving a report GUID via the Web API is a powerful capability in Dynamics 365 that enables advanced integrations and customizations. By following the steps outlined above, you can seamlessly integrate Dynamics 365 reports into your applications, enhancing the automation capabilities of your system.