Распространенные метаданных, возвращаемых веб-службой отчетов Office 365

  • Статья

В этом разделе описываются метаданных, который Веб-служба отчетов Office 365 возвращает с каждого отчета и предоставляет как часть каждой записи отчета.

Дата последнего изменения: 17 сентября 2015 г.

Область применения: Office 365

Уровень службы метаданных

Чтобы получить список отчетов и полей для пользователя, прошедшего проверку подлинности документа XML (в формате Atom), доступ к этот URL-адрес.

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/$metadata

В документ метаданных, возвращенный существует три основных раздела:

  • Элементы EntityType определяют каждый тип отчета, разделы индекса и имена и типы свойств

  • Элемент EntityContainer , где перечислены все имена отчетов и соответствующие определения EntityType.

  • Элементы аннотации предоставляют локализованные строки, приложение может использовать для подписей осей диаграммы. Строки предоставляются для заголовка отчета, x и y.

Примечание

Имейте в виду, что документ метаданных содержит сведения только о тех отчетов, доступных для учетной записи пользователя, переданное в запросе на HTTPS.

Метаданные уровня отчета

Следующий фрагмент выходные данные отчета в формате Atom XML пример метаданных, возвращаемых для отчета StaleMailboxDetail. Отчет не возвращает метаданные, когда приложение запрашивает данные JSON.

<feed xml:base="https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/" 
    xmlns="http://www.w3.org/2005/Atom" 
    xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices"
    xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <id>https://reports.office365.com/ecp/reportingwebservice/reporting.svc/StaleMailboxDetail</id>
  <title type="text">StaleMailboxDetail</title>
  <updated>2013-02-10T03:40:33Z</updated>
  <link rel="self" title="StaleMailboxDetail" href="StaleMailboxDetail" />

В следующей таблице приведены компоненты метаданных.

Компоненты уровня отчета метаданных

Тег метаданных уровня отчета Atom XML

Описание

xml:base

Указывает базовый конечной точки службы отчетов. URL-адрес не учитывается.

Пространства имен XML

Несколько пространств имен XML, рассматриваются, включая стандартные пространства имен Atom и два пространства имен ODATA и Microsoft dataservices, связанные с ADO.

<id>...</id>

Предоставляет URL-адрес базовый, разрешаемому отчета.

<title>…</title>

Предоставляет строку текста, можно использовать в качестве заголовка отчета.

<updated>...</updated>

Предоставляет UTC дату и время, когда отчет был возвращен вызывающему приложению.

<link/>

Предоставляет сведения, необходимые для создания HTML-ссылке на базовый отчет URL-адрес, указанный в теге <id> .

Метаданные элемента записи

В следующем фрагменте XML-документа показана запись, возвращенный из StaleMailboxDetail отчета в формате Atom.

  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/StaleMailboxDetail(datetime'2013-01-11T00%3A00%3A00')</id>
    <category term="TenantReporting.StaleMailboxDetailReport"
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="StaleMailboxDetailReport" 
      href="StaleMailboxDetail(datetime'2013-01-11T00%3A00%3A00')" />
    <title />
    <updated>2013-02-10T03:40:33Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-11T00:00:00</d:Date>
        <d:WindowsLiveID>userone@example.onmicrosoft.com</d:WindowsLiveID>
        <d:UserName>UserOne</d:UserName>
        <d:LastLogin m:type="Edm.DateTime" m:null="true" />
        <d:DaysInactive m:type="Edm.Int32">115</d:DaysInactive>
      </m:properties>
    </content>
  </entry>

Этот фрагмент кода JavaScript представляет те же данные в формате JSON.

  {
    "d":
      [
          {
            "__metadata":
              {
                "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/StaleMailboxDetail(datetime'2013-01-11T00%3A00%3A00')",
                "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/StaleMailboxDetail(datetime'2013-01-11T00%3A00%3A00')",
                "type":"TenantReporting.StaleMailboxDetailReport"
              },
            "Date":"\/Date(1357862400000)\/",
            "WindowsLiveID":"userone@example.onmicrosoft.com",
            "UserName":"UserOne",
            "LastLogin":null,
            "DaysInactive":115
          }
      ]
  }

Описание поля данных отчетов (дата, WindowsLiveID, имя пользователя, LastLogin и DaysInactive), доступны в Отчет о StaleMailboxDetail. В следующей таблице приведены метаданные отчетов на уровне элементов, показано выше в этом разделе. Далее представлены все стандартные ODATA и данных ADO службы метаданных.

Запись метаданных элемента

Тег метаданных на уровне элементов Atom XML

Свойства метаданных на уровне элементов JSON JavaScript

Описание

<id>...</id>

"id":

Содержит идентификатор для элемента. Несмотря на то, что этот идентификатор находится URI, не следует предполагать, что можно передать это значение Веб-служба отчетов и получить полезные результаты. Это уникальный идентификатор. Область уникальности применяется только к, возникших в один отчет.

<category>...</category>

"type":

Значение — это иерархическая текстовое представление, объединяя службы (TenantReporting) и имя отчета (StaleMailboxDetailReport).

<link>...</link>

"uri":

Содержит компоненты (Atom) или полностью формат (JSON) URI для данного элемента отчет. Поддерживаются не всеми отчетов непосредственно извлечение элемента на основании этой URI. Если приложение использует следующие коды URI, убедитесь, что возвращаются сведения — это ожиданиям. Кроме того некоторые отчеты возвращает ссылку на «изменить». Не используйте эти ссылки, поскольку они не работают.

<title />

Не указан.

Этот тег всегда будет пустым.

<updated>...</updated>

Не указан.

Предоставляет UTC дату и время, когда запись отчет был возвращен вызывающему приложению.

<author><name /></author>

Не указан.

Эти теги всегда являются пустыми.