importDimensionMapping

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	Envio de metadados
Descrição	A API importDimensionMapping pode ser usada para importar valores de dimensão derivada.
Permissões obrigatórias para invocar
Parâmetros obrigatórios na solicitação	Credenciais

A API importDimensionMapping pode ser usada para importar as condições de mapeamento que determinam os valores de dimensão de mapeamento a serem preenchidos automaticamente nas linhas da planilha modelada. Ela pode ser usada para criar, atualizar e excluir condições de mapeamento. Os valores de dimensão derivada em linhas da planilha modelada não oferecem suporte a versões virtuais.

Formato da solicitação

<?xml version='1.0' encoding='UTF-8'?>
<call method="importDimensionMapping" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_password"/>
  <version name="Budget 2017" id="7"/>
  <dimensions>
        <dimension id="345" name="Area">
            <mappingCriteria>
                <mappingCriterion id="121">
                    <mapTo dimensionValueId="877" dimensionValue="East"/>
                    <dimension name="Level" valueId="1" value="HQ"/>
                    <dimension name="State" valueId="15" value="MA"/>
                </mappingCriterion>
                <mappingCriterion id="122">
                    <mapTo dimensionValueId="876" dimensionValue="West"/>
                    <dimension name="Level" valueId="1" value="HQ"/>
                    <dimension name="State" id="5">
                        <dimensionValue id="900" code="CA"/>
                        <dimensionValue id="901" code="CO"/>
                    </dimension>
                </mappingCriterion>
            </mappingCriteria>
        </dimension>
    </dimensions>
</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 exportInstances .	MYINSTANCE1
Conteúdo do elemento
(nenhum)

Elemento de versão
Nome da etiqueta		versão
Descrição		Especifica a versão para a qual os mapeamentos serão importados.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
Nome	Obrigatório quando a ID não é especificada.	O nome da versão.	Orçamento de 2017
ID	Obrigatório quando o nome não é especificado.	A ID da versão	7
Conteúdo do elemento
Contém um ou mais elementos de nível.

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	Obrigatório quando a ID não é especificada.	O nome da dimensão para importar mapeamentos	Área
ID	Obrigatório quando o nome não é especificado.	A ID da dimensão para importar mapeamentos.	15
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
excluir	N	Insira "sim" para excluir todas as condições de mapeamento no mappingCriterion. Um valor vazio ou qualquer valor diferente de "sim" é ignorado e as condições de mapeamento não são excluídas.	Sim
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
dimensionValue	Obrigatório quando dimensionValueId não é especificado.	O nome do valor de dimensão para o qual esse critério de mapeamento é mapeado.	Área
dimensionValueId	Obrigatório quando dimensionValue não é especificado.	O nome da ID de valor de dimensão para a qual esse critério de mapeamento é mapeado.	12
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 . No mínimo, um elemento de dimensão para a dimensão "Nível" é obrigatório, bem como um elemento de dimensão para uma dimensão personalizada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	Obrigatório quando a ID não é especificada.	O nome da dimensão	Setor
ID	Obrigatório quando o nome não é especificado.	A ID da dimensão
valor	N	O nome do valor de dimensão. Obrigatório, a menos que haja dimensionValue	Varejo
valueId	N	A ID do valor da dimensão. O valor this ou é obrigatório, a menos que haja elementos dimensionValue
Conteúdo do elemento
dimensionValue elements

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 , uma série de etiquetas dimensionValue podem ser usadas em vez do atributo de valor .
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome do valor de dimensão	Varejo
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 valor de dimensão	Varejo
ID	Obrigatório quando o código não é especificado.	A ID do valor de dimensão	25
Conteúdo do elemento
(nenhum)

Exemplos:


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion>
            <mapTo dimensionValue="East"/>   
            <dimension name="Level" value="HQ"/> 
            <dimension name="State" value="MA"/> 
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Critério de mapeamento para mapear os valores de dimensão HQ na dimensão de nível e MA na dimensão de estado para o valor da dimensão East na dimensão Área. As linhas em que os dois valores correspondem serão aumentadas com East. Como o atributo ID é especificado, esse critério de mapeamento substituirá um critério de mapeamento existente por essa ID.


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion id="123">
            <mapTo dimensionValue="East"/>
            <dimension name="Level" value="HQ"/> 
            <dimension name="State" value="MA"/> 
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Critério de mapeamento para mapear os valores da dimensão HQ na dimensão de nível e CA ou CO na dimensão de estado para o valor da dimensão East na dimensão Área. As linhas em que os dois valores correspondem serão aumentadas com East.


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion>
            <mapTo dimensionValue="East"/>   
            <dimension name="Level" value="HQ"/> 
            <dimension name="State">         
                <dimensionValue code="CA"/>  
                <dimensionValue code="CO"/>
            </dimension>
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Formato da resposta

Resposta bem-sucedida


<?xml version="1.0" encoding="UTF-8"?>
<response success="true"/>

Resposta para reprovação


<?xml version="1.0" encoding="UTF-8"?>
<response success="false">
    <messages>
        <message>There are duplicate mapping conditions. Make all mappingCriterion conditions unique</message>
    </messages>
</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.

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.

exportVersions

importGroups

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