exportVersions

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: 2024-09-20

exportVersions

Atualizado na API v40. (21 de setembro de 2024)

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

Categoria	Recuperação de metadados
Descrição	Uma vez verificado, o método retorna um documento XML que descreve o conjunto de todas as versões definidas na instância que não estão ocultas do usuário solicitante.
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 apenas uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada. Uma vez verificado, o método retorna um documento XML que descreve o conjunto de todas as versões definidas na instância que não estão ocultas do usuário solicitante.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportVersions" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</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)

incluir elemento
Nome da etiqueta		incluir
Descrição		Representa um conjunto de indicadores que indicam quais aspectos das informações da versão devem ser incluídos ou excluídos da resposta. Esse elemento é opcional: se não estiver presente, a API retornará todas as informações da versão.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
rootActuals Sem suporte em nenhuma versão de API a partir da versão 2019.3	N	Indica se a versão de valores reais raiz deve ser incluída quando os valores reais estão ocultos no seletor de versão.	false
cenários	N	Indica se cenários hipotéticos privados devem ser incluídos na resposta.	false
currencyVersions Disponível na API v40+	N	Indica se versões de moeda para valores reais convertidos devem ser incluídas na resposta. Você deve entrar em contato com seu contato de suporte designado para verificar se sua instância é elegível para essa funcionalidade.	false
Conteúdo do elemento
(nenhum)

Formato da resposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<versions seqNo="32">
  <version id="1" name="Actuals" shortName="" type="ACTUALS" isVirtual="false" description="Total Actuals" isDefaultVersion="false"
           isLocked="false" hasAuditTrail="false" isImportable="0"
           startVer="2012" completedValuesThru="03/2012"
           startScroll="01/2012" endVer="2016" lockLeading="" >
    <version id="5" name="Adjusted Actuals" shortName="SV-13" type="ACTUALS" isVirtual="false" description="Actuals SubVersion" isDefaultVersion="false"
             isLocked="false" hasAuditTrail="false" isImportable="0" >
      <version id="6" name="Original Import" shortName="SSV-13" type="ACTUALS" isVirtual="false" description="Values Imported from the GL" isDefaultVersion="false"
               isLocked="false" hasAuditTrail="false" isImportable="1" />
      <version id="8" name="Manual Adjustments" shortName="SSV-14" type="ACTUALS" isVirtual="false" description="Actuals Sub-Version for Manual Adjustments" isDefaultVersion="false"
               isLocked="false" hasAuditTrail="true" isImportable="1" />
    </version>
    <version id="9" name="Eliminations" shortName="ELIM" type="ACTUALS" isVirtual="false" description="Eliminating entries" isDefaultVersion="false"
             isLocked="false" hasAuditTrail="false" isImportable="0" />
  </version>
  <version id="2" name="Budget 2013" shortName="" type="PLANNING" isVirtual="false" description="This is the budget for 2013 with a five-year span." isDefaultVersion="true"
           isLocked="false" hasAuditTrail="true" isImportable="1"
           leftScroll="2013" startPlan="01/2013" endPlan="2017" lockLeading="05/2013" />
    <version id="10" name="Worst Case" shortName="S13-A-WC" type="SCENARIO" isVirtual="false" description="Worst Case for Budget 2013" isDefaultVersion="false" isLocked="false"
             hasAuditTrail="false" isImportable="0" isPredictive="false" />
  </version>
 <version id="3" name="Budget 2014" shortName="B-14" type="PLANNING" isVirtual="false" description="This is the budget for 2014 with a five-year span." isDefaultVersion="false"
           isLocked="false" hasAuditTrail="false" isImportable="1"
           leftScroll="2014" startPlan="01/2014" endPlan="2018" lockLeading="" />
</versions>
</output>
</response>

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 na 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á 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 saída
Nome da etiqueta	saída
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um único elemento de contas. 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 versões
Nome da etiqueta		versões
Descrição		Contêiner para um ou mais elementos de versão.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
seqNo Adicionado na API v17, mas reservado para uso futuro.
Conteúdo do elemento
Um ou mais elementos de versão.

elemento de versão
Nome da etiqueta		versão
Descrição		Representa uma única versão que está sendo retornada em resposta a uma chamada à API exportVersions.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número de ID do sistema interno da versão ou pasta. Todas as IDs são exclusivas entre todas as versões, subversões e pastas.	2
nome	S	O nome da versão ou pasta, conforme aparece em Administração de versão.	Orçamento de 2015
shortName	N	Um nome curto para a versão, se houver, conforme informado em Administração de versão	B2015
type Atualizado na API v37.	S	Um dos seguintes valores: ACTUALS = Versão ou subversão de valores reais padrão JOURNAL_ENTRY = Subversão de valores reais do lançamento PLANNING = Versão de plano VERSION_FOLDER = Pasta SCENARIO = Um cenário hipotético pessoal	VALORES REAIS
isVirtual Disponível na API v16+	S	verdadeiro ou falso para indicar se esta é uma versão virtual	false
descrição	S	A descrição da versão ou pasta, conforme aparece em Administração de versão.	Este é o orçamento para 2015 com um período de cinco anos.
isDefaultVersion	S	Informa se a versão é a versão por padrão. Verdadeiro se a versão é a versão por padrão, caso contrário, é falso.	verdadeiro
isLopped	N	Indica se a versão foi "bloqueada globalmente" (tem a caixa de seleção Versão bloqueada marcada). Se não está presente, a versão não é considerada bloqueada. Sempre será "falso" para versões de valores reais ou para pastas.	verdadeiro
hasAuditTrail	S	Indica se a versão tem trilha de auditoria habilitada.	verdadeiro
enabledForWorkflow Disponível na API v17+	N	Indica se a versão está habilitada para o fluxo de trabalho.	1
isImportable	N	Indica se o usuário que está solicitando essa API tem permissão para importar dados para a versão. 0 significa que a versão não pode aceitar importações e 1 significa que ela pode. Uma versão é importável se pelo menos um intervalo de tempo na versão especificada é importável para este usuário.	1
startVer	N	O código do período raiz no qual a versão é iniciada. Equivalente ao início da versão na página de administração da versão. Esse atributo é mostrado apenas para a versão de valores reais raiz. Esse atributo é obrigatório para a versão de valores reais raiz.	2015
endVer	N	O código do período raiz em que a versão termina. Equivalente ao fim da versão na página de administração da versão. Esse atributo é mostrado apenas para a versão de valores reais raiz. Esse atributo é obrigatório para a versão de valores reais raiz.	2015
startScroll	N	O código do período folha em que o planejamento começa. Equivale ao início da localização de rolagem na página de administração de versão. Esse atributo é mostrado apenas para a versão de valores reais raiz. Esse atributo é obrigatório para a versão de valores reais raiz.	01/2015
completedValuesThru	N	O código do período folha mais recente para o qual os valores reais raiz têm dados preenchidos. Em um calendário padrão, seria um mês. Equivalente aos valores concluídos até na página de administração de versão. Esse atributo é mostrado apenas para a versão de valores reais raiz. Esse atributo é opcional para a versão de valores reais raiz.	03/2015
leftScroll	N	O código do período raiz no qual a versão é iniciada. Equivalente ao limite de rolagem à esquerda na página de administração de versão. Esse atributo é mostrado apenas para versões de planejamento. Esse atributo é obrigatório para versões de planejamento.	2015
startPlan	N	O código do período folha em que o planejamento começa. Equivalente ao início do plano na página de administração de versão. Esse atributo é mostrado apenas para versões de planejamento e é obrigatório para versões de planejamento.	02/2015
endPlan	N	O código do período raiz em que a versão termina. Equivalente ao fim do plano na página de administração da versão. Esse atributo é mostrado apenas para versões de planejamento. Esse atributo é obrigatório para versões de planejamento.	2015
lockLeading	N	O código do período folha até o qual os valores de versão estão bloqueados. Equivale ao bloqueio dos meses anteriores até na página de administração de versão. Esse atributo é mostrado apenas para a versão de valores reais raiz e versões de planejamento. Esse atributo é opcional para a versão de valores reais raiz e para as versões de planejamento.	05/2015
isPredictive Disponível na API v28 +	S	Indica se a versão é uma versão preditiva.	false
Conteúdo do elemento
Um elemento de versão aninhada para cada versão filho direta desta versão.

exportUsers

importDimensionMapping

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