exportTime

Adaptive Planning

Documentação do Workday Adaptive Planning (Workday 2025R2)
Integração
Como gerenciar a integração de dados
Documentação da API
Métodos de criação, atualização e leitura de metadados e dados

Última atualização: 2023-06-23

exportTime

Esta API oferece suporte somente a usuários Conceito: regras de acesso na API v21 e superiores.

Categoria	Recuperação de metadados
Descrição	Retorna metadados de tempo para uma versão específica ou para todas as versões, se nenhuma for especificada.
Permissões obrigatórias para invocar	Nenhum (devem ser credenciais válidas para a instância)
Parâmetros obrigatórios na solicitação	Credenciais

A solicitação desse método contém uma etiqueta de credenciais para identificar e autorizar o usuário que faz a chamada, e uma etiqueta de versão opcional para especificar para qual versão as informações devem ser recuperadas. Se nenhuma versão é especificada, o método retorna informações de tempo para o intervalo de tempo que abrange as horas de início e de término de todas as versões. Depois que o chamador é verificado, o método retorna um documento XML que descreve o conjunto completo de informações de tempo da versão em formato de árvore aninhada.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportTime" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" locale="fr_FR" instanceCode="INSTANCE1"/>
<options includeAllLocales="1" includeLegacyInformation="1" />
</call>

elemento de credenciais
Nome da etiqueta		credenciais
Descrição		Todas as chamadas de API devem conter um único elemento de credenciais para identificar o usuário que invoca a API. A chamada à API é então executada como este usuário (qualquer trilha de auditoria ou histórico de ações no sistema mostrará que este usuário executou a ação) e, portanto, o usuário deve ter as permissões necessárias para executar a ação para que a chamada à API funcione. bem-sucedido.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
login	S	O nome de logon do usuário que invoca o método de API. Esse usuário deve ter as permissões necessárias para invocar o método.	sampleuser@company.com
senha	S	A senha do usuário que invoca o método de API.	my_password
parâmetros regionais	N	Especifique os parâmetros regionais a serem usados para interpretar números e datas de entrada e para formatar números e datas de saída (usando o separador de milhares, nomes de meses e formatação de data adequados). Os parâmetros regionais também são usados para especificar o idioma em que as mensagens do sistema na resposta devem ser exibidas. Se não especificado, en_US (inglês americano) é usado.	fr_FR
instanceCode	N	Se o usuário especificado nas credenciais tem acesso a mais de uma instância do Adaptive Planning , esse atributo pode ser usado para especificar que o usuário pretende acessar uma instância diferente da instância por padrão. Se não for especificada, a instância por padrão do usuário será usada. Para determinar os códigos de instância disponíveis, use a API exportInstances.	MYINSTANCE1
Conteúdo do elemento
(nenhum)

Elemento de opções
Nome da etiqueta		Opções
Descrição		Especifica as opções a serem usadas na exportação de horas.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
includeAllLocales	N	Opcionalmente, faça a exportação de horas para exportar todas as conversões para cada estrato/período. Se não for especificada, somente os parâmetros regionais especificados no bloco de credenciais serão exportados.	"1"
includeLegacyInformation	N	Opcionalmente, faça a exportação de horas para exportar atributos adicionais que contêm informações de horas herdadas. Esses atributos adicionais não serão incluídos se isCustom = 1	"1"
leafStratumId Com suporte na API v16 +	N	Opcionalmente, forneça a ID de um estrato de tempo para tratar como a folha. Os estratos de tempo que são mais nítidos que o estrato de tempo fornecido não serão incluídos na resposta, nem os períodos que pertencem a estratos de tempo que são mais nítidos que o estrato de tempo determinado.	"5"
calendarId Com suporte na API v33 +	N	Opcionalmente, informe a ID do calendário/hierarquia a ser recuperada. Se não for especificada, a API retornará apenas valores de tempo na hierarquia por padrão.	"1"
Conteúdo do elemento
(nenhum)

elemento de versão
Nome da etiqueta		versão
Descrição		Indica qual versão deve ser usada para recuperar os dados solicitados. O usuário deve ser capaz de acessar a versão especificada e ela não pode ser uma pasta. Um elemento de versão não é obrigatório, mas se um for incluído, a versão especificada deve ser válida.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
opção atualizado na API v18	N	Define o intervalo de tempo a ser exportado. Pode ser definido como "todos", "único" ou omitido. O valor por padrão é "único". Se for único, o usuário também deve especificar "nome" ou "ID". Retorna o intervalo de tempo da única versão especificada e o saldo inicial dessa versão. Se tanto o nome quanto a ID são especificados, eles devem se referir à mesma versão. Se todos, retorna o intervalo de tempo de mínimo a máximo de todas as versões, incluindo o período de saldo inicial para o primeiro estrato no intervalo de tempo mínimo-máximo. Se todos, a versão "name" ou "ID" não deve ser especificada. Se omitida, retorna todas as horas definidas. Ao especificar uma única versão, a chamada será bem-sucedida somente se o usuário tiver acesso à versão.	solteiro
nome	N	O nome da versão a ser usada para recuperar os dados. Somente uma versão pode ser acessada em uma única chamada de API. Se um nome não é fornecido, uma ID deve ser fornecida. Se ambos são fornecidos, devem corresponder à mesma versão.	Orçamento de 2014
ID	N	A ID da versão a ser usada para recuperar os dados. Somente uma versão pode ser acessada em uma única chamada de API. Se a opção é "única" e uma ID não é fornecida, um nome deve ser fornecido. Se ambos são fornecidos, devem corresponder à mesma versão.	3
Conteúdo do elemento
(nenhum)

Formato da resposta (com includeAllLocales="0" ou não especificado)


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
  <output>
    <time isCustom="1" seqNo="24">
      <stratum code="year" label="Year" shortName="Yr" id="3" inUse="1">
        <stratum code="qtr" label="Quarter" shortName="Qtr" id="2" inUse="1">
          <stratum code="month" label="Month" shortName="Mon" id="1" inUse="1" isDefault="1" />
        </stratum>
      </stratum>
      <period code="2015" label="FY2015" shortName="FY2015" stratumId="3" timeslot="15" encodedTimePeriod="3::15" id="15003" end="2016-01-01">
        <period code="Q1-2015" label="Q1-FY15" shortName="Q1-FY15" stratumId="2" timeslot="60" encodedTimePeriod="2::60" id="60002" end="2015-04-01">
          <period code="01/2015" label="Jan-2015" shortName="Jan-2015" stratumId="1"timeslot="180" encodedTimePeriod="1::180" id="180001" end="2015-02-01" />
          <period code="02/2015" label="Feb-2015" shortName="Feb-2015" stratumId="1" timeslot="181" encodedTimePeriod="1::181" id="181001" end="2015-03-01" />
          <period code="03/2015" label="Mar-2015" shortName="Mar-2015" stratumId="1" timeslot="182" encodedTimePeriod="1::182" id="182001" end="2015-04-01" />
        </period>
        <period code="Q2-2015" label="Q2-FY15" shortName="Q2-FY15" stratumId="2" timeslot="61" encodedTimePeriod="2::61" id="61002" end="2015-07-01">
          <period code="04/2015" label="Apr-2015" shortName="Apr-2015" stratumId="1" timeslot="183" encodedTimePeriod="1::183" id="183001" end="2015-05-01" />
          <period code="05/2015" label="May-2015" shortName="May-2015" stratumId="1" timeslot="184" encodedTimePeriod="1::184" id="184001" end="2015-06-01" />
          <period code="06/2015" label="Jun-2015" shortName="Jun-2015" stratumId="1" timeslot="185" encodedTimePeriod="1::185" id="185001" end="2015-07-01" />
        </period>
        <period code="Q3-2015" label="Q3-FY15" shortName="Q3-FY15" stratumId="2" timeslot="62" encodedTimePeriod="2::62" id="62002" end="2015-10-01">
          <period code="07/2015" label="Jul-2015" shortName="Jul-2015" stratumId="1" timeslot="186" encodedTimePeriod="1::186" id="186001" end="2015-08-01" />
          <period code="08/2015" label="Aug-2015" shortName="Aug-2015" stratumId="1" timeslot="187" encodedTimePeriod="1::187" id="187001" end="2015-09-01" />
          <period code="09/2015" label="Sep-2015" shortName="Sep-2015" stratumId="1" timeslot="188" encodedTimePeriod=""1::188" id="188001" end="2015-10-01" />
        </period>
        <period code="Q4-2015" label="Q4-FY15" shortName="Q4-FY15" stratumId="2" timeslot="63" encodedTimePeriod="2::63" id="63002" end="2016-01-01">
          <period code="10/2015" label="Oct-2015" shortName="Oct-2015" stratumId="1" timeslot="189" encodedTimePeriod="1::189" id="189001" end="2015-11-01" />
          <period code="11/2015" label="Nov-2015" shortName="Nov-2015" stratumId="1" timeslot="190" encodedTimePeriod="1::190" id="190001" end="2015-12-01" />
          <period code="12/2015" label="Dec-2015" shortName="Dec-2015" stratumId="1" timeslot="191" encodedTimePeriod="1::191" id="191001" end="2016-01-01" />
        </period>
      </period>
      <period code="2016" label="FY2016" shortName="FY2016" stratumId="3" timeslot="16" encodedTimePeriod="3::16" id="16003" end="2017-01-01">
        <period code="Q1-2016" label="Q1-FY16" shortName="Q1-FY16" stratumId="2" timeslot="64" encodedTimePeriod="2::64" id="64002" end="2016-04-01">
          <period code="01/2016" label="Jan-2016" shortName="Jan-2016" stratumId="1" timeslot="192" encodedTimePeriod="1::192" id="192001" end="2016-02-01" />
          <period code="02/2016" label="Feb-2016" shortName="Feb-2016" stratumId="1" timeslot="193" encodedTimePeriod="1::193" id="193001" end="2016-03-01" />
          <period code="03/2016" label="Mar-2016" shortName="Mar-2016" stratumId="1" timeslot="194" encodedTimePeriod="1::194" id="194001" end="2016-04-01" />
        </period>
        <period code="Q2-2016" label="Q2-FY16" shortName="Q2-FY16" stratumId="2" timeslot="65" encodedTimePeriod="2::65" id="65002" end="2016-07-01">
          <period code="04/2016" label="Apr-2016" shortName="Apr-2016" stratumId="1" timeslot="195" encodedTimePeriod="1::195" id="195001" end="2016-05-01" />
          <period code="05/2016" label="May-2016" shortName="May-2016" stratumId="1" timeslot="196" encodedTimePeriod="1::196" id="196001" end="2016-06-01" />
          <period code="06/2016" label="Jun-2016" shortName="Jun-2016" stratumId="1" timeslot="197" encodedTimePeriod="1::197" id="197001" end="2016-07-01" />
        </period>
        <period code="Q3-2016" label="Q3-FY16" shortName="Q3-FY16" stratumId="2" timeslot="66" encodedTimePeriod="2::66" id="66002" end="2016-10-01">
          <period code="07/2016" label="Jul-2016" shortName="Jul-2016" stratumId="1" timeslot="198" encodedTimePeriod="1::198" id="198001" end="2016-08-01" />
          <period code="08/2016" label="Aug-2016" shortName="Aug-2016" stratumId="1" timeslot="199" encodedTimePeriod="1::199" id="199001" end="2016-09-01" />
          <period code="09/2016" label="Sep-2016" shortName="Sep-2016" stratumId="1" timeslot="200" encodedTimePeriod="1::200" id="200001" end="2016-10-01" />
        </period>
        <period code="Q4-2016" label="Q4-FY16" shortName="Q4-FY16" stratumId="2" timeslot="67" encodedTimePeriod="2::67" id="67002" end="2017-01-01">
          <period code="10/2016" label="Oct-2016" shortName="Oct-2016" stratumId="1" timeslot="201" encodedTimePeriod="1::201" id="201001" end="2016-11-01" />
          <period code="11/2016" label="Nov-2016" shortName="Nov-2016" stratumId="1" timeslot="202" encodedTimePeriod="1::202" id="202001" end="2016-12-01" />
          <period code="12/2016" label="Dec-2016" shortName="Dec-2016" stratumId="1" timeslot="203" encodedTimePeriod="2::203" id="203001" end="2017-01-01" />
        </period>
      </period>
    </time>
  </output>
</response>

Formato de resposta parcial (com includeAllLocales="1")

Normalmente, há um bloco de parâmetros regionais para cada período e estrato. Abaixo, apenas a seção do estrato é mostrada. O bloco de parâmetros regionais/parâmetros regionais para os períodos tem formato idêntico.


          <stratum code="year" label="Year" shortName="Year" id="3">
            <locales>
                <locale locale="en" label="Year" shortName="Year" />
                <locale locale="de" label="Jahr" shortName="Jahr" />
                <locale locale="fr" label="Anne" shortName="Anne" />
                <locale locale="es" label="Ao" shortName="Ao" />
                <locale locale="pt" label="Ano" shortName="Ano" />
                <locale locale="nl" label="Jaar" shortName="Jaar" />
                <locale locale="ja" label="年" shortName="年" />
            </locales>
            <stratum code="qtr" label="Quarter" shortName="Quarter" id="2">
                <locales>
                    <locale locale="en" label="Quarter" shortName="Quarter" />
                    <locale locale="de" label="Quartal" shortName="Quartal" />
                    <locale locale="fr" label="Trimestre" shortName="Trimestre" />
                    <locale locale="es" label="Trimestre" shortName="Trimestre" />
                    <locale locale="pt" label="Trimestre" shortName="Trimestre" />
                    <locale locale="nl" label="Kwartaal" shortName="Kwartaal" />
                    <locale locale="ja" label="四半期" shortName="四半期" />
                </locales>
                <stratum code="month" label="Month" shortName="Month" id="1" isDefault="1">
                    <locales>
                        <locale locale="en" label="Month" shortName="Month" />
                        <locale locale="de" label="Monat" shortName="Monat" />
                        <locale locale="fr" label="Mois" shortName="Mois" />
                        <locale locale="es" label="Mes" shortName="Mes" />
                        <locale locale="pt" label="Ms" shortName="Ms" />
                        <locale locale="nl" label="Maand" shortName="Maand" />
                        <locale locale="ja" label="月" shortName="月" />
                    </locales>
                </stratum>
            </stratum>
        </stratum>

elemento de resposta
Nome da etiqueta		resposta
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito	S	Verdadeiro ou falso, indicando se a chamada à API foi bem-sucedida ou não. Mesmo as chamadas bem-sucedidas podem conter mensagens de aviso em sua resposta.	verdadeiro
obsoleto	N	Se presente na etiqueta de resposta e definido como verdadeiro, esse atributo indica que a versão do método ou da API que está sendo invocada se tornou obsoleta e está oficialmente obsoleta. Embora continue a funcionar neste momento, pode deixar de funcionar em breve. Normalmente, esse atributo não está presente.	false
Conteúdo do elemento
Um único elemento de mensagens opcional e exatamente um elemento de saída obrigatório.

elemento de mensagens
Nome da etiqueta		mensagens
Descrição		Contêiner para um ou mais elementos de mensagem.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais elementos de mensagem.

elemento de mensagem
Nome da etiqueta		mensagem
Descrição		Representa uma mensagem que está sendo enviada pelo sistema de volta para o autor da chamada. As mensagens são usadas para mensagens de erro quando as solicitações não são bem-sucedidas, para mensagens de aviso quando as solicitações são bem-sucedidas e para mensagens de confirmação quando as solicitações são bem-sucedidas.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
chave	N	Quando fornecida, uma chave é uma forma de identificar uma determinada mensagem ou tipo de mensagem, útil para fins de registro automatizado de erros e recuperação em programas cliente. As chaves não são alteradas em diferentes parâmetros regionais de solicitações, mesmo quando o idioma da mensagem é alterado. As chaves também não devem ser alteradas no futuro devido a ajustes de texto ou alterações de terminologia.	invalid-attributevalueid
Conteúdo do elemento
O texto da mensagem. Esse texto está no idioma dos parâmetros regionais especificados na solicitação (supondo que haja suporte para os parâmetros regionais). O texto também pode conter informações variáveis, como o número de linhas que foram processadas ou a coluna ou valor específico que causou um erro.

elemento de saída
Nome da etiqueta	saída
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um único elemento de tempo obrigatório. Esse invólucro de saída é padrão em todas as respostas de API e inclui a saída válida de qualquer chamada de API bem-sucedida.

elemento de tempo
Nome da etiqueta		time
Descrição		Contêiner para um elemento do estrato-raiz, zero ou um elemento de saldo inicial e um ou mais elementos de período do estrato-raiz.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
isCustom	S	1 ou 0, indicando se o calendário desta instância foi personalizado ou não.	1
q1FirstMonth	N	O mês em que o exercício fiscal começa (a partir de 0). Esse atributo aparece somente se includeLegacyInformation era 1 na solicitação e se isCustom é 0.	8
lastMonthIsFY	N	Indica se o exercício fiscal é equivalente ao ano-calendário em que o exercício fiscal termina. Esse atributo aparece somente quando includeLegacyInformation era 1 na solicitação e se isCustom é 0.	0
seqNo Adicionado na API v17, mas reservado para uso futuro.
Conteúdo do elemento
Exatamente um elemento de estrato, zero ou um elemento de saldo inicial e um ou mais elementos de período do estrato-raiz.

elemento do estrato
Nome da etiqueta		stratum
Descrição		Representa um estrato do calendário que está sendo retornado da chamada à API exportTime.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Um identificador exclusivo definido pelo usuário para o estrato de tempo.	Ano
rótulo	S	Um identificador de texto não exclusivo e definido pelo usuário para o estrato de tempo.	Exercício fiscal
shortName	S	Um identificador de texto não exclusivo e definido pelo usuário, usado quando um nome mais curto é desejado. Se um nome curto não for definido, o rótulo será exibido aqui.	Ano
ID	S	O identificador de número inteiro exclusivo gerado pelo sistema para o estrato de tempo.	7
inUse Com suporte na API v16 +	N	Sinalizador que indica se uma planilha de cubo ou uma planilha modelada está associada ao estrato de tempo ou se este é o estrato de tempo por padrão.	1
isDefault Com suporte na API v16 +	N	Indicador que indica se o estrato de tempo é o estrato por padrão ou não.	1
Conteúdo do elemento
Zero ou um elemento de parâmetros regionais. Isso só é incluído se includeAllLocales está definido. Zero ou um elemento de estrato. Todo estrato, exceto o folha, tem exatamente um elemento de estrato. O elemento folha do estrato tem zero elementos de estrato contidos.

elemento de saldo inicial
Nome da etiqueta		saldo inicial
Descrição		Representa o último período folha antes do início da versão que está sendo retornada em resposta a uma chamada à API exportTime. Isso é incluído somente se uma única versão é solicitada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	O identificador exclusivo definido pelo usuário para o período do saldo inicial.	12/2003
rótulo	S	O identificador de texto não exclusivo e definido pelo usuário para o período do saldo inicial.	Dec-2003
nome curto	S	O identificador de texto curto, não exclusivo e definido pelo usuário, para o período do saldo inicial. Se nenhum nome curto foi definido, o rótulo é exibido.	Dez
stratumId	S	A ID do estrato ao qual o saldo inicial pertence.	1
intervalo de tempo	S	O intervalo de tempo do período ao qual o saldo inicial pertence.	47
encodedTimePeriod	S	Os dados codificados para o período, no formato de strutumId::timeslot.	1::47
ID	S	O identificador de número inteiro exclusivo gerado pelo sistema para o período do saldo inicial.	47001
início	S	A data de início (inclusive) do saldo inicial, no formato AAAA-MM-DD.	2003-12-01
fim	S	A data de término (exclusiva) do saldo inicial, no formato AAAA-MM-DD.	2004-01-01
legacyReportTimeId	N	A ID do relatório que seria exibida para este período em versões anteriores desta API. Esse atributo aparece somente quando includeLegacyInformation era 1 na solicitação e se isCustom é 0.	200312
legacySheetTimeId	N	A ID de tempo da planilha que seria usada para este período em versões anteriores desta API. Esse atributo aparece somente quando includeLegacyInformation era 1 na solicitação e se isCustom é 0.	48, Q63 ou Y72
Conteúdo do elemento
Zero ou um elemento `de parâmetros regionais` .

Elemento de período
Nome da etiqueta		período
Descrição		Representa um único período do calendário que está sendo retornado da chamada à API exportTime.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Um identificador exclusivo definido pelo usuário para o período.	T1-2004
rótulo	S	Um identificador de texto não exclusivo e definido pelo usuário para o período.	Q1-FY04
shortName	S	Um identificador de texto não exclusivo e definido pelo usuário, usado quando um nome mais curto é desejado. Se um nome curto não for definido, o rótulo será exibido aqui.	T1
stratumId	S	A ID do estrato ao qual o período pertence.	2
ID	S	O identificador de número inteiro exclusivo gerado pelo sistema para o período.	16002
início	S	A data de início (inclusive) do período, no formato AAAA-MM-DD.	2004-01-01
fim	S	A data de término (exclusiva) do período, no formato AAAA-MM-DD.	2004-04-01
legacyReportTimeId	N	A ID do relatório que seria exibida para este período em versões anteriores desta API. Esse atributo aparece somente quando includeLegacyInformation era 1 na solicitação e se isCustom é 0.	200491
legacySheetTimeId	N	A ID de tempo da planilha que seria usada para este período em versões anteriores desta API. Esse atributo aparece somente quando includeLegacyInformation era 1 na solicitação e se isCustom é 0.	48, Q63 ou Y72
Conteúdo do elemento
Zero ou um elementos de parâmetros regionais.

Elemento de parâmetros regionais
Nome da etiqueta		parâmetros regionais
Descrição		Contêiner para um ou mais elementos `de parâmetros regionais` .
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais elementos de parâmetros regionais.

elemento de parâmetros regionais
Nome da etiqueta		parâmetros regionais
Descrição		Descrição dos parâmetros regionais. Observe que o texto seguirá as regras de contingência de parâmetros regionais.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
parâmetros regionais	S	O código para os parâmetros regionais.	en
rótulo	S	O rótulo localizado para o período/estratos.	FY2016
shortName	S	O nome curto localizado para o período/estratos.	2016
Conteúdo do elemento
(nenhum)

exportSheet

exportTransactionDefinition

Este conteúdo foi útil?

O que precisamos melhorar? Informações corretas Responde à minha pergunta Fácil de encontrar Fácil de entender Ajuda a concluir minha tarefa Informações completas e detalhadas

O que precisamos melhorar? Informações incorretas Não responde à minha pergunta Não é fácil de encontrar Não é fácil de entender Não ajuda a concluir minha tarefa Informações incompletas ou pouco detalhadas

Conte-nos sobre a tarefa que você está executando. Quais informações adicionais podem melhorar este conteúdo? Há mais algum detalhe que gostaria de compartilhar?

Nome completo

E-mail

A Workday usará seu nome e e-mail para fornecer respostas relacionadas ao seu feedback. Suas informações serão tratadas de acordo com a nossa Declaração de Privacidade.

Agradecemos seu feedback