This endpoint returns a list of tenant created reports on a platform.  The returned reports will be determined by the permissions/access of the API client.


GET    /api/admin/reportbuilder/list/{tenantId}



Request


Url Params

tennatId
int
the id of the tenant


Authorization

The following authorization header is required.  The authorisation header should be set to a 'Bearer Token' type


Token
see How to get a bearer token



Response

The response will return an array of 0 to n JSON objects.  Each JSON object in the array contains the following properties:


idintthe id of the report
tenantIdintthe id of the tenant
namestringthe name of the report
description
string
description of the report
isMergeReportSource
boolis the report used as source in any merge report. 
reoprtType
enum
is the report type report or merge report. value 0 for report and 1 for merge report. 
isDeleted
boolis the report already deleted


Permissions



Examples


C# Example


var client = new HttpClient(); 
var request = new HttpRequestMessage(HttpMethod.Get, "https://{platform API url}/api/tenant/reportbuilder/list/get/{tenantId}"); 
request.Headers.Add("Authorization", "Bearer {access token}");
var response = await client.SendAsync(request); 
response.EnsureSuccessStatusCode(); 
Console.WriteLine(await response.Content.ReadAsStringAsync());


cURL Example


curl --location 'https://{platform API url}/api/tenant/reportbuilder/list/get/{tenantId}%filter=isDeleted=true' \ --header 'Authorization: Bearer {access token}'