updateDimensionValue

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

Sem suporte na API v20 +

Categoria	Modificação de metadados
Descrição	Atualizar um valor de dimensão. Se for bem-sucedida, a API retorna detalhes para a dimensão e todos os valores de dimensão, incluindo o que acabou de ser atualizado.
Permissões obrigatórias para invocar	Modelo
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 está fazendo a chamada. O usuário deve ter permissão de modelo para criar a dimensão.

Esse método retorna um erro se há alterações não publicadas.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensionValue" callerName="fred">
    <credentials login="sampleuser@company.com" password="my_pwd" />
    <dimensionValue
       id="10"
       name="New Dimension Value">
       <attributes>
         <attribute attributeId="20" valueId="170" />
       </attributes>
   </dimensionValue>
</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 API chamada será bem-sucedida.
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)

dimensionValue element
Nome da etiqueta		dimensionValue
Descrição		Especifica um valor de dimensão a ser atualizado.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
dimensionId	N	A ID da dimensão à qual o valor pertence.	3
ID	S	A ID do valor da dimensão.	34
nome	S	O nome do valor de dimensão.	NewDimensionValue
shortName	N	O nome curto do valor de dimensão.	NewDimensionValue- ShortName
parentId	N	A ID do valor da dimensão pai.	220
descrição	N	A descrição do valor da dimensão.	Este é um NewDimensionValue
Conteúdo do elemento
(nenhum)

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

elemento atributo
Nome da etiqueta		atributo
Descrição		Contêiner para elemento de atributo de uma dimensão.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
attributeID	S	A ID do atributo de dimensão gerada pelo sistema.	20
valueID	S	A ID exclusiva do valor do atributo de dimensão gerado pelo sistema. Se esse valor é 0, esse atributo é removido da conta.	170
Conteúdo do elemento
(nenhum)

Formato da resposta

Estes são exemplos de respostas para atualização bem-sucedida e malsucedida de um valor de dimensão.

Exemplo de êxito


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
 <output>
   <dimensions>
       <dimension id="6" name="Department" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1">
               <dimensionValue id="7" name="Engr" description="Engineering" shortName="">
               <dimensionValue id="52" name="QA" description="Quality Assurance" shortName="" />
               <dimensionValue id="53" name="Dev" description="Development" shortName="" /></dimensionValue>
      </dimension>
      <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
               <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName="">
                   <attributes>
                       <attribute attributeId="21" name="Education Type" valueId="197" value="Tech1" />
                   </attributes>
               </dimensionValue>
               <dimensionValue id="33" name="Masters" description="Masters degree" shortName="">
                   <attributes>
                       <attribute attributeId="21" name="Education Type" valueId="196" value="Management" />
                   </attributes>
               </dimensionValue>
               <dimensionValue id="34" name="Phd" description="Phd" shortName="" />
       </dimension>
   </dimensions>
 </output>
</response>

Exemplo de erro


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
    <messages>
        <message type="ERROR" key="invalid-attributevalueid" values="-50" dimensionValueId="10">Invalid attribute value id: "-50"</message>
    </messages>
</response>

As dimensões são ordenadas por nome.

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 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 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		Representa uma única dimensão personalizada que está sendo retornada em resposta a uma chamada à API exportDimensions.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número da ID do sistema interno da dimensão. Isso pode ser usado para identificar dimensões em outras chamadas de API, como exportDimensionFamilies.	16
nome	S	O nome da dimensão, como aparece em relatórios e planilhas.	Cliente
shortName	N	O nome curto da dimensão, se houver, conforme inserido em Administração de dimensões	cust.
autoCreate	S	1 se a dimensão selecionada tem o campo "A importação de dados cria automaticamente valores de dimensão" definido; 0, caso contrário.	0
listDimension	S	1 se a dimensão selecionada é uma dimensão de lista; 0, caso contrário.	1
keepSorted	S	1 se a dimensão selecionada é mantida classificada; 0 caso contrário.	1
useOnLevels	S	1 se a dimensão selecionada pode ser usada em níveis; 0, caso contrário.	1
Conteúdo do elemento
Zero ou mais elementos dimensionValue. Cada elemento dimensionValue incluído representa um "valor de dimensão raiz" na dimensão, um valor que não tem valor pai.

dimensionValue element
Nome da etiqueta		dimensionValue
Descrição		Representa um valor de membro único de uma dimensão personalizada que está sendo retornado em resposta a uma chamada à API exportDimensions.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número de ID do sistema interno para este valor de membro da dimensão.	34
nome	S	O rótulo do valor do membro da dimensão, conforme exibido em relatórios e usado em fórmulas.	Uma empresa
shortName	N	O nome curto do valor de dimensão, se houver, conforme inserido em Administração de dimensão	A
descrição	N	A descrição do valor da dimensão, se houver, conforme inserida em Dimen-Administração	Uma corporação
Conteúdo do elemento
Zero ou mais elementos dimensionValue opcionais. Cada elemento dimensionValue incluído representa um "valor de dimensão filho" desse valor de dimensão, cujos membros são consolidados implícitamente nesse valor.

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

elemento atributo
Nome da etiqueta		atributo
Descrição		Contêiner para elemento de atributo de uma dimensão.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
attributeID	S	A ID do atributo de dimensão gerada pelo sistema.	20
nome	S	O nome do atributo de dimensão	Tipo de formação
valueID	S	A ID exclusiva do valor do atributo de dimensão gerado pelo sistema.	170
valor	S	O valor do atributo de dimensão.	Tech1
Conteúdo do elemento
(nenhum)

updateDimensions

updateLevel

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