Admin - WorkspaceInfo PostWorkspaceInfo

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

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

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

Это важно

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

Permissions

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

При выполнении проверки подлинности субъекта-службы приложение не должно иметь необходимых разрешений администратора для 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[] (uuid)	Необходимые идентификаторы рабочих областей для сканирования (поддерживает 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

Object

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

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

RequiredWorkspaces

Object

Запрос необходимых рабочих областей

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

ScanRequest

Object

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

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