Trouble seeing the images? Right click on images and open in new tab to enlarge or zoom in on the page (Ctrl + mousewheel).

In this article we provide the information for the available types of API calls and their uses.

Why Use API Calls?

API calls will allow users with the API role to manage Defined Fields (UDFs), Users, Roles and Reports within WebReports.

Types of API Calls

- API Calls for Publishing and Assigning Reports to WebReports

• Publishing a report is the process of moving a report's definition to the WebReports environment.
• Assigning a report is the process of granting a published report access to a Role(s) for defined Connection Profile(s), Report Type(s) and Number of Expiration Day(s).

- API Calls for Report Assignments

• Add Assignments
• Remove Assignments
• Update Report Assignments (Description / Category)

- API Call for Deleting Reports

• Delete Reports

- API Calls for Managing Users

• Invite Users
• Delete Users

- API Calls for Managing Roles in WebReports

• Add Role
• Delete Role

- API Calls for Managing Users' Roles in WebReports

• Assigning roles to users
• Removing roles from users

- API Calls for Managing UDFs in WebReports

• Add UDFs
• Delete UDFs
• Update UDFs

- API Calls for Managing Users' UDFs in WebReports

• Set UDFs
• Remove UDFs

- Informational API Calls for WebReports

• Get UDFs
• Get Connections
• Get Roles
• Get Users List
• Get Assignments