Datasets - Execute Queries

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

Выполняет запросы выражений анализа данных (DAX) к предоставленному набору данных. Набор данных должен находиться в разделе Моя рабочая область или в другой рабочей области.

Ошибки запросов DAX приводят к следующим результатам:

Ошибка ответа, например DAX query failure.
Код состояния HTTP сбоя (400).

Запрос, запрашивающий несколько таблиц или больше допустимого количества строк таблицы, приведет к следующему результату:

Ограниченные возвращаемые данные.
Ошибка ответа, например More than one result table in a query или More than {allowed number} rows in a query result.
Успешный код состояния HTTP (200).

Столбцы, которые являются полными в запросе, будут возвращены с полным именем, например MyTable[MyColumn]. Столбцы, которые были переименованы или созданы в запросе, будут возвращены в квадратной скобке, например [MyNewColumn].

Разрешения

Необходимо включить REST API выполнения запросов для набора данных клиента, который находится в разделе Параметры интеграции.

Пользователь должен иметь разрешения на чтение и сборку набора данных. Дополнительные сведения см. в разделе Управление разрешениями на доступ к набору данных.

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

Dataset.ReadWrite.All или Dataset.Read.All

Ограничения

Наборы данных, размещенные в Azure Analysis Services или имеющие динамическое подключение к локальной модели Azure Analysis Services, не поддерживаются.
Один запрос на вызов API.
Один запрос таблицы на запрос.
Не более 100 000 строк или 1 000 000 значений на запрос (в зависимости от того, какое из них будет достигнуто первым). Например, при запросе 5 столбцов можно вернуть максимум 100 000 строк. При запросе 20 столбцов можно вернуть максимум 50 000 строк (1 миллион, разделенный на 20).
Не более 15 МБ данных на запрос. После превышения 15 МБ текущая строка будет завершена, но дополнительные строки не будут записаны.
Существует ограничение в 120 запросов в минуту на пользователя, независимо от набора данных, к которому выполняется запрос.
Чтобы использовать субъекты-службы, убедитесь, что параметр клиента администратора Разрешить субъектам-службам использовать API Power BI в разделе Параметры разработчика включен. Однако независимо от параметра клиента администратора субъекты-службы не поддерживаются для наборов данных с ограничениями RLS на RLS или наборов данных с включенным единым входом.
В настоящее время поддерживаются только запросы DAX. Запросы многомерных выражений и динамических административных представлений не поддерживаются.

POST https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/executeQueries

Параметры URI

Имя	В	Обязательно	Тип	Описание
datasetId	path	True	string	Идентификатор набора данных

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

Имя	Обязательно	Тип	Описание
queries	True	DatasetExecuteQueriesQuery[]	Список запросов набора данных для выполнения
impersonatedUserName		string	Имя участника-пользователя для олицетворения. Если модель не включена, эта функция будет игнорироваться.
serializerSettings		DatasetExecuteQueriesSerializationSettings	Параметры сериализации для результирующих наборов

Ответы

Имя	Тип	Описание
200 OK	DatasetExecuteQueriesResponse	ОК

Примеры

Execute queries example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/executeQueries

Request Body

{
  "queries": [
    {
      "query": "EVALUATE VALUES(MyTable)"
    }
  ],
  "serializerSettings": {
    "includeNulls": true
  },
  "impersonatedUserName": "someuser@mycompany.com"
}

Sample Response

Status code:: 200

{
  "results": [
    {
      "tables": [
        {
          "rows": [
            {
              "MyTable[Year]": 2010,
              "MyTable[Quarter]": "Q1"
            },
            {
              "MyTable[Year]": 2010,
              "MyTable[Quarter]": "Q2"
            },
            {
              "MyTable[Year]": 2011,
              "MyTable[Quarter]": "Q1"
            }
          ]
        }
      ]
    }
  ]
}

Определения

Имя	Описание
DatasetExecuteQueriesError	Сведения об ошибке, если они есть.
DatasetExecuteQueriesInformationProtectionLabel	Сведения о метки защиты информации, если она есть, связанной с набором данных.
DatasetExecuteQueriesQuery	Запрос набора данных
DatasetExecuteQueriesQueryResult	Результаты одного запроса набора данных
DatasetExecuteQueriesRequest	Запрос на выполнение запросов к набору данных
DatasetExecuteQueriesResponse	Ответ на запрос на выполнение запросов набора данных
DatasetExecuteQueriesSerializationSettings	Параметры сериализации для результатов запроса набора данных
DatasetExecuteQueriesTableResult	Таблица данных

DatasetExecuteQueriesError

Сведения об ошибке, если они есть.

Имя	Тип	Описание
code	string	Код, связанный с ошибкой.
message	string	Сообщение об ошибке. Если здесь нет, эти сведения также находятся в подробном объекте, вложенном в объект ошибки.

DatasetExecuteQueriesInformationProtectionLabel

Сведения о метки защиты информации, если она есть, связанной с набором данных.

Имя	Тип	Описание
id	string	Идентификатор (GUID) метки защиты информации
name	string	Отображаемое имя метки защиты информации

DatasetExecuteQueriesQuery

Запрос набора данных

Имя	Тип	Описание
query	string	Выполняемый запрос DAX

DatasetExecuteQueriesQueryResult

Результаты одного запроса набора данных

Имя	Тип	Описание
error	DatasetExecuteQueriesError	Сведения об ошибке, если они есть.
tables	DatasetExecuteQueriesTableResult[]	Список данных таблиц для запроса

DatasetExecuteQueriesRequest

Запрос на выполнение запросов к набору данных

Имя	Тип	Описание
impersonatedUserName	string	Имя участника-пользователя для олицетворения. Если модель не включена, эта функция будет игнорироваться.
queries	DatasetExecuteQueriesQuery[]	Список запросов набора данных для выполнения
serializerSettings	DatasetExecuteQueriesSerializationSettings	Параметры сериализации для результирующих наборов

DatasetExecuteQueriesResponse

Ответ на запрос на выполнение запросов набора данных

Имя	Тип	Описание
error	DatasetExecuteQueriesError	Сведения об ошибке, если они есть.
informationProtectionLabel	DatasetExecuteQueriesInformationProtectionLabel	Сведения о метки защиты информации, если она есть, связанной с набором данных.
results	DatasetExecuteQueriesQueryResult[]	Список результатов, по одному на входной запрос.

DatasetExecuteQueriesSerializationSettings

Параметры сериализации для результатов запроса набора данных

Имя	Тип	Описание
includeNulls	boolean	Указывает, следует ли включать в результирующий набор значения NULL (пустые). Если не задано иное, по умолчанию используется значение `false`.

DatasetExecuteQueriesTableResult

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

Имя	Тип	Описание
error	DatasetExecuteQueriesError	Сведения об ошибке, если они есть.
rows	object[]	Список строк