exportDimensionMapping

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

Com suporte na API v19 +

Categoria	Recuperação de metadados
Descrição	Exporta os critérios de mapeamento de dimensões derivadas para uma ou mais dimensões em uma determinada versão.
Permissões obrigatórias para invocar
Parâmetros obrigatórios na solicitação	Credenciais

Essa API é usada para recuperar uma lista de critérios de mapeamento para uma ou mais dimensões derivadas. Para cada dimensão na solicitação, ela recuperará os valores mapTo e as condições de valor de dimensão.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportDimensionMapping" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_password"/>
  <dimensions>
    <dimension name="Area">                       
    </dimension>
  </dimensions>
  <version name = "Budget 2017"/>
  <filters>
    <keyword value="Alameda" />
    <levels>
      <level code="HQ" includeDescendants="true" />
    </levels>
    <dimensionValues>
      <dimensionValue dimName="Geography" code="California" />
      <dimensionValue dimId="34" uncategorized="true" />
      <dimensionValue dimName="Region" code="Bay Area" uncategorized="true" />
      <dimensionValue dimId="19" id="78" />
    </dimensionValues>
    <attributes>
      <attribute id="1" uncategorized="true"/>
      <attribute name="attributeName1" value="attributeValue1"/>
      <attribute id="3" valueId="31" uncategorized="true"/>
    </attributes>
  </filters>
</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 adequado, nomes de período e formatação de data). 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 o método de API de refex.	MYINSTANCE1
Conteúdo do elemento
(nenhum)

Elemento de versão
Nome da etiqueta		versão
Descrição		Especifica de qual versão as linhas modeladas devem ser recuperadas.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
Nome	S	O nome da versão.	Orçamento de 2017
Conteúdo do elemento
(nenhum)

elemento de dimensões
Nome da etiqueta		dimensões
Descrição		Contêiner para uma lista de elementos de <dimension>.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
elementos de dimensão

elemento de dimensão
Nome da etiqueta		dimensão
Descrição		Descreve uma dimensão para a qual queremos importar mapeamentos.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome da dimensão para a qual importar mapeamentos	Área
Conteúdo do elemento
Um elemento mappingCriteria.

Elemento de filtros
Nome da etiqueta		filtros
Descrição		Contém a especificação dos filtros que determinam quais dados da versão e das dimensões solicitadas são recuperados pela API. Esse elemento especifica a palavra-chave, os níveis e os valores de dimensão que as entradas de critérios de mapeamento correspondentes contêm e que serão recuperados.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um único elemento opcional de palavra-chave , um único elemento opcional de níveis e um único elemento opcional dimensionValues .

Elemento de níveis
Nome da etiqueta		níveis
Descrição		Contêiner para elementos de nível zero ou um.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Zero ou um elemento de nível

Elemento de nível
Nome da etiqueta		level
Descrição		Especifica um nível da organização para que os dados sejam exportados nesta chamada de API.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome do nível a ser exportado. Esse nome é conforme especificado em Administração da organização.	Desenvolvimento
código Na API v30+, use o código em vez do nome.	Obrigatório quando a ID não é especificada.	O código do nível a ser exportado. Esse código é conforme especificado em Administração da organização.	Desenvolvimento
ID	Obrigatório quando o código não é especificado.	O número da ID do sistema interno do nível a ser exportado.	8
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.	Verdadeiro
Conteúdo do elemento
(nenhum)

dimensionValues Element
Nome da etiqueta		dimensionValues
Descrição		Contêiner para zero ou mais elementos dimensionValue .
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Zero ou mais elementos dimensionValue .

dimensionValue Element
Nome da etiqueta		dimensionValue
Descrição		Indica que os dados exportados devem conter apenas as entradas de critérios de mapeamento que contêm o dimensionValue correspondente especificado. Se mais de um elemento dimensionValue está dentro do elemento dimensionValues, as entradas de critério de mapeamento exportadas devem conter todos os valores/dimensões especificados. Por exemplo, se uma solicitação especifica os valores de dimensão Region=East e Product=Product_A, o critério de mapeamento deve ter Região contendo Leste e Produto contém Produto_A para que possa ser exportado. Observe também que cada dimensionValue no elemento dimensionValues deve pertencer a uma dimensão diferente. Por exemplo, uma solicitação com valores de dimensão Region=East e Region=West não será aceita. Caso as dimensões de filtragem de entrada não pertençam a nenhuma das dimensões solicitadas, elas serão ignoradas.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
dimName	obrigatório quando uncategorizedOfDimension não é especificado	O nome da dimensão à qual o valor de dimensão (consulte atributo de nome abaixo) pertence.	Região
nome	N	O nome do valor de dimensão a ser exportado.	Oeste dos EUA
código Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	Obrigatório quando a ID não é especificada	O código do valor de dimensão a ser exportado.	Oeste dos EUA
não categorizado	N	Se definidos como verdadeiro, os dados exportados conterão o critério de mapeamento somente com o valor de dimensão correspondente, e não os valores de nenhum dos 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
dimId	obrigatório quando dimName não é especificado.	O número de ID do sistema interno da dimensão à qual o valor de dimensão (consulte atributo de nome acima) pertence.	15
uncategorizedOfDimension	N	Especifique o uncategorizedOfDimension no lugar dos atributos dimName/uncategorized . 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 sem categoria serão ignorados e considerados verdadeiros. Ignorado se dimName é especificado.	15
ID	Obrigatório quando o código não é especificado	Especifique a ID no lugar dos atributos de nome . O número de ID do sistema interno do valor de dimensão a ser exportado. Deve ser especificado no lugar dos atributos de nome para especificar o valor de dimensão. Para determinar IDs internas, consulte a API exportDimensions . Ignorado se o nome é especificado.	14
Conteúdo do elemento
(nenhum)

Formato da resposta


<response success="true">
 <output>
        <mappings>
            <version name="Budget 2017"/>
            <dimensions>
                <dimension name="Area">
                    <mappingCriteria>
                        <mappingCriterion id="121">
                            <mapTo dimensionValue="East"/>
                            <dimension name="Level" value="HQ"/>
                            <dimension name="State" value="MA"/>
                        </mappingCriterion>
                        <mappingCriterion id="122">
                            <mapTo dimensionValue="West"/>
                            <dimension name="Level" value="HQ"/>
                            <dimension name="State">
                                <dimensionValue name="CO"/>
                                <dimensionValue name="CA"/>
                            </dimension>
                        </mappingCriterion>
                    </mappingCriteria>
                </dimension>
            <dimensions/>
        </mappings>
    </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
Conteúdo do elemento
Um único elemento de mensagens opcional e exatamente um elemento de saída obrigatório.

dimensions Element
Nome da etiqueta		dimensões
Descrição		Contêiner para uma lista de elementos de <dimension>.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
elementos de dimensão

elemento de dimensão
Nome da etiqueta		dimensão
Descrição		Descreve uma dimensão para a qual queremos importar mapeamentos.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome da dimensão para a qual importar mapeamentos	Área
Conteúdo do elemento
Um elemento mappingCriteria.

mappingCriteria Element
Nome da etiqueta		mappingCriteria
Descrição		Contêiner para uma lista de elementos <mappingCriterion>
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	N	Se uma ID é fornecida, um critério de mapeamento existente com essa ID é atualizado. Se nenhuma ID é fornecida, um novo critério de mapeamento é adicionado à dimensão.	12
Conteúdo do elemento
Elementos mappingCriterion para cada valor de dimensão da dimensão derivada.

Elemento mappingCriterion
Nome da etiqueta		mappingCriterion
Descrição		Descreve as dimensões individuais e os valores de dimensão que determinam se um valor de dimensão está sendo mapeado para o. Deve ser seguido por um grupo de etiquetas mapTo , dimensão e dimensionValue .
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	N	Se uma ID é fornecida, um critério de mapeamento existente com essa ID é atualizado. Se nenhuma ID é fornecida, um novo critério de mapeamento é adicionado à dimensão.	12
Conteúdo do elemento
Contém um elemento mapTo e até seis elementos de dimensão.

mapTo Element
Nome da etiqueta		mapTo
Descrição		Especifica o valor de dimensão derivado com base nos critérios de mapeamento.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
dimensionValueId	S	A ID do valor de dimensão para o qual este critério de mapeamento é mapeado.	11
dimensionValue	S	O nome do valor de dimensão para o qual esse critério de mapeamento é mapeado.	Califórnia
dimensionValueCode	S	O código do valor de dimensão para o qual este critério de mapeamento é mapeado.	CA
dimensionValueDisplayName	S	O nome de exibição do valor de dimensão para o qual esse critério de mapeamento é mapeado.	Califórnia
Conteúdo do elemento
(nenhum)

elemento de dimensão
Nome da etiqueta		dimensão
Descrição		Descreve uma das dimensões que estão sendo usadas para derivar o valor de dimensão mapTo.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome da dimensão	Área
ValueId	N	A ID do valor da dimensão. Obrigatório, a menos que haja elementos dimensionValue.	282
valor	N	O nome do valor de dimensão. Obrigatório, a menos que haja elementos dimensionValue	Oeste
valueCode	N	O código do valor da dimensão. Obrigatório, a menos que haja elementos dimensionValue.	Nós
valueDisplayName	N	O nome de exibição do valor de dimensão. Obrigatório, a menos que haja elementos dimensionValue.	Oeste
Conteúdo do elemento
(nenhum)

dimensionValue Element
Nome da etiqueta		dimensionValue
Descrição		(Opcional) Se mais de um valor de dimensão precisar ser listado para uma etiqueta de dimensão , várias etiquetas dimensionValue podem ser usadas em vez do atributo de nome .
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	A ID do valor de dimensão	10
nome	S	O nome do valor de dimensão	Colorado
código	S	O código do valor de dimensão	CO
displayName	S	O nome de exibição do valor de dimensão	Colorado
Conteúdo do elemento
(nenhum)

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.

exportLocales

exportModeledSheet

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