Items - Get Report Definition

Hizmet:

Report

API Sürümü:

v1

Belirtilen rapor genel tanımını döndürür.
Bu API, uzun süre çalışan işlemleri (LRO)destekler.

Raporun genel tanımını aldığınızda duyarlılık etiketi tanımın bir parçası değildir.

İzinler

Çağıranın rapor için okuma ve yazma izinlerine sahip olması gerekir.

Gerekli Temsilci Kapsamları

Report.ReadWrite.All veya Item.ReadWrite.All

Sınırlamalar

Bu API, şifrelenmiş duyarlılık etiketine sahip bir rapor için engellenir.

Microsoft Entra destekli kimlikler

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Kimlik	Destek
Kullanıcı	Evet
Hizmet sorumlusu ve yönetilen kimlikler	Evet

Arayüz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reports/{reportId}/getDefinition

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
reportId	path	True	string (uuid)	Rapor kimliği.
workspaceId	path	True	string (uuid)	Çalışma alanı kimliği.

Yanıtlar

Name	Tür	Description
200 OK	ReportDefinitionResponse	İstek başarıyla tamamlandı.
202 Accepted		İstek kabul edildi. Tanımı alma işlemi devam ediyor. Üst Bilgiler Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Yaygın hata kodları: OperationNotSupportedForItem - İstenen öğe için işlem desteklenmiyor.

Örnekler

Get a report definition example

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

200

{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Durum kodu:

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

Tanımlar

Name	Description
ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse	Hata yanıtı.
ErrorResponseDetails	Hata yanıtı ayrıntıları.
PayloadType	Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.
ReportDefinition	Rapor genel tanımı nesnesi. Rapor genel tanımı oluşturma hakkında daha fazla bilgi için bu makale bakın.
ReportDefinitionPart	Rapor tanımı parça nesnesi.
ReportDefinitionResponse	Rapor genel tanımı yanıtı.

ErrorRelatedResource

Object

Hatayla ilgili kaynak ayrıntıları nesnesi.

Name	Tür	Description
resourceId	string	Hataya dahil olan kaynak kimliği.
resourceType	string	Hataya dahil olan kaynağın türü.

ErrorResponse

Object

Hata yanıtı.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
moreDetails	ErrorResponseDetails[]	Ek hata ayrıntılarının listesi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.
requestId	string	Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Object

Hata yanıtı ayrıntıları.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.

PayloadType

Listeleme

Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

Değer	Description
InlineBase64	Satır içi Temel 64.

ReportDefinition

Object

Rapor genel tanımı nesnesi. Rapor genel tanımı oluşturma hakkında daha fazla bilgi için bu makale bakın.

Name	Tür	Description
format	string	Öğe tanımının biçimi.
parts	ReportDefinitionPart[]	Tanım bölümlerinin listesi.

ReportDefinitionPart

Object

Rapor tanımı parça nesnesi.

Name	Tür	Description
path	string	Rapor bölümü yolu.
payload	string	Rapor bölümü yükü.
payloadType	PayloadType	Yük türü.

ReportDefinitionResponse

Object

Rapor genel tanımı yanıtı.

Name	Tür	Description
definition	ReportDefinition	Rapor genel tanımı nesnesi. Rapor genel tanımı oluşturma hakkında daha fazla bilgi için bu makale bakın.