Items - Get Graph Model Definition

Служба:: GraphModel

Версия API:: v1

Возвращает указанное общедоступное определение GraphModel.

Замечание

Элемент GraphModel в настоящее время находится в предварительной версии (дополнительные сведения).

Этот API поддерживает длительные операции (LRO).

При получении общедоступного определения GraphModel метка конфиденциальности не является частью определения.

Permissions

Вызывающий объект должен иметь разрешения на чтение и запись для GraphModel.

Обязательные делегированные области

Item.ReadWrite.All

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Support
User	Да
Представитель службы и управляемые удостоверения	нет

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphModels/{GraphModelId}/getDefinition

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
GraphModelId	path	True	string (uuid)	Идентификатор GraphModel.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
format	query		string	Формат общедоступного определения GraphModel.

Ответы

Имя	Тип	Описание
200 OK	GraphModelDefinitionResponse	Запрос успешно завершен.
202 Accepted		Запрос принят. Получение определения выполняется. Заголовки Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента.

Примеры

Get a GraphModel public definition example

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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"
      }
    ]
  }
}

Код состояния:: 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

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GraphModelDefinitionFormat	Формат определения элемента. С течением времени могут добавляться дополнительные `format` типы.
GraphModelDefinitionResponse	Ответ общедоступного определения GraphModel.
GraphModelPublicDefinition	Объект общедоступного определения GraphModel. Дополнительные сведения о создании общедоступного определения GraphModel см. в этой статье .
GraphModelPublicDefinitionPart	Объект части определения GraphModel.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

GraphModelDefinitionFormat

Перечисление

Формат определения элемента. С течением времени могут добавляться дополнительные format типы.

Значение	Описание
json	Формат JSON для общедоступного определения GraphModel, специально предназначенный для поддержки сценариев CI/CD в Fabric.

GraphModelDefinitionResponse

Объект

Ответ общедоступного определения GraphModel.

Имя	Тип	Описание
definition	GraphModelPublicDefinition	Объект общедоступного определения GraphModel. Дополнительные сведения о создании общедоступного определения GraphModel см. в этой статье .

GraphModelPublicDefinition

Объект

Объект общедоступного определения GraphModel. Дополнительные сведения о создании общедоступного определения GraphModel см. в этой статье .

Имя	Тип	Описание
format	GraphModelDefinitionFormat	Формат определения элемента. С течением времени могут добавляться дополнительные `format` типы.
parts	GraphModelPublicDefinitionPart[]	Список частей определения.

GraphModelPublicDefinitionPart

Объект

Объект части определения GraphModel.

Имя	Тип	Описание
path	string	Путь к части общедоступного определения GraphModel.
payload	string	Полезные данные общедоступного определения GraphModel.
payloadType	PayloadType	Тип полезных данных.

PayloadType

Перечисление

Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

Значение	Описание
InlineBase64	Встроенная база 64.

Поделиться через

Items - Get Graph Model Definition

Permissions

Обязательные делегированные области

Идентификаторы, поддерживаемые Microsoft Entra

Интерфейс

Параметры URI

Ответы

Примеры

Get a GraphModel public definition example

Образец запроса

Пример ответа

Определения

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphModelDefinitionFormat

GraphModelDefinitionResponse

GraphModelPublicDefinition

GraphModelPublicDefinitionPart

PayloadType