Items - Get Graph Model Definition

Layanan:

GraphModel

Versi API:

v1

Mengembalikan definisi publik GraphModel yang ditentukan.

Nota

Item GraphModel saat ini dalam Pratinjau (pelajari lebih lanjut).

API ini mendukung operasi jangka panjang (LRO).

Ketika Anda mendapatkan definisi publik GraphModel, label sensitivitas bukan bagian dari definisi.

Permissions

Pemanggil harus memiliki izin baca dan tulis untuk GraphModel.

Cakupan yang Didelegasikan yang Diperlukan

Item.ReadWrite.All

Microsoft Entra identitas yang didukung

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas	Support
Pengguna	Yes
Prinsipal Layanan dan Identitas Terkelola	Yes

Antarmuka

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/getDefinition

Dengan parameter opsional:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/getDefinition?format={format}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
graphModelId	path	True	string (uuid)	ID GraphModel.
workspaceId	path	True	string (uuid)	ID ruangkerja.
format	query		string	Format definisi publik GraphModel.

Respons

Nama	Jenis	Deskripsi
200 OK	GraphModelDefinitionResponse	Permintaan berhasil diselesaikan.
202 Accepted		Permintaan diterima. Mengambil definisi sedang berlangsung. Header Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Batas tarif layanan terlampaui. Server mengembalikan header yang Retry-After menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan. Header Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: OperationNotSupportedForItem - Operasi tidak didukung untuk item yang diminta.

Contoh

Get a GraphModel public definition example

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

200

{
  "definition": {
    "format": "json",
    "parts": [
      {
        "path": "graphType.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "graphDefinition.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "dataSources.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "stylingConfiguration.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Kode status:

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

Definisi

Nama	Deskripsi
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
GraphModelDefinitionFormat	Format definisi model grafik. Jenis format tambahan dapat ditambahkan dari waktu ke waktu.
GraphModelDefinitionResponse	Respons definisi publik GraphModel.
GraphModelPublicDefinition	Objek definisi publik GraphModel. Lihat artikel ini untuk detail selengkapnya tentang struktur definisi GraphModel.
GraphModelPublicDefinitionPart	Objek bagian definisi GraphModel.
PayloadType	Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
isRetriable	boolean	Jika benar, permintaan dapat dicoba kembali. Retry-After Gunakan header respons untuk menentukan penundaan, jika tersedia.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string (uuid)	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

GraphModelDefinitionFormat

Enumerasi

Format definisi model grafik. Jenis format tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
json	Format JSON untuk definisi publik GraphModel, dirancang khusus untuk mendukung skenario CI/CD di Fabric.

GraphModelDefinitionResponse

Objek

Respons definisi publik GraphModel.

Nama	Jenis	Deskripsi
definition	GraphModelPublicDefinition	Objek definisi publik GraphModel. Lihat artikel ini untuk detail selengkapnya tentang struktur definisi GraphModel.

GraphModelPublicDefinition

Objek

Objek definisi publik GraphModel. Lihat artikel ini untuk detail selengkapnya tentang struktur definisi GraphModel.

Nama	Jenis	Deskripsi
format	GraphModelDefinitionFormat	Format definisi model grafik. Jenis format tambahan dapat ditambahkan dari waktu ke waktu.
parts	GraphModelPublicDefinitionPart[]	Daftar bagian definisi.

GraphModelPublicDefinitionPart

Objek

Objek bagian definisi GraphModel.

Nama	Jenis	Deskripsi
path	string	Jalur bagian definisi publik GraphModel.
payload	string	Payload bagian definisi publik GraphModel.
payloadType	PayloadType	Jenis payload.

PayloadType

Enumerasi

Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
InlineBase64	Dasar Sebaris 64.