exportData

Adaptive Planning

Novidades (Workday 2025R2)

exportData

Categoria	Recuperação de dados
Descrição	Retorna um conjunto de dados da versão solicitada na instância da solicitação.
Permissões obrigatórias para invocar	Nenhum (devem ser credenciais válidas para a instância)
Parâmetros obrigatórios na solicitação	Credenciais, versão, formato, filtros

A solicitação desse método contém os parâmetros que serão usados para pesquisar os dados na versão especificada e retornar valores que correspondem aos filtros e ao formato solicitados. Esse é o método básico usado para recuperar dados do Adaptive Planning e pode ser usado para recuperar valores de qualquer conta, incluindo contas padrão, contas LR, contas modeladas, contas de cubo, contas personalizadas, contas de métrica, suposições e taxas cambiais.

Se você exportar uma versão de plano, sua exportação incluirá dados de valores reais para todos os períodos de sobreposição de valores reais. Você verá os valores reais ou os dados do plano como veria na interface de usuário das planilhas.

Valores em divisões individuais são agregados quando exportados por

exportData.

Para a API v16 e posteriores,

exportData

também exporta dados para versões virtuais.

Consulte customReportValuespara uma abordagem mais direcionada à recuperação de dados.

Consulte Referência: desempenho do exportData para saber como garantir que suas solicitações aproveitem as melhorias de desempenho e escalabilidade lançadas na versão 2024R1 para a API v39.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportData" callerName="a string that identifies your client application" stream="true">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
<version name="Budget 2014" isDefault="false"/>
<format useInternalCodes="true" includeUnmappedItems="false" />
<filters>
<accounts>
<account code="A100" isAssumption="true" includeDescendants="false"/>
<account code="L100" isAssumption="false" includeDescendants="true"/>
</accounts>
<levels>
<level name="Development" isRollup="true" includeDescendants="true"/>
<level name="QA" isRollup="false" includeDescendants="false"/>
</levels>
<dimensionValues>
<dimensionValue dimName="Customer" name="A Corp" directChildren="true"/>
<dimensionValue dimName="Region" name="" uncategorized="true" directChildren="false"/>
</dimensionValues>
<timeSpan start="11/2013" end="12/2014"/>
</filters>
<dimensions>
<dimension name="Product"/>
<dimension name="CountryRegion"/>
</dimensions>
<rules includeZeroRows="false" includeRollups="false" markInvalidValues="false" markBlanks="false" timeRollups="single">
<currency useCorporate="false" useLocal="false" override="AUD"/>
</rules>
</call>

Cada invocação desta chamada de API deve conter exatamente um elemento de cada um dos tipos listados:

chamada

credenciais

versão

formato

Uma solicitação também pode conter um dos seguintes elementos:

filtros

contas > conta

níveis > nível

dimensionValues > dimensionValue

timeSpan

dimensões > dimensão

regras > moeda

elemento de chamada
Nome da etiqueta		chamada
Descrição		Indica qual método de API está sendo chamado usando seu atributo de método.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
método	S	O método que está sendo chamado.	exportData
callerName	S	Uma cadeia de caracteres que identifica seu aplicativo cliente.	"exemplo de aplicativo cliente do Adaptive Planning"
fluxo Disponível na API v39+	N	Permite que o exportData comece a transmitir dados de volta para o cliente assim que são processados. Por padrão, é definido como falso. Observe que a habilitação do streaming em exportData requer alterações no formato da resposta.	verdadeiro
Conteúdo do elemento
Exatamente um elemento de cada um destes tipos: credenciais versão formato

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 é 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 seja bem-sucedida. .. A permissão Recursos de exportação na UI do Planning não afeta o exportData.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
conectar-se	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 versão
Nome da etiqueta		versão
Descrição		Indica qual versão deve ser usada para recuperar os dados solicitados. Uma versão deve ser fornecida para cada chamada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	N	O nome da versão a ser usada para receber os dados. Somente uma versão pode ser acessada em uma única chamada de API. Se um nome não é fornecido, o indicador isDefault deve ser definido como verdadeiro nesse elemento.	Orçamento de 2014
isDefault	N	Se o autor da chamada deseja acessar a versão por padrão atual da instância, independentemente do nome, esse atributo pode ser definido como verdadeiro; nesse caso, o atributo de nome da etiqueta (se presente) é ignorado. Caso contrário, se esse valor é falso ou se esse atributo não está presente, uma versão com o nome fornecido deve existir e estar acessível ao usuário para que essa chamada seja bem-sucedida.	false
Conteúdo do elemento
(nenhum)

elemento de formato
Nome da etiqueta		formato
Descrição		Indica o tipo de formatação que deve ser usada nos campos individuais dos dados a serem retornados.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
useInternalCodes	S	Defina como "Verdadeiro" para que os códigos de conta e de nível sejam emitidos usando os códigos de cada um inseridos em Administradores de conta e de nível. Defina como "falso" para que os códigos sejam mapeados nos dados de saída usando Exportar mapeamentos de conta ou Exportar mapeamentos de nível, encontrados na guia Exportar.	verdadeiro
useIds	N	Defina como "true" para que as contas, os níveis e as dimensões nas respostas sejam expressos em suas IDs, em vez de em seus códigos. Além disso, exigirá que as contas, os níveis e as dimensões na seção sejam expressos em suas IDs. O valor por padrão é "falso" se não estiver presente na solicitação.	verdadeiro
includeUnmappedItems	N	Esse atributo se aplica somente se useInternalCodes é falso e os mapeamentos de exportação são usados. Se não for especificado de outra forma, os itens que não têm Mapeamento de exportação na guia Exportar não serão emitidos na saída. Se includeUnmappedItems é definido como "true", contas ou níveis que não têm mapeamento de exportação serão emitidos usando seus códigos internos (os definidos em Administração de conta ou de nível), resultando em uma combinação de itens mapeados e não mapeados no dados, mas um conjunto completo de dados. Se esse indicador é definido como "falso", alguns itens solicitados podem não ser emitidos se não tiverem mapeamento de exportação.	false
includeCodes	N	Essa opção é significativa somente quando a configuração de habilitação efetiva do nome de exibição está ATIVADA. Defina como "true" para incluir a coluna de código do nível na resposta da API. Defina como "falso" para excluir a coluna de código do nível na resposta da API. O valor por padrão é falso.	false
includeNames Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	Essa opção é significativa somente quando a configuração de habilitação efetiva do nome de exibição está ATIVADA. Defina "true" para incluir a coluna de nome do nível na resposta da API. Defina "falso" para excluir a coluna de nome do nível na resposta da API. O valor por padrão é falso.	false
includeDisplayNames Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	Essa opção é significativa somente quando a configuração de habilitação efetiva do nome de exibição está ATIVADA. Defina "true" para incluir a coluna de nome de exibição do nível na resposta da API. Defina "falso" para excluir a coluna de nome de exibição do nível na resposta da API. O valor por padrão é falso.	false
displayNameEnabled Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	displayNameEnabled=true indica que a API exportData requer o atributo de código na solicitação para especificar as entidades de nível e dimensão quando Habilitar nome de exibição está ATIVADO para a instância. displayNameEnabled=false indica que a API exportData continua seguindo o contrato de API anterior à versão 30, mesmo quando a configuração Habilitar nome de exibição está ATIVADA para a instância. O atributo de nome é usado em vez do atributo de código. Para cada nível e dimensão, os valores dos atributos de nome e código devem corresponder. O valor por padrão para displayNameEnabled é "falso".	false
Conteúdo do elemento
(nenhum)

Elemento de filtros
Nome da etiqueta	filtros
Descrição	Contém a especificação dos filtros que determinam quais dados da versão solicitada são recuperados pela API. Esse elemento especifica as contas, os níveis, os meses e os valores de dimensão que serão recuperados.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um único elemento de contas obrigatório, um único elemento de níveis opcional, um único elemento timeSpan obrigatório e um elemento de dimensionValues único opcional.

elemento de contas
Nome da etiqueta	contas
Descrição	Contêiner para um ou mais elementos de conta.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um ou mais elementos de conta.

elemento de conta
Nome da etiqueta		account
Descrição		Especifica uma conta para que os dados sejam exportados na chamada à API exportData. Se mais de um elemento de conta é inserido dentro do elemento de contas, todas as contas que correspondem a qualquer um dos elementos de conta são exportadas. Se um determinado elemento de conta não resulta em contas que o correspondam, esse elemento é ignorado, enquanto os outros elementos ainda se aplicam.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	O código da conta a ser exportada. Esse código é conforme especificado em Administração de conta.	Current_Assets
isAssumption	S	Indica se o código especifica uma conta de suposição ou não de suposição. Você pode usar um único código para uma suposição e uma conta. Use esse indicador para indicar o tipo de conta.	false
includeDescendants	S	Indica se a exportação deve incluir todos os descendentes da conta especificada ou não. Se definida como verdadeira, todos os filhos desta conta serão exportados, assim como seus filhos etc. Se definida como falsa, essa conta será exportada como um único valor de conta de consolidação.	verdadeiro
Conteúdo do elemento
(nenhum)

elemento de níveis
Nome da etiqueta	níveis
Descrição	Contêiner para um ou mais elementos de nível.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um ou mais elementos de nível. Se a solicitação incluir níveis inacessíveis, haverá apenas um elemento de nível, que representa o nível superior da organização.

elemento de nível
Nome da etiqueta		level
Descrição		Especifica um nível da organização para que os dados sejam exportados na chamada à API exportData. Se mais de um elemento de nível é inserido dentro do elemento de níveis, todos os níveis especificados são exportados. Se um determinado elemento de nível não tem níveis correspondentes na instância, esse elemento é ignorado, enquanto os outros elementos ainda se aplicam. Você deve filtrar por código em vez de nome quando atender a todas estas condições: A instância habilita metadados duplicados ativando o Nome de exibição. Chamando a API v30 ou superior. Na propriedade displayNameEnabled, o elemento de formato é verdadeiro.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	S O código é sempre mutuamente exclusivo com o nome. Quando essas duas condições se aplicam, você deve usar apenas o código: A configuração Habilitar nome de exibição está ATIVADA displayNameEnabled="true" no elemento de formato Caso contrário, não inclua o código.	O código do nível a ser exportado. Esse código é especificado em Administração da organização. O código tem suporte somente quando a configuração de habilitação efetiva do nome de exibição está ATIVADA.	Desenvolvimento
nome	S O nome é sempre mutuamente exclusivo com o código. Quando displayNameEnabled="false" no elemento de formato, você deve usar apenas o nome. Esse é o valor por padrão, se não especificado.	O nome do nível a ser exportado. Esse nome é conforme especificado em Administração da organização. O nome só tem suporte para solicitações de API anteriores à versão 30 quando a habilitação efetiva das configurações de nome de exibição está DESATIVADA. Como a API recupera níveis combinando seu atributo de código com a cadeia de caracteres de nome incluída na solicitação, o atributo de nome é tratado funcionalmente como o atributo de código. Para recuperar níveis por nomes com êxito, os atributos de nome e código devem corresponder.	Desenvolvimento
isRollup	S	Se este nível tem filhos, isRollup="true" gerará o valor consolidado para o nível (incluindo os valores de todos os filhos) e isRollup="false" só gerará o valor sem categoria para o nível (os valores inseridos em Editar Dados para esse nível). Se esse nível não tem filhos, isRollup deve ser definido como falso (ou totalmente omitido da etiqueta).	false
includeDescendants	S	Indica se a exportação deve incluir todos os descendentes do nível especificado ou não. Se definida como verdadeira, todos os filhos deste nível também serão exportados, assim como seus filhos etc. Se definido como falso, este nível será exportado sozinho. Observe que isso é diferente de isRollup: isRollup afeta qual valor será gerado para esse nível, enquanto include Descendants indica se os descendentes também devem ser incluídos na exportação. Se isRollup e includeDescendants são definidos como verdadeiros e o nível é um nível pai, a saída conterá valores para os níveis de consolidação e não consolidação (sem categoria) para este nível e cada um de seus descendentes.	verdadeiro
Conteúdo do elemento
(nenhum)

timeSpan element
Nome da etiqueta		timeSpan
Descrição		Indica quais períodos devem ser retornados na resposta. Os períodos entre o intervalo especificado, inclusive, são incluídos na saída como colunas de dados separadas. eles não são agregados ou consolidados.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
início	S	O código do primeiro período no intervalo de períodos para a exportação dos dados. O período de início deve ser um período folha.	01/2015
fim	S	O código do último período no intervalo de períodos para a exportação dos dados. O período de término deve ser um período folha.	03/2015
stratum	N	O código do estrato de tempo dos dados exportados. Quando especificados, os períodos de início e de término devem estar dentro do estrato de tempo. O estrato de tempo deve ser igual ou posterior ao da conta com o estrato de tempo mais alto na solicitação. Consulte: Alterar os estratos de tempo por padrão. Alterar estratos de tempo por padrão em planilhas de cubo e planilhas modeladas com dados. Por exemplo, a indicação do estrato Trimestre requer que todas as contas tenham o estrato Trimestre, Ano ou superior.	month
Conteúdo do elemento
(nenhum)

dimensionValues element
Nome da etiqueta	dimensionValues
Descrição	Contêiner para um ou mais elementos dimensionValue. Esse elemento é opcional e não deve ser exibido se você não quer filtrar o valor de dimensão.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um ou mais elementos dimensionValue.

dimensionValue element
Nome da etiqueta		dimensionValue
Descrição		Indica que os dados exportados devem conter apenas valores que correspondem ao dimensionValue especificado. Vários valores de dimensões diferentes no elemento dimensionValues funcionam como se estivessem agrupados por suas dimensões. Os dados são retornados se pelo menos um dos dimensionValues corresponde a cada dimensão. Para dimensionValues na mesma dimensão, os dados podem corresponder a qualquer valor de dimensão. Por exemplo, se uma solicitação especifica os valores de dimensão Region=East, Region=West e Product=Product_A, os dados devem corresponder à região East ou West, mas também devem corresponder ao Product_A Product para que sejam exportados. Você deve filtrar por código em vez de nome quando atender a todas estas condições: A instância habilita metadados duplicados ativando o Nome de exibição. Chamando a API v30 ou superior. A propriedade displayNameEnabled do elemento de formato é verdadeira.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
dimName	N	O nome da dimensão à qual o valor de dimensão (consulte atributo de nome abaixo) pertence.	Região
código Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	O código do valor de dimensão a ser exportado. O atributo de código é significativo somente quando a configuração de habilitação efetiva do nome de exibição está ATIVADA para a instância.
nome	N	O nome do valor de dimensão a ser exportado. O nome só tem suporte para solicitações de API anteriores à versão 30 quando a habilitação efetiva das configurações de nome de exibição está DESATIVADA.	Oeste dos EUA
directChildren	N	Se definida como verdadeira, fará com que a API exporte dados consolidados para cada um dos filhos diretos deste valor de dimensão, mas não uma consolidação para o valor em si. Em outras palavras, isso fará com que exportData exporte os valores "um nível abaixo" na árvore de dimensões a partir do valor especificado. Se não especificado, o valor por padrão é falso.	false
não categorizado	N	Se definida como verdadeira, corresponde ao valor "sem categoria" do valor da dimensão e não aos valores de qualquer um de seus valores descendentes (se houver). Não tem efeito sobre valores de dimensão sem filhos. Se não especificado, o valor por padrão é falso.	verdadeiro
uncategorizedOfDimension	N	Especifique o uncategorizedOfDimension no lugar dos atributos dimName/name. Se especificado, o valor do atributo deve ser um número de ID do sistema interno de uma dimensão (não um valor de dimensão), e o filtro especifica que os dados devem estar completamente sem categoria nessa dimensão para corresponder ao filtro. Os atributos diretoCrianças e sem categoria serão ignorados e considerados falsos e verdadeiros, respectivamente. Ignorado se dimName é especificado.	15
directChildrenOfDimension	N	Especifique o directChilrenOfDimension no lugar dos atributos dimName/Name. Se especificado, o valor do atributo deve ser um número de ID do sistema interno de uma dimensão (não um valor de dimensão), e o filtro deve especificar todos os valores de dimensão de primeiro nível da dimensão. Os atributos diretoCrianças e sem categoria serão ignorados e considerados verdadeiros e falsos, respectivamente. Ignorado se dimName ou uncategorizedOfDimension é especificado.	12
ID	N	Especifique a ID no lugar dos atributos dimName/Name. O número de ID do sistema interno do valor de dimensão a ser exportado. Deve ser especificado no lugar dos atributos dimName/name para especificar o valor da dimensão. Para determinar IDs internas, consulte a API exportDimensions. Ignorado se dimName, uncategorizedOfDimension ou directChildrenOfDimension é especificado.	14
Conteúdo do elemento
(nenhum)

elemento de dimensões
Nome da etiqueta	dimensões
Descrição	Contêiner para um ou mais elementos de dimensão.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um ou mais elementos de dimensão.

elemento de dimensão
Nome da etiqueta		dimensão
Descrição		Indica que os dados exportados devem ser decompostos ou fatiados pela dimensão especificada. Observe que essa etiqueta não faz parte da etiqueta de filtros e não controla a filtragem. Ela controla quantas linhas são exportadas para cada combinação de conta/nível. Para cada dimensão especificada na etiqueta de dimensões, cada combinação de valores existente será exportada como uma linha de dados separada. Cada dimensão presente no elemento dimensões também faz com que uma coluna extra apareça na saída, rotulada com o nome dessa dimensão.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	Nome da dimensão pela qual a exportação deve ser segmentada. Linhas de dados na exportação que não podem ser segmentadas pela dimensão serão exibidas apenas uma vez e mostrarão o próprio nome da dimensão na coluna em que o nome do valor dessa dimensão seria exibido.	Cliente
Conteúdo do elemento
(nenhum)

elemento de regras
Nome da etiqueta		regras
Descrição		Especifica algumas regras de saída adicionais que controlam quais tipos de linhas são emitidos e como alguns valores de campo são renderizados.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
includeZeroRows	N	Defina como "true" para emitir linhas, mesmo que contenham apenas zeros ou espaços em branco. Defina como "falso" para omitir linhas sem dados da saída. O valor por padrão é falso. Essa opção não está disponível na interface de usuário do aplicativo para exportações que incluem dimensões. Para chamadas de API, Verdadeiro é ignorado na exportação de dados por dimensão. Emite dados somente para valores de dimensão que têm dados.	verdadeiro
includeRollups Disponível na API v24 e anteriores. Não disponível na API v25+.	N	Se definida como verdadeira, os valores de consolidação de todas as contas e níveis na etiqueta de filtros serão incluídos, além dos valores de seus descendentes. Esse atributo não afeta o comportamento das dimensões personalizadas especificadas nos filtros dimensionValue ou na etiqueta de dimensões. O valor por padrão é falso. O indicador includeRollups se aplica somente quando nenhuma filtragem explícita está sendo aplicada para contas ou níveis. Se contas individuais são incluídas em um filtro, você precisa especificar as contas individuais de consolidação, se quiser que elas sejam incluídas.	false
includeRollupAccounts Disponível na API v25+.	N	Se definida como verdadeira, os valores consolidados de todas as contas na etiqueta de filtros serão incluídos, além dos valores de seus descendentes. Esse atributo não afeta o comportamento das dimensões personalizadas especificadas nos filtros dimensionValue ou na etiqueta de dimensões. O valor por padrão é falso.	false
includeRollupLevels Disponível na API v25+.	N	Se definida como verdadeira, os valores consolidados de todos os níveis na etiqueta de filtros serão incluídos, além dos valores dos respectivos descendentes. Esse atributo não afeta o comportamento das dimensões personalizadas especificadas nos filtros dimensionValue ou na etiqueta de dimensões. O valor por padrão é falso.	false
markInvalidValues	N	Se definida como verdadeira, a exportação adicionará a letra "I" aos valores inválidos. Caso contrário, adiciona "=NA()" aos valores inválidos para torná-los compatíveis com o Excel. O valor por padrão é falso.	false
markBlanks Atualizado na API v24.	N	Se definido como verdadeiro, os valores em branco serão gerados como "B". Caso contrário, os valores em branco serão gerados como zeros. O valor por padrão é falso. Quando includeZeroRows=false, as linhas com uma combinação somente de espaços em branco e zeros não serão geradas na resposta, mesmo se markBlanks=true.	false
timeRollups	N	Tem três valores possíveis: verdadeiro, falso e único. Se definida como verdadeira, as consolidações trimestrais e anuais aparecerão em seus devidos locais dentro do período de meses exportado. As consolidações trimestrais aparecem imediatamente após o último mês do trimestre, e as consolidações anuais aparecem imediatamente após a consolidação trimestral do último trimestre. Se definido como único, nenhum mês, trimestre ou ano individual é retornado e somente uma única consolidação por tempo de todos os meses cobertos no elemento de período temporal é retornada. Se definida como falsa, somente meses individuais são retornados, sem colunas de consolidação por tempo. O valor por padrão é falso.	false
Conteúdo do elemento
Um elemento de moeda opcional para especificar qual moeda deve ser usada na exportação.

elemento de moeda
Nome da etiqueta		moeda
Descrição		Indica qual moeda deve ser usada na saída quando os valores das contas em moeda são emitidos.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
useCorporate	N	Somente um dos três atributos pode ser definido para um elemento de moeda. Se useCorporate é definido como verdadeiro, indica que a "moeda corporativa" (a moeda no topo da árvore da organização) deve ser usada. O valor por padrão é falso.	false
useLocal	N	Somente um dos três atributos pode ser definido para um elemento de moeda. Se useLocal é definido como verdadeiro, indica que os valores da moeda devem ser emitidos na moeda do nível da organização em que residem. Cada linha da saída indica um Nível da organização, e os valores de moeda nessa linha estarão na moeda desse nível. O valor por padrão é falso.	false
substituição	N	Somente um dos três atributos pode ser definido para um elemento de moeda. Se a substituição estiver presente, ela deverá especificar o código de moeda de três letras de uma das moedas configuradas para a instância. Quando especificada, todos os valores de moeda na exportação serão convertidos nessa moeda.	AUD
Conteúdo do elemento
(nenhum)

Os elementos a seguir permitem que os usuários (com as permissões corretas) solicitem exportações de consolidações por tempo arbitrárias. Esses elementos exigem solicitações que usam a API v40 e versões superiores.

tempoelemento
Nome da etiqueta		time
Descrição		Contém o calendário XML que deve ser usado para mapear períodos na exportação de dados. Deve estar em um formato simplificado do XML de horas gerado no exportTime API Os períodos incluídos nessa seção devem corresponder ao elemento de período temporal no filtro. Esse elemento é obrigatório APENAS quando o calendário de consolidação arbitrário é usado. Disponível somente na API v40 e superiores
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo

Conteúdo do elemento
(nenhum)

estratoelemento
Nome da etiqueta		stratum
Descrição		Representa um estrato do calendário. Disponível somente na API v40 e superiores
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
ID	S	O identificador de número inteiro exclusivo gerado pelo sistema para o estrato de tempo.	7
Conteúdo do elemento
(nenhum)

períodoelemento
Nome da etiqueta		período
Descrição		Representa um único período temporal do calendário. Disponível somente na API v40 e superiores
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Um identificador exclusivo definido pelo usuário para o período.	Q1-2004
stratumId	S	A ID do estrato ao qual o período pertence.	2
intervalo de tempo	S	O intervalo de tempo do período.	16
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-01-01
Conteúdo do elemento
(nenhum)

Exemplo de solicitação arbitrária de consolidação por tempo
:


<call method="exportData" callerName="test caller api name">
<credentials login="admin@example.com" password="password" locale="en_US" instanceCode="EXAMPLEINST" />
<version name="Budget 2004" isDefault="true" />
<format useInternalCodes="true" includeUnmappedItems="false" useIds="false" />
<rules includeZeroRows="false" includeRollupAccounts="true" includeRollupLevels="false" markInvalidValues="false" markBlanks="false" timeRollups="false">
   <currency useCorporate="false" useLocal="true" />
</rules>
<filters>
   <accounts>
       <account code="70310" isAssumption="false" includeDescendants="true" />
   </accounts>
   <timeSpan start="01/1999" end="06/1999" />
</filters>
<time isCustom="1">
   <stratum code="month" label="Month" shortName="Month" id="1" />
   <period code="01/1999" label="Jan-1999" shortName="Jan" stratumId="1" id="-12001" start="1999-01-01" end="1999-02-01" />
 <period code="02/1999" label="Feb-1999" shortName="Feb" stratumId="1" id="-11001" start="1999-02-01" end="1999-03-01" />
 <period code="03/1999" label="Mar-1999" shortName="Mar" stratumId="1" id="-10001" start="1999-03-01" end="1999-04-01" />
 <period code="04/1999" label="Apr-1999" shortName="Apr" stratumId="1" id="-9001" start="1999-04-01" end="1999-05-01" />
 <period code="05/1999" label="May-1999" shortName="May" stratumId="1" id="-8001" start="1999-05-01" end="1999-06-02" />
 <period code="06/1999" label="Jun-1999" shortName="Jun" stratumId="1" id="-7001" start="1999-06-01" end="1999-07-01" />
</time>
</call>

Formato da resposta

Formato de resposta para Non-streaming


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
<message key="warning-invalid-timespan-start">Ignoring start of timespan, which precedes start of version; timsepan start: Nov-2009, version start date: Jan-2014</message>
</messages>
<output><![CDATA[
Account Name,Account Code,Level Name,[01/2014,02/2014,03/2014,04/2014,05/2014,06/2014,07/2014,08/2014,09/2014,10/2014,11/2014,12/2014]
"Benefits",30120,"Engineering (Rollup)",10653.75,10653.75,10653.75,11506.05,11506.05,11506.05,11506.05,11506.05,11506.05,10462.05,10426.05,10426.05
"Furniture",70310,"Engineering (Rollup)",1740.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0
...
]]>
</output>
</response>

Formato de resposta para streaming


<?xml version="1.0" encoding="UTF-8"?>
<response>
<output>
<![CDATA[Account Name,Account Code,Level Name,Q1-2004,Q2-2004,Q3-2004,Q4-2004,Q1-2005,Q2-2005
"Current Assets","Current_Assets","Engineering",33.0,33.0,33.0,33.0,33.0,33.0
"Other Assets","Other_Assets","Engineering",41.0,41.0,41.0,41.0,41.0,41.0]]>
</output>
<messages>
<message>Exporting data failed. Retry the export. Contact Support if the export continues to fail. </message>
</messages>
<status success="false" rowCountSent="2"/>
</response>

Observe que há uma alteração na estrutura da resposta para solicitações de streaming e não streaming. Por exemplo, o elemento e o status da mensagem ocorrem após a saída.

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á 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
(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
Descrição	Contém os dados resultantes da exportação em um bloco CDATA incluído.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um bloco CDATA contendo os dados da exportação no formato CSV. As linhas são separadas por caracteres de nova linha. A primeira linha de dados retornados é o conjunto de "cabeçalhos de coluna" que descrevem o formato de cada uma das linhas a seguir. As dimensões e os elementos de filtragem são listados primeiro, seguidos pela série de valores de período solicitados. Os códigos de período e os rótulos gerados pelo sistema, como o sufixo "(Consolidação)" em níveis de consolidação, são convertidos para os parâmetros regionais da solicitação quando possível. Os valores são emitidos de forma normalizada, sem vírgulas, usando um ponto como separador decimal.

elemento de status
Nome da etiqueta		status
Descrição		Contém informações de status para a solicitação e o total de linhas (SOMENTE para solicitações de streaming)
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito	S	"true" ou "false". Informa se a solicitação foi concluída com êxito ou não. Mesmo solicitações bem-sucedidas podem conter mensagens de aviso. Isso substitui o atributo na resposta SOMENTE em solicitações de streaming.	"true"
rowCountSent	S	r"\d+". Representa o valor numérico do número de linhas na resposta.	"10"

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