Report definition

This article provides a breakdown of the definition structure for report items.

Supported formats

Report items support the PBIR-Legacy and PBIR format.

Definition parts

Report has different parts that make up its definition:

1 - This file or folder is required.

Important

definition.pbir holds the reference to the semantic model used by the report that can be a relative path (byPath) or a connection to a remote semantic model (byConnection). Fabric REST API only supports byConnection references.

For more information about the report files, refer to the Power BI Project report folder documentation.

Definition payload example using PBIR-Legacy

 {
    "parts": [
        {
            "path": "report.json",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": "definition.pbir",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": "StaticResources/RegisteredResources/logo.jpg",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        }
        ,
        {
            "path": "StaticResources/RegisteredResources/Light4437032645752863.json",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        }
        ,
        {
            "path": "StaticResources/SharedResources/BaseThemes/CY23SU04.json",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        }
    ]
}

Definition payload example using PBIR

 {
    "parts": [
        {
            "path": "definition/report.json",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": "definition/version.json",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": "definition/pages/pages.json",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": "definition/pages/61481e08c8c340011ce0/page.json",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": "definition/pages/61481e08c8c340011ce0/visuals/3852e5607b224b8ebd1a/visual.json",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": "definition/pages/61481e08c8c340011ce0/visuals/3852e5607b224b8ebd1a/mobile.json",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": "definition/pages/61481e08c8c340011ce0/visuals/7df3763f63115a096029/visual.json",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": "definition.pbir",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": "StaticResources/RegisteredResources/logo.jpg",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": "StaticResources/RegisteredResources/Light4437032645752863.json",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": "StaticResources/SharedResources/BaseThemes/CY23SU04.json",
            "payload": "<base64 encoded string>",
            "payloadType": "InlineBase64"
        },
        {
            "path": ".platform",
            "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
            "payloadType": "InlineBase64"
        }
    ]
}