API Calls for Publishing and Assigning Reports (Optional) to WebReports

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 detail on the API call 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).

Why Use the Report Publishing API Call?

The Report Publishing and Assignment API calls will allow users with the API role, or API key, to both Publish and Assign a report to a Connection Profile, Role and Control.  

Example Report API calls include modifying the following:

- viewName
- viewInfo
- conProfiles
- roles
- reportTypes (see below for supported values)
- numberOfExpDays
- description
- category

Supported Report Type Values (values are case sensitive):

- Details
- Summary
- Finished Reports
- Visualize

API Prerequisites:

- Must have the API role in WebReports

- Established Connection/Cookie

Video Tutorial:

Not yet available.

Structure / Examples of Report API Calls

Report API Endpoints:

Publish - /extapi/APIWebReport/PublishReport

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"
}