Admin - WorkspaceInfo PostWorkspaceInfo

Ссылка

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

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

Инициирует вызов для получения метаданных для запрошенного списка рабочих областей.

Важно!

Если для параметров или datasetExpressions задано datasetSchema значение true, необходимо полностью включить проверку метаданных, чтобы возвращались данные. Дополнительные сведения см. в разделе Включение параметров клиента для проверки метаданных.

Разрешения

Пользователь должен иметь права администратора (например, Майкрософт глобального администратора 365 или администратора службы Power BI) или пройти проверку подлинности с помощью субъекта-службы.

При выполнении с проверкой подлинности субъекта-службы приложение не должно иметь необходимых разрешений с согласия администратора для Power BI в портал Azure.

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

Tenant.Read.All или Tenant.ReadWrite.All

Применимо только при проверке подлинности с помощью стандартного маркера доступа делегированного администратора. Не должно присутствовать при использовании проверки подлинности через субъект-службу.

Ограничения

Максимум 500 запросов в час.
Максимум 16 одновременных запросов.

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo

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

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage={lineage}&datasourceDetails={datasourceDetails}&datasetSchema={datasetSchema}&datasetExpressions={datasetExpressions}&getArtifactUsers={getArtifactUsers}

Параметры URI

Имя	В	Тип	Описание
datasetExpressions	query	boolean	Возвращается ли выражение набора данных (запросы DAX и Mashup). Если для этого параметра задано значение `true`, необходимо полностью включить проверку метаданных, чтобы возвращались данные. Дополнительные сведения см. в разделе Включение параметров клиента для проверки метаданных.
datasetSchema	query	boolean	Возвращается ли схема набора данных (таблицы, столбцы и меры). Если для этого параметра задано значение `true`, необходимо полностью включить проверку метаданных, чтобы возвращались данные. Дополнительные сведения см. в разделе Включение параметров клиента для проверки метаданных.
datasourceDetails	query	boolean	Возвращается ли информация об источнике данных
getArtifactUsers	query	boolean	Следует ли возвращать сведения о пользователе для элемента Power BI (например, отчета или панели мониторинга)
lineage	query	boolean	Возвращается ли информация о происхождении данных (вышестоящие потоки данных, плитки, идентификаторы источников данных)

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

Имя	Тип	Описание
workspaces	string[]	Требуемые идентификаторы рабочих областей для проверки (поддерживает от 1 до 100 идентификаторов рабочих областей).

Ответы

Имя	Тип	Описание
202 Accepted	ScanRequest	Принято

Примеры

Example

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

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage=True&datasourceDetails=True&datasetSchema=True&datasetExpressions=True

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

{
  "workspaces": [
    "97d03602-4873-4760-b37e-1563ef5358e3",
    "67b7e93a-3fb3-493c-9e41-2c5051008f24"
  ]
}

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

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

{
  "id": "e7d03602-4873-4760-b37e-1563ef5358e3",
  "createdDateTime": "2020-06-15T16:46:28.0487687Z",
  "status": "NotStarted"
}

Определения

Имя	Описание
PowerBIApiErrorResponseDetail	Подробные сведения об ошибке Power BI
RequiredWorkspaces	Запрос обязательных рабочих областей
ScanRequest	Запрос на сканирование

PowerBIApiErrorResponseDetail

Подробные сведения об ошибке Power BI

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке
target	string	Целевой объект ошибки

RequiredWorkspaces

Запрос обязательных рабочих областей

Имя	Тип	Описание
workspaces	string[]	Требуемые идентификаторы рабочих областей для проверки (поддерживает от 1 до 100 идентификаторов рабочих областей).

ScanRequest

Запрос на сканирование

Имя	Тип	Описание
createdDateTime	string	Дата и время создания сканирования
error	PowerBIApiErrorResponseDetail	Ошибка сканирования (если она есть)
id	string	Идентификатор сканирования
status	string	Состояние сканирования

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