The WebReports API allows external applications to interact with WebReports programmatically.
API calls can be used to retrieve WebReports information, manage users and roles, work with UDFs, publish and assign reports, access completed reports, and perform other WebReports operations.
Use this article as the starting point for the available WebReports API documentation.
Before You Begin
Before using the WebReports API:
- Confirm that WebReports is installed and accessible.
- Confirm that your account has the appropriate API access in WebReports.
- Identify the WebReports server URL that will receive the API requests.
- Review the authentication requirements for the API call you plan to use.
Most API operations require an authenticated connection before additional calls are made.
See:
Establish Connection & Store Cookie
Individual API articles may have additional prerequisites. Review the requirements in the article for the API operation you plan to use.
WebReports API Documentation
The WebReports API documentation is organized by the type of operation being performed.
Establish a Connection
Establish Connection & Store Cookie
Use this API process to authenticate with WebReports, establish the connection, and store the cookie needed for subsequent API calls.
Retrieve WebReports Information
Informational API Calls for WebReports
Use informational API calls to retrieve WebReports information such as:
- User Defined Fields (UDFs)
- Connection Profiles
- Roles
- Users
- Report Assignments
Work with Completed Reports
API Calls for Completed Reports
Use this API to retrieve completed report information for a WebReports user.
Manage Report Assignments
API Calls for Report Assignments in WebReports
Use these API calls to:
- Add report assignments
- Remove report assignments
- Update report assignment categories and descriptions
Publish and Assign Reports
API Calls for Publishing and Assigning Reports (Optional) to WebReports
Use this API to publish a report definition to WebReports and optionally assign the report to the required Connection Profiles and Roles.
Delete Reports
Use this API to delete reports from WebReports.
Manage Users
API Calls for Managing Users (Invite/Delete)
Use these API calls to:
- Invite users
- Delete users
Manage User Roles
API Calls for Managing Users' Roles in WebReports
Use these API calls to:
- Assign roles to users
- Remove roles from users
Manage Roles
API Calls for Managing Roles in WebReports
Use these API calls to add and remove Roles in WebReports.
Manage User UDFs
API Calls for Managing Users UDFs in WebReports
Use these API calls to assign or remove UDF values for WebReports users.
Manage UDFs
API Calls for Managing UDFs in WebReports
Use these API calls to:
- Add UDFs
- Delete UDFs
- Update UDFs
WebReports API URL Calls
WebReports also supports URL-based API calls for executing reports directly from another application or browser.
See:
This documentation includes information for:
- Running Finished Reports
- Running Visualize reports
- Passing report parameters
- Queuing reports
- Exporting completed reports
- Using
WRUseExplicitValue
URL-based report execution is separate from the WebReports management API calls described in the sections above.
Recommended API Workflow
When beginning a WebReports API integration:
- Confirm that the WebReports environment is accessible.
- Confirm that the account has the required API access.
- Establish the authenticated WebReports connection.
- Identify the API operation required for the integration.
- Review the endpoint, request structure, and prerequisites in the appropriate API article.
- Test the API call before incorporating it into a production workflow.
Troubleshooting
API Call Is Not Authorized
- Confirm that the account has the required API access.
- Confirm that authentication completed successfully.
- Verify that the connection or cookie required by the API call is still valid.
API Call Cannot Reach WebReports
- Confirm that the WebReports URL is correct.
- Verify that WebReports is accessible from the application making the request.
- Confirm that the endpoint path is correct.
API Call Returns Unexpected Results
- Review the endpoint and request structure in the API-specific article.
- Confirm that all required values were supplied.
- Verify that identifiers, Roles, Connection Profiles, users, or report names match the values configured in WebReports.
If the issue continues, contact BridgeWorks Support.
Comments
0 comments
Please sign in to leave a comment.