PowerBI - Get PowerBi content
API Url
Use it to load PowerBI dashboards and reports.
http://localhost:16010/ProMarkREST/web/PowerBI/content
Permissions: user
Request headers
| Field | Type | Description |
|---|---|---|
Accept-Languageoptional | String | =en-GB Language use for localization. |
X-Clientoptional | String | =Client type. "Portal""Mobile""Admin" |
X-Roleoptional | Number | ProMark role (1: Employee, 2: User). {12} |
X-WebPart-Idoptional | Number | Unique web-part identifier. |
Query parameters
| Field | Type | Description |
|---|---|---|
typeoptional | String | Comma-separated list of content to retrieve dashboardreport |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data. |
| content | Object[] | Object containing PowerBI dashboards and reports from a specific group (if group id set as a webpart property) or dashboards from all the groups |
| displayName | String | Dashboard name |
| embedUrl | String | Embed URL |
| groupId | String | Group (workspace) id |
| id | String | ID of the report/dashboard |
| isReadOnly | Boolean | If dashboard is read only |
| name | String | Report name |
| reportType | String | Type of the report |
| type | String | Dashboard or report |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Success example:
{"response": {"data": {"content": [{"type": "dashboard","id": "79e2a45c-e028-4fd3-b5bd-c2598e12ef31","displayName": "Demo","isReadOnly": false,"groupId": "af7f62df-febb-4708-96a1-25cc60393870","embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=79e2a45c-e028-4fd3-b5bd-c2598e12ef31&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVdFU1QtRVVST1BFLUUtUFJJTUFSWS1yZWRpcmVjdC5hbmFseXNpcy53aW5kb3dzLm5ldCIsImVtYmVkRmVhdHVyZXMiOnsibW9kZXJuRW1iZWQiOmZhbHNlfX0%3d"},{"type": "report","id": "cb68294d-7b72-4c9e-be24-197c7d27edc1","displayName": "test","isReadOnly": false,"groupId": "af7f62df-febb-4708-96a1-25cc60393870","embedUrl": "https://app.powerbi.com/reportEmbed?reportidId=cb68294d-7b72-4c9e-be24-197c7d27edc1&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVdFU1QtRVVST1BFLUUtUFJJTUFSWS1yZWRpcmVjdC5hbmFseXNpcy53aW5kb3dzLm5ldCIsImVtYmVkRmVhdHVyZXMiOnsibW9kZXJuRW1iZWQiOmZhbHNlfX0%3d"}]}}}
Error 4xx
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data (empty). |
| errorCode | Number | Error code. |
| errorMessage | String | Error description. |