Reading Published Reports Data Using SuiteProjects Pro REST API

Note:

The functionality described in this topic requires the following feature and role permission. For more information about the features enabled for your SuiteProjects Pro account or about your role permissions, contact your account administrator.

Feature: Business Intelligence Connector
Role permission: Publish reports.

You can use the /published-reports/ REST API endpoint to read reports published to the BI Connector from a GUI REST Client such as Postman, for example. Developers can use the /published-reports/ REST API endpoint to read published report data and process the response in their applications.

The following methods are available:

GET /published-reports/ — Use this method to retrieve the list of published reports with general information about each published report in the list. See Get the List of Published Reports.
GET /published-reports/{id} — Use this method to retrieve the data in the published report with the specified internal ID. Get a Published Report.

Note:
The publish status information given when you publish a report manually includes the full REST API endpoint for this published report (with the internal ID {id}).

Guidelines

Review the following guidelines:

Reports must be published with the Business Intelligence Connector scope (publish type) to be available from the /published-reports/ REST API endpoint. See Published Report Scope of Use.
The API Access or REST API add-on services are not required to access the /published-reports/ REST API endpoint. Other REST API endpoints are not available unless API Access and REST API are enabled for your company's SuiteProjects Pro account.
For more information about using the REST API, see the REST API documentation and Getting Started with the REST API.
The OAuth 2.0 authorization code flow must be used to authenticate your requests when connecting to your published report data through the REST API. One advantage of this authentication method is that you can access reports published to the BI Connector whether you sign in to SuiteProjects Pro using a password or single sign-on.

Note:
By contrast, it is only possible to access your published report data through the OData service if you sign in to SuiteProjects Pro using a password.
- You must register the client application with SuiteProjects Pro before you can use the REST API to access BI Connector resources. See Managing API Integration Applications.
- You must used an access token issued for the relevant scope to authenticate your request (the scope must include bi). For more information, see Authentication and OAuth 2.0 Authorization Code Flow.
If API Access is enabled for your account, Accessing published reports using the REST API does not use any of your API request entitlement. It is only subject to BI Connector request frequency limits. Each API call using one of the following methods uses at least one BI Connector request. See BI Connector Request Limits.