Views (API Integration)

View Reports are specially designed for seamless API integration, allowing for the retrieval of records with a selected subset of fields.

This unique feature ensures that View Reports do not overlap or interfere with other reports in your workspace, maintaining a clean and organized reporting environment.

• Adding a View
• Basic Configuration
• View Fields
• Filtering
• Example

Adding A View

• Access the 'Reports' section within AppStudio.
• Select 'Add Report' located at the bottom of the page to initiate the creation process.

• On the report selection page, look for the 'View' option. You can either directly click on 'Create' next to it or use the 'Filter Types' option to search and select 'View'.

• Following selection, you'll be presented with various Report configuration settings to tailor your View.

Basic Configuration

To see more on the Basic Information, please click here

View Fields

• Selection of View Fields: Choose the fields to be included in your View Report. These are the fields that will be returned when making an API request for the View Report.

Make sure to click the 'Save' button when making any changes in order for the changes to be added to the next app version. Once you have made all the changes you need to an application you are then ready to publish it to workspace.

Filtering Records

In order to restrict the records sent via the view, you can use the query header parameter to add a filter. See the developer.osftools.net details for calling the API to allow filtering via the query string.

The documentation states the following

Provide an oData filter string to filter records by. In the form [fieldIdentifier] operation filterValue Example [textField] eq 'Text'

Operators allowed Eq Equal /Suppliers?$filter=[City] eq 'Redmond' Ne Not equal /Suppliers?$filter=[City] ne 'London' Gt Greater than /Products?$filter=[Price] gt 20 Ge Greater than or equal /Products?$filter=[Price] ge 10 Lt Less than /Products?$filter=[Price] lt 20 Le Less than or equal /Products?$filter=[Price] le 100 And Logical and /Products?$filter=[Price] le 200 and Price gt 3.5

Example

The integration of View Reports into your API requests not only streamlines operations but also optimizes response times by limiting the data load to only necessary fields. A specific API request format for the View Report is now available, utilizing the Report View Identifier instead of numeric IDs for easier management and reference.

Example: Integrating a View Report with a Power BI graph

Call URL Breakdown: https://api-gateway.softools.net/Api/Apps/[AppID]/View/[ViewReportID]

Call URL Example: https://api-gateway.softools.net/Api/Apps/Projects/View/PowerBi

Note: For more information on API requests supported by Softools, please refer to https://developer.softools.net/