PowerBI - Get PowerBi content

API Url

Use it to load PowerBI dashboards and reports.

GET
http://localhost:16010/ProMarkREST/web/PowerBI/content

Permissions: user

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Query parameters

FieldTypeDescription
typeoptionalString

Comma-separated list of content to retrieve

Allowed values:dashboardreport

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    contentObject[]

Object containing PowerBI dashboards and reports from a specific group (if group id set as a webpart property) or dashboards from all the groups

      displayNameString

Dashboard name

      embedUrlString

Embed URL

      groupIdString

Group (workspace) id

      idString

ID of the report/dashboard

      isReadOnlyBoolean

If dashboard is read only

      nameString

Report name

      reportTypeString

Type of the report

      typeString

Dashboard or report

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"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

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.