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

Что такое REST API для служб Reporting Services?

  • Статья

Область применения: службы SQL Server Reporting Services (2017 и более поздние версии) Сервер отчетов Power BI ❌

Microsoft SQL Server 2017 Reporting Services поддерживает API передачи репрезентативного состояния (REST). REST API — это конечные точки службы, поддерживающие набор операций HTTP (методов). Эти методы обеспечивают создание, извлечение, обновление или удаление доступа к ресурсам на сервере отчетов.

REST API предоставляет программный доступ к объектам в каталоге сервера отчетов SQL Server 2017 Reporting Services. Ниже приведены примеры объектов:

  • Папки
  • Отчеты
  • Ключевые показатели эффективности
  • Источники данных
  • Наборы данных
  • Планы обновления
  • Подписки

При использовании REST API можно перемещаться по иерархии папок, обнаруживать содержимое папки или скачать определение отчета. Можно также создавать, обновлять и удалять объекты.

Примечание.

Если вы хотите просмотреть или удалить персональные данные, ознакомьтесь с правилами Майкрософт на сайте Запросы субъектов данных, определенные в GDPR, в отношении Windows. Если вам требуются общие сведения о GDPR, см. раздел, посвященный GDPR, на портале Service Trust Portal.

Компоненты запроса и ответа API REST

Пару запроса-ответа API REST можно разделить на пять компонентов:

  • Универсальный код ресурса (URI) запроса:

    • Хотя URI запроса включен в заголовок сообщения запроса, большинству языков или платформ требуется передать его отдельно от сообщения запроса.
    • Состоит из {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}.
    URI запроса Description
    Схема URI указывает протокол, используемый для передачи запроса. Например, http или https.
    Узел URI указывает доменное имя или IP-адрес сервера, где размещена конечная точка службы REST, например myserver.contoso.com.
    Resource path Указывает ресурс или коллекцию ресурсов, которая может включать несколько сегментов, используемых службой при определении выбора этих ресурсов. Например, можно использовать CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties для получения указанных свойств для CatalogItemобъекта .
    Строка запроса (необязательно) Предоставляет более простые параметры, такие как версия API или критерии выбора ресурсов.

  • Поля заголовка сообщения HTTP-запроса:

    • Обязательный метод HTTP, также известный как операция или команда.
    • Сообщает службе, какой тип операции вы запрашиваете. API-интерфейсы REST служб Reporting Services поддерживают методы DELETE, GET, HEAD, PUT, POST и PATCH.
    • Необязательные дополнительные поля заголовка, необходимые для указанного метода URI и HTTP.

  • Необязательные поля текста сообщения HTTP-запроса:

    • Поддерживает операцию URI и HTTP. Например, операции POST содержат многозначные расширения электронной почты (MIME), передаваемые в виде сложных параметров.
    • Для операций POST или PUT тип в кодировке MIME текста должен быть указан в заголовке запроса Content-type. Для некоторых служб необходимо использовать конкретный тип MIME, например application/json.

  • Поля заголовка сообщения ответа HTTP:

    • Код состояния HTTP— от кодов успешного выполнения 2xx до кодов ошибок 4xx или 5xx. Кроме того, может быть возвращен код состояния, определенный службой, как указано в документации по API.
    • Необязательные дополнительные поля заголовка, необходимые для поддержки ответа запроса, например заголовка Content-type ответа.

  • Необязательные поля текста сообщения ответа HTTP:

    • В тексте ответа HTTP возвращаются объекты ответа в кодировке MIME, например ответ от метода GET, который возвращает данные. Как правило, эти объекты возвращаются в структурированном виде, например JSON или XML, как указано в заголовке ответа Content-type.

Документация по API

Современный API REST требуется для современного документирования API. REST API основан на спецификации OpenAPI, которая также называется спецификацией swagger. Сервер отчетов Power BI документация по REST API доступна в Microsoft Learn.

Тестовые вызовы API

Если вам нужен инструмент для тестирования сообщений HTTP-запроса и ответа, Fiddler — это бесплатный прокси-сервер веб-отладки, который может перехватывать запросы REST, что упрощает диагностику сообщений HTTP-запросов и ответов.

Связанный контент