Compartilhar via


Metadados comum retornados pelo serviço web de relatório do Office 365

Este tópico descreve os metadados que o Office 365 Reporting web service retorna com cada relatório e fornece como parte de cada entrada do relatório.

Última alteração: quinta-feira, 17 de setembro de 2015

Aplica-se a: Office 365

Nível de serviço metadados

Para obter um documento XML (formato Atom) listando os campos para o usuário autenticado e relatórios, acesse essa URL.

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

O documento de metadados retornado, há três seções principais:

  • Elementos de EntityType definem cada tipo de relatório, qualquer chaves de índice e os nomes e tipos de todas as propriedades

  • Elemento EntityContainer que lista todos os nomes de relatório e as definições de EntityType correspondentes.

  • Elementos de anotações fornecem cadeias de caracteres localizadas que seu aplicativo pode usar para os rótulos do eixo em um gráfico. As cadeias de caracteres são fornecidas para o título do relatório, x e y.

Observação

Lembre-se de que o documento de metadados contém informações apenas para os relatórios disponíveis para a conta de usuário passada na solicitação HTTPS.

Metadados de nível de relatório

O fragmento de saída de um relatório formato Atom XML a seguir fornece um exemplo de metadados retornados para um relatório de StaleMailboxDetail. O relatório não retorna este metadados quando o aplicativo solicita dados 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" />
  

A tabela a seguir lista os componentes de metadados.

Componentes de metadados de nível de relatório

Marca de metadados de nível de relatório XML Atom

Description

xml:base

Indica o ponto de extremidade de base do serviço de relatório. A URL não diferencia maiúsculas de minúsculas.

Namespaces XML

Vários namespaces XML são chamados, incluindo o namespace Atom standard e dois namespaces de dataservices relacionados ao ADO ODATA e Microsoft.

<id>...</id>

Fornece a URL base, acrescida do relatório.

<title>…</title>

Fornece uma cadeia de caracteres de texto que pode ser usada como o título do relatório.

<updated>...</updated>

Fornece a data e hora UTC quando o relatório foi retornado para o aplicativo de chamada.

<link/>

Fornece informações necessárias para construir um link HTML para a URL base do relatório, conforme listado na marca <id> .

Metadados de item de entrada

O fragmento de documento XML a seguir mostra uma entrada retornada de um relatório de StaleMailboxDetail no formato 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>

Esse fragmento de JavaScript representa as mesmas informações no formato 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
          }
      ]
  }

Explicações sobre os campos de dados de relatório (data, WindowsLiveID, UserName, LastLogin e DaysInactive) está disponíveis no Relatório de StaleMailboxDetail. A tabela a seguir lista os metadados de nível de item do relatório mostrado anteriormente neste tópico. Estes são standard todos os metadados de serviços ODATA e dados de ADO.

Metadados do item de entrada

Marca de metadados de nível de item XML Atom

Propriedade de metadados de nível de item de JavaScript JSON

Descrição

<id>...</id>

"id":

Fornece um identificador para o item. Embora esse identificador parece ser um URI, você não deve presumir que você pode passar o valor para o Reporting web service e recuperar resultados úteis. É apenas um identificador exclusivo. O escopo da exclusividade só se aplica a esse resultado único relatório.

<category>...</category>

"type":

O valor é uma representação em texto hierárquico combinando o serviço (TenantReporting) e o nome do relatório (StaleMailboxDetailReport).

<link>...</link>

"uri":

Fornece os componentes (Atom) ou uma totalmente formado (JSON) URI para esse item de relatório. Nem todos os relatórios de suportam a recuperar diretamente do item com base nesse URI. Se seu aplicativo usa esses URIs, verifique se que as informações retornadas é sejam os esperados. Além disso, alguns relatórios retornam um link "Editar". Não use esses links, conforme elas não funcionam.

<title />

Não fornecido.

Nesta marca sempre está vazia.

<updated>...</updated>

Não fornecido.

Fornece a data e hora UTC quando a entrada de relatório foi retornada para o aplicativo de chamada.

<author><name /></author>

Não fornecido.

Essas marcas sempre estarão vazias.