Items - Get Report Definition

  • Reference
Service:
Report
API Version:
v1

Returns the specified report public definition.

This API supports long running operations (LRO).

When you get a report's public definition, the sensitivity label is not a part of the definition.

Permissions

The caller must have contributor or higher workspace role.

Required Delegated Scopes

Report.ReadWrite.All or Item.ReadWrite.All

Limitations

This API is blocked for a report with an encrypted sensitivity label.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal Yes
Managed identities Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reports/{reportId}/getDefinition
With optional parameters: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reports/{reportId}/getDefinition?format={format}

URI Parameters

Name In Required Type Description
reportId
 path True

string

uuid

The report ID.
workspaceId
 path True

string

uuid

The workspace ID.
format
 query

string

The format of the report public definition.

Responses

Name Type Description
200 OK

ReportDefinitionResponse

Request completed successfully.
202 Accepted

Request accepted. Retrieving the definition is in progress.

Headers

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • OperationNotSupportedForItem - Operation not supported for requested item.

Examples

Get a report definition example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/reports/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Sample response

Status code:
200 
{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Status code:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
PayloadType

The type of the definition part payload. Additional payload types may be added over time.
ReportDefinition

Report public definition object. Refer to this article for more details on how to craft a report public definition.
ReportDefinitionPart

Report definition part object.
ReportDefinitionResponse

Report public definition response.

ErrorRelatedResource

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

PayloadType

The type of the definition part payload. Additional payload types may be added over time.

Name Type Description
InlineBase64

string

Inline Base 64.

ReportDefinition

Report public definition object. Refer to this article for more details on how to craft a report public definition.

Name Type Description
format

string

The format of the item definition.
parts

ReportDefinitionPart[]

A list of definition parts.

ReportDefinitionPart

Report definition part object.

Name Type Description
path

string

The report part path.
payload

string

The report part payload.
payloadType

PayloadType

The payload type.

ReportDefinitionResponse

Report public definition response.

Name Type Description
definition

ReportDefinition

Report public definition object. Refer to this article for more details on how to craft a report public definition.