topic Re: Report Descriptions in Developer

Report Descriptions

jamesclloyd — Wed, 07 Jul 2021 07:02:27 GMT

Hello,

The GetReportsAsAdmin document mentions the report description being a field:

https://docs.microsoft.com/en-us/rest/api/power-bi/admin/reports-get-reports-as-admin#report

But as far as I can tell it's not available - are there extra parameters to pass to the call to specify optional fields in the response or is the doc just out of date?

Any help much appreciated.

Re: Report Descriptions

Anonymous — Fri, 09 Jul 2021 01:18:35 GMT

Hi @jamesclloyd,

In fact, the document already mentioned these properties are reports that may be returned. They will be changed due to the permissions and report usages. (BTW, they may also include some properties that designed for dev only or the future product updates)

Report A Power BI report. Below is a list of properties that may be returned for a report. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

Regards,

Xiaoxin Sheng

Re: Report Descriptions

jamesclloyd — Fri, 09 Jul 2021 05:05:20 GMT

Thanks - I think you've clarified for me that the doc is vague?

I guess the followup question is:

Which subset gets returned for an admin calling the API this page documents? i.e., how do I get the description field mentioned?

I have the widest set of permissions possible.

All the best,

James

Re: Report Descriptions

Anonymous — Thu, 29 Jul 2021 09:16:40 GMT

HI @jamesclloyd,

Sorry for the late response, did you mean to get the description of these returned report properties that the document mentions?

If that is the case, it is impossible. These descriptions are not really included in API results. They are written by power bi team and used to help API users to understand response results and how to use them.

If you have to include them, I'd like to suggest you manually create a hashtable of these properties based on the document and trace/modify the raw API results to add property descriptions.

Regards,

Xiaoxin Sheng

Re: Report Descriptions

jamesclloyd — Thu, 29 Jul 2021 13:47:18 GMT

Good Afternoon,

It's bringing through this field against each report, using the API, as an admin.

We're looking to catalogue all of the reports we have and it's difficult without this.