Each Report Group contains the number of Reports which have been crawled. This service deals with Report related APIs.
The following are the operational APIs associated with the Report Services API:
1. Get Report By Report Group and Report Name
The Get Report By Report Group and Report Name returns Report with given ReportGroup and Report Name if it exists.
Mandatory Field: reportGroupId, reportName.
|
Method |
Url |
Parameter |
|
getReportbyReportGroupandReportName |
/api/report |
{reportGroupId},{reportName} |
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"Report": {
"chartName": "Sentiment",
"chartID": 1003,
"datasetID": 0,
"colNameTypeMap": "https://app.powerbi.com/embed?dashboardId=adc540e8-6d9d-467b-b72a-4e868d0c609b&tileId=1be9180d-a26d-4e25-a090-e64be484485d&groupId=1119ce1c-ae62-4601-b27f-5a4d46dab35e&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVVTLUVBU1QtQS1QUklNQVJZLXJlZGlyZWN0LmFuYWx5c2lzLndpbmRvd3MubmV0In0%3d",
"options": "adc540e8-6d9d-467b-b72a-4e868d0c609b",
"domainID": 1000,
"genre": "POWERBI",
"description": "Sentiment",
"owner": null,
"lastModDate": "2020-01-22 15:00:22.0",
"extReferenceId": "1be9180d-a26d-4e25-a090-e64be484485d",
"createdby": "admin",
"type": "Tile",
"cronentry": null,
"connectionName": "powerBI",
"usescore": 2,
"chartscore": 0,
"parentchartid": 1000,
"active": 1,
"dashboardId": 0,
"widgetGrid": null,
"dashboardName": null,
"buildLineage": false,
"businessGlossaryId": 0,
"domainName": "OvalEdge_Test_site",
"canSubscribe": false,
"customFields": null,
"params": {},
"id": 1003
}
}
}
2. Save Report
(NOTE: This method is deprecated. To create a Report, you should use crawlers in OvalEdge application)
The Save Report method creates a new Report with given input through the Request Body.
Mandatory Field: businessDescription, chartID,chartName, connectionId, connectionName, domainName, globalDomain, glossaryName, reportGroupID, technicalDescription, tagName.
|
Method |
Url |
|
saveReport |
/api/report |
Request Body
{
"active": 0, *
"chartID": 0,
"chartName": "string",*
"chartType": "string",*
"colNameTypeMap": "string",*
"datasetID": 0,
"description": "string",
"extReferenceId": "string",
"genre": "string",*
"options": "string",
"parentchartid": 0,
"reportGroupID": 0*
}
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"Report": {
"chartName": "SampleChart",
"chartID": 1120,
"datasetID": 0,
"colNameTypeMap": "http://sample.com/test1",
"options": "",
"domainID": 1001,
"genre": "POWERBI",
"description": "SampleChartDescription",
"owner": null,
"lastModDate": null,
"extReferenceId": "string",
"createdby": null,
"type": "Report",
"cronentry": null,
"connectionName": null,
"usescore": 0,
"chartscore": 0,
"parentchartid": 0,
"active": 1,
"dashboardId": 0,
"widgetGrid": null,
"dashboardName": null,
"buildLineage": false,
"businessGlossaryId": null,
"domainName": null,
"canSubscribe": false,
"customFields": null,
"params": {},
"id": 1120
}
}
}
3. Get Report By Id
The Get Report By Id method returns Report with given input Id if it exists.
Mandatory Field: reportId.
|
Method |
Url |
Parameter |
|
getReportbyId |
/api/report/{reportId} |
{reportId} |
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"Report": {
"chartName": "Sentiment Gap",
"chartID": 1002,
"datasetID": 0,
"colNameTypeMap": "https://app.powerbi.com/embed?dashboardId=adc540e8-6d9d-467b-b72a-4e868d0c609b&tileId=3724df55-713b-432a-a792-dc6964f1e8aa&groupId=1119ce1c-ae62-4601-b27f-5a4d46dab35e&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVVTLUVBU1QtQS1QUklNQVJZLXJlZGlyZWN0LmFuYWx5c2lzLndpbmRvd3MubmV0In0%3d",
"options": "adc540e8-6d9d-467b-b72a-4e868d0c609b",
"domainID": 1000,
"genre": "POWERBI",
"description": "Sentiment Gap",
"owner": null,
"lastModDate": "2020-01-22 15:00:22.0",
"extReferenceId": "3724df55-713b-432a-a792-dc6964f1e8aa",
"createdby": "admin",
"type": "Tile",
"cronentry": null,
"connectionName": "powerBI",
"usescore": 10,
"chartscore": 0,
"parentchartid": 1000,
"active": 1,
"dashboardId": 0,
"widgetGrid": null,
"dashboardName": null,
"buildLineage": false,
"businessGlossaryId": 0,
"domainName": "OvalEdge_Test_site",
"canSubscribe": false,
"customFields": null,
"params": {},
"id": 1002
}
}
}
4. Delete Report
The Delete Report method deletes Report with given Id.
Mandatory Field: reportId.
|
Method |
Url |
Parameter |
|
deleteReport |
/api/report/{reportId} |
{reportId} |
Response
{
"status": false,
"statusCode": "",
"statusMsg": "Report with reportId 1120 is deleted",
"response": {}
}
5. Get All Reports
The Get All Reports method returns a list of all Reports.
|
Method |
Url |
|
getAllReports |
/api/reports/all |
Response
{
"status": false,
"statusCode": "",
"statusMsg": "",
"response": {
"Reports": [
{
"chartName": "Sales and Marketing Sample",
"chartID": 1000,
"datasetID": 0,
"colNameTypeMap": "https://app.powerbi.com/dashboardEmbed?dashboardId=adc540e8-6d9d-467b-b72a-4e868d0c609b&groupId=1119ce1c-ae62-4601-b27f-5a4d46dab35e&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVVTLUVBU1QtQS1QUklNQVJZLXJlZGlyZWN0LmFuYWx5c2lzLndpbmRvd3MubmV0In0%3d",
"options": null,
"domainID": 1000,
"genre": "POWERBI",
"description": "Sales and Marketing Sample",
"owner": null,
"lastModDate": "2020-01-22 15:00:17.0",
"extReferenceId": "adc540e8-6d9d-467b-b72a-4e868d0c609b",
"createdby": "admin",
"type": "Dashboard",
"cronentry": null,
"connectionName": "powerBI",
"usescore": 14,
"chartscore": 0,
"parentchartid": 0,
"active": 1,
"dashboardId": 0,
"widgetGrid": null,
"dashboardName": null,
"buildLineage": false,
"businessGlossaryId": 0,
"domainName": "OvalEdge_Test_site",
"canSubscribe": false,
"customFields": null,
"params": {},
"id": 1000
},
{
"chartName": "Amazing_Mart_Dashboard",
"chartID": 1001,
"datasetID": 0,
"colNameTypeMap": "https://app.powerbi.com/dashboardEmbed?dashboardId=c9968037-cb60-42e4-860e-87a02f26575f&groupId=1c17a8b5-30d4-4402-8afb-48e12cb77104&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVVTLUVBU1QtQS1QUklNQVJZLXJlZGlyZWN0LmFuYWx5c2lzLndpbmRvd3MubmV0In0%3d",
"options": null,
"domainID": 1001,
"genre": "POWERBI",
"description": "Amazing_Mart_Dashboard",
"owner": null,
"lastModDate": "2020-01-22 15:00:21.0",
"extReferenceId": "c9968037-cb60-42e4-860e-87a02f26575f",
"createdby": "admin",
"type": "Dashboard",
"cronentry": null,
"connectionName": "powerBI",
"usescore": 0,
"chartscore": 0,
"parentchartid": 0,
"active": 1,
"dashboardId": 0,
"widgetGrid": null,
"dashboardName": null,
"buildLineage": false,
"businessGlossaryId": 0,
"domainName": "OvalEdge_Supplychain_datasite",
"canSubscribe": false,
"customFields": null,
"params": {},
"id": 1001
}
]
}
}