updateDimension

Sem suporte na API v20+. Use updateDimensions.

Categoria	Modificação de metadados
Descrição	Atualize uma dimensão. Se for bem-sucedida, a API retorna detalhes da dimensão que acabou de ser atualizada.
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.

As seguintes condições se aplicam a esta API:

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

Você não pode desativar listDimension se tiver atributos de dimensão definidos ou se os valores não estão disponíveis em todas as versões.

Você não pode desativar listDimension se tem dimensionValues hierárquicos.

Você não pode habilitar useOnLevels e listDimension ao mesmo tempo. (É possível desativar um e ativar o outro no mesmo comando.)

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimension" callerName="fred">
    <credentials login="sampleuser@company.com" password="my_pwd" />
    <dimension id="34"
       name="Updated Dimension Name"
     />
</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)

elemento de dimensão
Nome da etiqueta		dimensão
Descrição		Especifica uma dimensão a ser criada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	A ID da dimensão que está sendo atualizada.	34
nome	N	O nome da dimensão. O nome deve ser exclusivo.	NewDimensionName
shortName	N	Título exibível da coluna, como visto na planilha.	NewDimensionShortName
listDimension	N	"1" significa que é uma dimensão de lista, "0" (ou não especificado) significa que não é.	0
useOnLevels	N	"1" significa que esta dimensão pode ser usada em níveis, "0" (ou não especificado) significa que não pode.	0
autoCreate	N	"1" significa que os valores para esta dimensão podem ser criados por meio da importação. "0" (ou não especificado) significa que não podem.	0
keepSorted	N	"1" significa que os valores para esta dimensão são sempre classificados em ordem alfabética, "0" (ou não especificado) significa que eles podem ser ordenados manualmente.	0
Conteúdo do elemento
(nenhum)

Formato da resposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <output>
       <dimensions>
           <dimension id="41" name="New Dimension Name" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0">
           </dimension>
       </dimensions>
   </output>
</response>

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 Administração de dimensã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)