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 example API calls for managing UDFs for WebReports.

Why Use Report API Calls?

These API calls will allow users with the API role to manage reports within the WebReports environment. Example API calls include modifying viewName, viewInfo, conProfiles, roles, reportTypes, numberOfExpDays, description, category.

Video Tutorial:

Not yet available.

Structure / Examples of Report API Calls

Report API Structure:

public string viewName { get; set; }
public string viewInfo { get; set; }
public string conProfiles { get; set; }
public string roles { get; set; }
public string reportTypes { get; set; }
public int numberOfExpDays { get; set; }
public string description { get; set; }
public string category { get; set; }

Required Items: viewName and viewInfo.

If you’re going to publish to a role/connection, conProfiles, roles, and reportTypes will be required for the base publish. All three of these can take multiple values but they need to be separated by a comma.

Optional Items: NumberOfExpDays, description, and category

Example:

{
"viewName": "MyView.vdm",
"viewInfo": "mylongviewcontentshere",
“conProfiles”: “DEF,FACS”,
“roles”: “Admin, User”,
“reportTypes”: “Finished Report”
"numberOfExpDays": 3,
"description": "Example Information",
"category": "Example Category"
}