You can get the contents of a report via API with the following sample code. Below makes reference to
- Platform
This should be https://webapi.your platform URL - Username
You must first create an admin user who has sufficient permissions to access the data you need to report, have access to reports themselves, have appropriate User Access Group permissions if required and have an activated account. You must then create an API user associated with this admin user and replace Username in this code with the API user's username. See Authentication and accessing the API Endpoint for more details. - Client secret
Replace this with the Client Secret from the API user created in the above step. - Tenant ID
This should be the ID of the tenant holding the report you want to access. You can find tenant ID by creating a report at platform level listing all tenants and their ID. You could also add {{tenantid}} expression into tenant dashboard intro text so it's always available to view. - Report name
This should be replaced with the exact name of the report you wish to download
> More details here.
Four endpoints are supported:
POST
Execute a tenant level Report Builder type report
POST
Execute a tenant level Merged Report report
POST
Execute a platform level Report Builder type report
POST
Execute a platform level Merged Report type report
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;
namespace ConsoleApp1
{
class Program
{
static async Task Main(string[] args)
{
try
{
await ConnectApi();
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
}
private class IdpResponse
{
public string access_token { get; set; }
public int expires_in { get; set; }
public string token_type { get; set; }
}
private class ReportLine
{
public int SystemId { get; set; }
public string ForeNames { get; set; }
public string Surname { get; set; }
public string EmailAddress { get; set; }
}
private class ReportData
{
public ICollection<ReportLine> ResultSet { get; set; }
}
private static async Task ConnectApi()
{
// Create a new http client and set the base url for it
var client = new HttpClient();
client.BaseAddress = new Uri(https://webapi.myworkpal.co.uk); //This url will vary depending on the platform being used
// First you need to get a bearer token to be able to access the api.
// You do this by posting the client api credentials to a token end point
var formContent = new FormUrlEncodedContent(new[] {
new KeyValuePair<string, string>("grant_type", "client_credentials"),
new KeyValuePair<string, string>("scope", "api"),
new KeyValuePair<string, string>("client_id", "username"), //This will change for the live implementation0
new KeyValuePair<string, string>("client_secret", "Client secret") //This will change for the live implementation
});
var response = await client.PostAsync("/idp/connect/token", formContent);
var content = await response.Content.ReadAsStringAsync();
// The content received is in Json format. Parse this json object to retrieve the access token
var accessToken = JsonSerializer.Deserialize<IdpResponse>(content).access_token;
// Add an authorization header to the http client and add the token.
// Without this header you will not be able to get responses from the api.
// Make note of the "Bearer " bit. It is important to have this
client.DefaultRequestHeaders.Add("Authorization", "Bearer " + accessToken);
// Make a call to run the report.
var postContent = new StringContent(JsonSerializer.Serialize(new { TenantId = 8, ReportName = "10 years service", ReportFormat = 0 }), Encoding.UTF8, "application/json");
// calling a Report Builder type report
response = await client.PostAsync("api/tenant/report/executereport", postContent);
// calling a Merged Report type report
// response = await client.PostAsync("api/tenant/mergedreport/executereport", postContent);
// In order to get platform level report use the following
/*
var postContent = new StringContent(JsonSerializer.Serialize(new {, ReportName = "my platform report", ReportFormat = 0 }), Encoding.UTF8, "application/json");
response = await client.PostAsync("api/report/executereport", postContent);
// calling a Merged Report type report
// response = await client.PostAsync("api/mergedreport/executereport", postContent);
/*
// Get the report data
var responseContent = await response.Content.ReadAsStringAsync();
// process report data as you see fit. Here we write out the data to the console window
WriteOutReportData(responseContent);
Console.Read();
}
private static void WriteOutReportData(string reporContent) {
//Deserialise the report data into an object and then write out the data to the console window
var reportData = JsonSerializer.Deserialize<ReportData>(reporContent, new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase });
Console.WriteLine("Report data received:\n");
Console.WriteLine("{0,-15} {1,-15} {2,-15} {3,-15}", "System Id", "Forenames", "Surname", "Email Address");
Console.WriteLine("{0,-15} {1,-15} {2,-15} {3,-15}", "---------", "---------", "-------", "-------------\n");
foreach (var line in reportData.ResultSet)
{
Console.WriteLine("{0,-15} {1,-15} {2,-15} {3,-15}", line.SystemId, line.ForeNames, line.Surname, line.EmailAddress);
}
}
}
}