Office 365 报告 Web 服务返回的常见元数据

本主题介绍 Office 365 报告 Web 服务在每个报告中返回的的元数据并作为每个报告条目的一部分提供。

上次修改时间： 2015年9月17日

适用范围： Office 365

服务级别元数据

若要获取列出经过身份验证的用户的报告和字段的 XML（Atom 格式）文档，请访问此 URL。

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

返回的元数据文档包括三个主要部分：

• EntityType 元素定义每种报告类型、所有索引键，以及所有属性的名称和类型

• 列出所有报告名称及相应 EntityType 定义的 EntityContainer 元素。

• Annotations 元素提供了您的应用程序可以在图中用于坐标轴标签的本地化字符串。针对报告标题、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 ADO 相关的数据服务命名空间。
<id>...</id>	提供报告基本的 URL。
<title>…</title>	提供可用于报告标题的文本字符串。
<updated>...</updated>	提供将报告返回至调用应用程序的 UTC 日期和时间。
<link/>	提供构建指向 <id> 标记所列基础报告 URL 的 HTML 链接所需的信息。

条目项元数据

以下 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
          }
      ]
  }

可从 StaleMailboxDetail 报告中获取报告数据字段（Date、WindowsLiveID、UserName、LastLogin 和 DaysInactive）的说明。下表列出了本主题前面说明的报告项目级别元数据。它们均为标准 ODATA 和 ADO 数据服务元数据。

条目项元数据

Atom XML 项目级别元数据标记	JSON JavaScript 项目级别元数据属性	说明
<id>...</id>	"id":	提供项目的标识符。尽管此标识符显示为 URI，您不应假设可以将该值传递给报告 Web 服务并检索有用的结果。这只是一个唯一的标识符。唯一的范围仅适用于这种单个报告结果。
<category>...</category>	"type":	此值是结合服务 (TenantReporting) 和报告名称 (StaleMailboxDetailReport) 的分层文本表示形式。
<link>...</link>	"uri":	提供此报告项目的组件 (Atom) 或完整的 (JSON) URI。并非所有报告都支持基于此 URI 直接检索项目。如果您的应用程序使用这些 URI，请确保返回的信息与预期的相同。此外，某些报告会返回"编辑"链接。请勿使用这些链接，因为它们无法正常使用。
<title />	未提供。	此标记始终为空。
<updated>...</updated>	未提供。	提供将报告条目返回至调用应用程序的 UTC 日期和时间。
<author><name /></author>	未提供。	这些标记始终为空。