Push Datasets - Datasets PostDataset

Ссылка

Служба:: Power BI REST APIs

Версия API:: v1.0

Создает новый набор данных my workspace.

Требуемая область

Dataset.ReadWrite.All

Ограничения

Этот вызов API поддерживает только push-наборы данных. Полный список ограничений см. в ограничениях push-наборов данных.

POST https://api.powerbi.com/v1.0/myorg/datasets

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

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy={defaultRetentionPolicy}

Параметры URI

Имя	В	Обязательно	Тип	Описание
defaultRetentionPolicy	query		DefaultRetentionPolicy	Политика хранения по умолчанию

Текст запроса

Имя	Обязательно	Тип	Описание
name	True	string	Имя набора данных
tables	True	Table[]	Таблицы набора данных
datasources		Datasource[]	Источники данных, связанные с этим набором данных
defaultMode		DatasetMode	Режим набора данных или тип
relationships		Relationship[]	Связи набора данных

Ответы

Имя	Тип	Описание
201 Created	Dataset	Создано
202 Accepted	Dataset	Принято

Примеры

Push example

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

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy=basicFIFO

Текст запроса

{
  "name": "SalesMarketing",
  "defaultMode": "Push",
  "tables": [
    {
      "name": "Product",
      "columns": [
        {
          "name": "ProductID",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsCompete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        }
      ]
    }
  ]
}

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

Код состояния:: 201

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "name": "SalesMarketing",
  "defaultRetentionPolicy": "basicFIFO"
}

Определения

Имя	Описание
ASMashupExpression	Источник таблицы набора данных
Column	Столбец набора данных
CreateDatasetRequest	Набор данных Power BI
CrossFilteringBehavior	Направление фильтра связи
Dataset	Набор данных Power BI. API возвращает подмножество из следующего списка свойств набора данных. Подмножество зависит от вызываемого API, разрешений вызываемого абонента и доступности данных в базе данных Power BI.
DatasetMode	Режим набора данных или тип
DatasetQueryScaleOutSettings	Параметры масштабирования запросов набора данных
DatasetUser	Запись права доступа пользователя Power BI для набора данных
DatasetUserAccessRight	Право доступа, которое пользователь имеет для набора данных (уровень разрешений)
Datasource	Источник данных Power BI
DatasourceConnectionDetails	Сведения о подключении к источнику данных Power BI. См. примеры получения источников данных или получения источников данных в группе.
DefaultRetentionPolicy	Политика хранения по умолчанию
DependentDataflow	Зависимый поток данных Power BI
Encryption	Сведения о шифровании для набора данных
EncryptionStatus	Состояние шифрования набора данных
Measure	Мера Power BI
PrincipalType	Тип субъекта
Relationship	Связь между таблицами в наборе данных
Row	Строка данных в наборе данных
ServicePrincipalProfile	Профиль субъекта-службы Power BI. Применимо только для решения Power BI Embedded с несколькими арендами.
Table	Таблица набора данных

ASMashupExpression

Object

Источник таблицы набора данных

Имя	Тип	Описание
expression	string	Исходное выражение

Column

Object

Столбец набора данных

Имя	Тип	Описание
dataCategory	string	Необязательно. Строковое значение, используемое для категории данных, описывающей данные в этом столбце.
dataType	string	Тип данных столбца
formatString	string	Необязательно. Формат столбца, указанный в FORMAT_STRING.
isHidden	boolean	Необязательно. Скрыт ли столбец. Значение по умолчанию — `false`.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	Имя столбца
sortByColumn	string	Необязательно. Строковое имя столбца в той же таблице, используемое для упорядочивания текущего столбца.
summarizeBy	string	Необязательно. Агрегатная функция, используемая для суммирования этого столбца.

CreateDatasetRequest

Object

Набор данных Power BI

Имя	Тип	Описание
datasources	Datasource[]	Источники данных, связанные с этим набором данных
defaultMode	DatasetMode	Режим набора данных или тип
name	string	Имя набора данных
relationships	Relationship[]	Связи набора данных
tables	Table[]	Таблицы набора данных

CrossFilteringBehavior

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

Направление фильтра связи

Значение	Описание
Automatic	Поведение перекрестной фильтрации определяется автоматически
BothDirections	В целях фильтрации обе таблицы рассматриваются как одна таблица.
OneDirection	В целях фильтрации фильтр будет применяться к таблице, в которой агрегируются значения.

Dataset

Object

Набор данных Power BI. API возвращает подмножество из следующего списка свойств набора данных. Подмножество зависит от вызываемого API, разрешений вызываемого абонента и доступности данных в базе данных Power BI.

Имя	Тип	Описание
ContentProviderType	string	Нерекомендуемое свойство, которое следует игнорировать.
Encryption	Encryption	Сведения о шифровании набора данных. Применимо только при указании `$expand`.
IsEffectiveIdentityRequired	boolean	Требуется ли для набора данных эффективное удостоверение, которое необходимо отправить в вызов API GenerateTo ken.
IsEffectiveIdentityRolesRequired	boolean	Определяется ли безопасность на уровне строк внутри PBIX-файла Power BI. В этом случае необходимо указать роль.
IsInPlaceSharingEnabled	boolean	Может ли набор данных использоваться внешними пользователями в собственном клиенте.
IsOnPremGatewayRequired	boolean	Требуется ли для набора данных локальный шлюз данных
IsRefreshable	boolean	Это поле возвращает `true`, если набор данных недавно обновлен или настроен для автоматического обновления, при этом режим подключения специально установлен в значение Import. Значение возвращает `false` для других режимов подключения, таких как DirectQuery и LiveConnection, независимо от того, обновляется ли набор данных вручную или настроен для автоматического обновления.
addRowsAPIEnabled	boolean	Позволяет ли набор данных добавлять новые строки
configuredBy	string	Владелец набора данных
createReportEmbedURL	string	URL-адрес внедрения отчета в набор данных
createdDate	string (date-time)	Дата и время создания набора данных
description	string	Описание набора данных
id	string	Идентификатор набора данных
name	string	Имя набора данных
qnaEmbedURL	string	Url-адрес внедрения набора данных Q&A
queryScaleOutSettings	DatasetQueryScaleOutSettings	Параметры масштабирования запросов набора данных
targetStorageMode	string	Режим хранения набора данных
upstreamDataflows	DependentDataflow[]	Список всех потоков данных этого элемента зависит от
users	DatasetUser[]	(Пустое значение) Сведения о доступе пользователя к набору данных. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователе в элементе Power BI (например, отчете или панели мониторинга) с помощью API Получения пользователей набора данных в качестве администратора или API PostWorkspaceInfo с параметром `getArtifactUsers`.
webUrl	string	URL-адрес веб-набора данных

DatasetMode

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

Режим набора данных или тип

Значение	Описание
AsAzure	Набор данных с динамическим подключением к Службам Azure Analysis Services
AsOnPrem	Набор данных с динамическим подключением к локальным службам Azure Analysis Services
Push	Набор данных, обеспечивающий программный доступ для отправки данных в Power BI
PushStreaming	Набор данных, поддерживающий потоковую передачу данных и обеспечивающий программный доступ для отправки данных в Power BI
Streaming	Набор данных, поддерживающий потоковую передачу данных. Дополнительные сведения см. в статье Потоковая передача данных в реальном времени в Power BI.

DatasetQueryScaleOutSettings

Object

Параметры масштабирования запросов набора данных

Имя	Тип	Описание
autoSyncReadOnlyReplicas	boolean	Автоматически ли набор данных синхронизирует реплики только для чтения
maxReadOnlyReplicas	integer minimum: -1 maximum: 64	Максимальное количество реплик только для чтения для набора данных (0–64, -1 для автоматического числа реплик)

DatasetUser

Object

Запись права доступа пользователя Power BI для набора данных

Имя	Тип	Описание
datasetUserAccessRight	DatasetUserAccessRight	Право доступа, которое пользователь имеет для набора данных (уровень разрешений)
displayName	string	Отображаемое имя субъекта
emailAddress	string	Адрес электронной почты пользователя
graphId	string	Идентификатор субъекта в Microsoft Graph. Доступно только для API администрирования.
identifier	string	Идентификатор субъекта
principalType	PrincipalType	Тип субъекта
profile	ServicePrincipalProfile	Профиль субъекта-службы Power BI. Применимо только для решения Power BI Embedded с несколькими арендами.
userType	string	Тип пользователя.

DatasetUserAccessRight

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

Право доступа, которое пользователь имеет для набора данных (уровень разрешений)

Значение	Описание
None	Удаляет разрешение на содержимое в наборе данных
Read	Предоставляет доступ на чтение к содержимому в наборе данных
ReadExplore	Предоставляет доступ на чтение и изучение содержимого в наборе данных
ReadReshare	Предоставляет доступ на чтение и повторное предоставление доступа к содержимому в наборе данных
ReadReshareExplore	Предоставляет доступ к содержимому в наборе данных для чтения, повторного доступа и просмотра
ReadWrite	Предоставляет доступ на чтение и запись к содержимому в наборе данных
ReadWriteExplore	Предоставляет доступ на чтение, запись и изучение содержимого в наборе данных
ReadWriteReshare	Предоставляет доступ для чтения, записи и повторного доступа к содержимому в наборе данных
ReadWriteReshareExplore	Предоставляет доступ для чтения, записи, повторного доступа к содержимому в наборе данных

Datasource

Object

Источник данных Power BI

Имя	Тип	Описание
connectionDetails	DatasourceConnectionDetails	Сведения о подключении к источнику данных
connectionString	string	(не рекомендуется) Строка подключения к источнику данных. Доступно только для DirectQuery.
datasourceId	string (uuid)	Идентификатор привязанного источника данных, который пуст, если не привязан к шлюзу
datasourceType	string	Тип источника данных
gatewayId	string (uuid)	Идентификатор привязанного шлюза, который пуст, если он не привязан к шлюзу. При использовании кластера шлюза идентификатор шлюза ссылается на первичный (первый) шлюз в кластере и аналогичен идентификатору кластера шлюза.
name	string	(не рекомендуется) Имя источника данных. Доступно только для DirectQuery.

DatasourceConnectionDetails

Object

Сведения о подключении к источнику данных Power BI. См. примеры получения источников данных или получения источников данных в группе.

Имя	Тип	Описание
account	string	Учетная запись подключения
classInfo	string	Сведения о классе подключения
database	string	База данных подключения
domain	string	Домен подключения
emailAddress	string	Адрес электронной почты подключения
kind	string	Тип подключения
loginServer	string	Сервер входа для подключения
path	string	Путь подключения
server	string	Сервер подключения
url	string	URL-адрес подключения

DefaultRetentionPolicy

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

Политика хранения по умолчанию

Значение	Описание
None	Нет
basicFIFO	basicFIFO

DependentDataflow

Object

Зависимый поток данных Power BI

Имя	Тип	Описание
groupId	string	Идентификатор целевой группы
targetDataflowId	string	Идентификатор целевого потока данных

Encryption

Object

Сведения о шифровании для набора данных

Имя	Тип	Описание
EncryptionStatus	EncryptionStatus	Состояние шифрования набора данных

EncryptionStatus

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

Состояние шифрования набора данных

Значение	Описание
InSyncWithWorkspace	Шифрование поддерживается и синхронизируется с параметрами шифрования.
NotInSyncWithWorkspace	Шифрование поддерживается, но не синхронизируется с параметрами шифрования.
NotSupported	Шифрование не поддерживается для этого набора данных
Unknown	Состояние шифрования неизвестно из-за повреждения набора данных

Measure

Object

Мера Power BI

Имя	Тип	Описание
description	string	Необязательно. Описание меры.
expression	string	Допустимое выражение DAX
formatString	string	Необязательно. Строка, описывающая форматирование значения при отображении, как указано в FORMAT_STRING.
isHidden	boolean	Необязательно. Скрыта ли мера.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	Имя меры

PrincipalType

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

Тип субъекта

Значение	Описание
App	Тип субъекта-службы
Group	Тип субъекта-группы
None	Нет типа субъекта. Используется для доступа на уровне всей организации.
User	Тип субъекта-пользователя

Relationship

Object

Связь между таблицами в наборе данных

Имя	Тип	Default value	Описание
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	Направление фильтра связи
fromColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		Имя столбца внешнего ключа
fromTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		Имя таблицы внешнего ключа
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		Имя и идентификатор связи
toColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		Имя столбца первичного ключа
toTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		Имя таблицы первичного ключа

Row

Object

Строка данных в наборе данных

Имя	Тип	Описание
id	string	Уникальный идентификатор строки

ServicePrincipalProfile

Object

Профиль субъекта-службы Power BI. Применимо только для решения Power BI Embedded с несколькими арендами.

Имя	Тип	Описание
displayName	string	Имя профиля субъекта-службы
id	string (uuid)	Идентификатор профиля субъекта-службы

Table

Object

Таблица набора данных

Имя	Тип	Описание
columns	Column[]	Схема столбцов для этой таблицы
description	string	Описание таблицы
isHidden	boolean	Необязательно. Скрыта ли эта таблица набора данных.
measures	Measure[]	Меры в этой таблице
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$	Имя таблицы
rows	Row[]	Строки данных в этой таблице
source	ASMashupExpression[]	Источник таблицы

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

Push Datasets - Datasets PostDataset

Требуемая область

Ограничения

Параметры URI

Текст запроса

Ответы

Примеры

Push example

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

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

Определения

ASMashupExpression

Column

CreateDatasetRequest

CrossFilteringBehavior

Dataset

DatasetMode

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

Datasource

DatasourceConnectionDetails

DefaultRetentionPolicy

DependentDataflow

Encryption

EncryptionStatus

Measure

PrincipalType

Relationship

Row

ServicePrincipalProfile

Table

Дополнительные ресурсы