updateDimensions

HTTP	Descrição
Method	Post
Content-Type	text/xml

Exemplo de curvatura


curl -H "Content-Type: text/xml" -d @C:/temp/updateDimVal.xml -X POST https://api.adaptiveplanning.com/api/v17

updateDimVal.xml contents


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
<dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
     <dimensionValue id="32" name="Graduate" description="Modified Graduate degree" />
   </dimension>
</dimensions>
</call>

Anexar um exemplo de arquivo XML - Curl



curl -i -X POST -H "Content-Type: multipart/form-data" -F "request=<C:/temp/requestCreateNewDimVal.xml" -F "content=@C:/temp/createNewDimVal.xml" https://api.adaptiveplanning.com/api/v17

requestCreateNewDimVal.xml content



<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
</call>

createNewDimVal.xml



<?xml version='1.0' encoding='UTF-8'?>
<dimensions>
  <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
    <dimensionValue id="" name="Graduate" description="Graduate degree" />
  </dimension>
</dimensions>

Para cargas grandes, você pode publicar arquivos XML compactados (zipados). Consulte Atualização em massa de metadados.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
<dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
     <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName="" allVersions="0">
         <attribute name="Education Type" value="Tech1" />
         <version name="Budget 2017" available="1" />
     </dimensionValue>
     <dimensionValue id="33" name="Masters" description="Masters degree" shortName="" allVersions="0">
         <attribute name="Education Type" value="Management" />
         <version name="Budget 2017" available="1" />
     </dimensionValue>
     <dimensionValue id="34" name="Phd" description="Phd" shortName="" />
   </dimension>
   <dimension id="16" name="Geography" property1="Latitude" property2="Longitude">            
     <dimensionValue id="521" name="United States" description="USA" shortName="">                
       <dimensionValue id="555" name="Alabama" description="1" shortName="">                    
         <dimensionValue id="579" name="205" description="1" shortName="">                        
           <dimensionValue id="4718" name="35004" description="33" shortName="">                            
             <properties>                                
               <property name="Latitude" value="33.6015" />                                
               <property name="Longitude" value="86.4895" />                            
             </properties>                        
           </dimensionValue>                        
           <dimensionValue id="4719" name="35005" description="" shortName="" />                    
         </dimensionValue>                    
         <properties>                        
           <property name="Latitude" value="" />                        
           <property name="Longitude" value="86.9023" />                    
         </properties>                
       </dimensionValue>            
     </dimensionValue>        
   </dimension>
</dimensions>
</call>

As seguintes condições se aplicam a updateDimensions:

Dimensões e valores de dimensão são identificados para atualização por meio de seus números de ID internos.

A moeda, uma dimensão do sistema, não pode ser atualizada por API.

Para criar novas dimensões e valores de dimensão, forneça a eles uma propriedade de ID em branco ou ausente.

Em uma dimensão existente, você pode deslocar um dimensionValue existente (não novo) para um novo dimensionValue. Isso cria o novo dimensionValue e move o dimensionValue existente abaixo dele como um filho.

Todos os valores de dimensão criados para dimensões planas são visíveis em todas as versões de plano por padrão. Para especificar a visibilidade, você deve mencioná-la explicitamente usando:

O

allVersions

atributo no

dimensionValue

etiqueta

Ou fornecendo filho

version

etiquetas em

dimensionValue

para fornecer visibilidade personalizada

updateDimensions só atualiza a disponibilidade de versões de plano. Você não pode atualizar a disponibilidade da versão para versões de valores reais, mesmo quando allVersions = 1.

Formato de solicitação para criação de um novo valor de dimensão

Para criar um novo valor de dimensão, inclua o valor pai pela ID. Por exemplo, para adicionar um novo valor filho abaixo do

Engr

valor que tem

id 7

, você pode usar:


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
 <dimensions>
   <dimension id="7">
     <dimensionValue id="" name="Documentation" description="docs" shortName="" >
       <properties>                                
         <property name="OwnerID" value="58371998"/>                                                            
       </properties>        
     </dimensionValue>
   </dimension>
 </dimensions>  
</call>

Este método não altera nada sobre o valor

id 7

. Ele cria um novo filho chamado

Docs

para

id 7

. Todos os filhos não mencionados são movidos para o fim da lista de filhos. Isso equivale a "definir o pai" para o novo valor, mas isso é feito incluindo o pai como um elemento.

Formato de solicitação para criar um novo valor de dimensão com código e nome

Para criar um novo valor de dimensão, inclua o valor pai pela ID. Por exemplo, para adicionar um novo valor filho abaixo do valor Engr que tem ID 7, você pode usar:

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="Steve C">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions displayNameEnabled="1">
   <dimension id="7">
      <dimensionValue id="" code ="Doc" name="Documentation" description="docs" shortName="">
         <properties>
            <property name="OwnerID" value="58371998" />      
         </properties>
      </dimensionValue>
   </dimension>
</dimensions>
</call>

Formato de entrada 1: a carga inclui toda a árvore de dimensões

A updateDimensions API funciona melhor quando um chamador quer fornecer o novo estado da árvore sem se preocupar com alterações.

A updateDimensions API calcula as alterações na estrutura da dimensão e somente os valores de dimensão/dimensão alterados ou novos são atualizados. O

dimensions

o elemento contém apenas um filho direto

dimension

ou

dimensionValue

elemento.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimension id="16" name="Geography" property1="Latitude" property2="Longitude">
      <dimensionValue id="521" name="United States" description="USA" shortName="">
         <dimensionValue id="555" name="Alabama" description="1" shortName="">
            <dimensionValue id="579" name="205" description="1" shortName="">
               <dimensionValue id="4718" name="35004" description="33" shortName="">
                  <properties>
                     <property name="Latitude" value="33.6015" />
                     <property name="Longitude" value="86.4895" />
                  </properties>
               </dimensionValue>
               <dimensionValue id="4719" name="35005" description="" shortName="" />
            </dimensionValue>
            <properties>
               <property name="Latitude" value="" />
               <property name="Longitude" value="86.9023" />
            </properties>
         </dimensionValue>
      </dimensionValue>
   </dimension>
</dimensions>
</call>

Formato de entrada 2: a carga inclui estrutura de subárvore de dimensões

Esse formato oferece suporte a casos de uso em que as alterações são limitadas a apenas uma parte da estrutura de árvore de dimensões.

A updateDimensions API calcula as alterações na estrutura da dimensão e somente os valores de dimensão/dimensão alterados ou novos são atualizados. O

dimensions

o elemento contém apenas um filho direto

dimensionValue

elemento.

Por exemplo, as alterações estão dentro do Alabama:

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimensionValue id="555" name="Alabama" description="1" shortName="">
      <dimensionValue id="579" name="205" description="1" shortName="">
         <dimensionValue id="4718" name="35004" description="33" shortName="">
            <properties>
               <property name="Latitude" value="33.6015" />
               <property name="Longitude" value="86.4895" />
            </properties>
         </dimensionValue>
         <dimensionValue id="4719" name="35005" description="" shortName="" />
      </dimensionValue>
   </dimensionValue>
</dimensions>
</call>

Para dimensões planas, você deve fornecer o valor pai

dimension

etiqueta abaixo de

dimensions

seguido por um ou mais valores de dimensão.

dimensions

o elemento contém apenas um filho direto

dimension

elemento.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimension id="16" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
      <dimensionValue id="521" name="Graduate" shortName="" description="Graduate degree" />
      <dimensionValue id="522" name="Masters" shortName="" description="Masters degree" />
   </dimension>
</dimensions>
</call>

Formato de entrada 3: atualização de um valor de dimensão única

Esse formato oferece suporte a casos de uso em que as alterações são limitadas a apenas um valor de dimensão.

O

dimensions

o elemento contém apenas um filho direto

dimensionValue

elemento.

Use somente o Formato de entrada 3 quando atualizar um valor de dimensão única. O formato de entrada 3 não é o formato preferencial para atualizar vários valores de dimensão. Você não pode criar novas dimensões/valores de dimensão com esse formato. Use o formato de entrada 2 para adicionar novas dimensões/valores de dimensão.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimensionValue id="555" name="Alabama" description="1" shortName=""/>
</dimensions>
</call>

Tratamento de várias renomeações em uma única chamada updateDimensions

Várias renomeações da mesma entidade podem ocorrer em um sistema remoto entre

updateDimensions

chamadas. Os nomes de entidades no sistema remoto podem ser trocados pelas mesmas IDs de entidade. Quando

updateDimensions

chamadas ocorrem após a troca de nomes, o

updateDimensions

O call gerencia essas alterações rastreando as IDs nas alterações de nome. A chamada também pode lidar com a introdução de uma nova ID que usa um nome existente.

Para que cada um dos exemplos seja bem-sucedido, a troca completa de IDs deve ocorrer com os valores exclusivos.

Exemplo 1: uma simples troca de nome no sistema remoto.


ID     Unique Value   New Unique Value
1      AA             BB
2      BB             AA

Exemplo 2: uma sequência de três renomeações no sistema remoto.


ID     Unique Value   New Unique Value
1      AA             BB
2      BB             CC
3      CC             AA

Exemplo 3: uma nova entidade que usa um valor exclusivo existente.


ID     Unique Value   New Unique Value
4                     AA
1      AA             BB
2      BB             Old BB

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
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 dimensões
Nome da etiqueta		dimensões
Descrição		Contém uma ou mais dimensões ou valores de dimensão.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
retainExistingOrder Disponível na API v27+	N	MaintainExistingOrder="1" indica que a updateDimensions API deve ignorar a ordem dos elementos na carga XML e a ordem definida existente será mantida. retExistingOrder="0" indica que a updateDimensions API deve atualizar a ordem dos elementos com base na posição da etiqueta em relação a outros irmãos na carga XML. O indicador MaintainExistingOrder é ignorado quando o Dimension tem o indicador "KeepSorted" habilitado. O valor por padrão para reterExistingOrder é "1".	1
displayNameEnabled Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	displayNameEnabled = 1 indica que updateDimensions deve respeitar as propriedades de nome de exibição de code , displayNameType e description quando Habilitar nome de exibição está ATIVADO para a instância. displayNameEnabled=0 indica que a updateDimensions API deve continuar seguindo o contrato de API anterior à v30, mesmo quando a opção Habilitar nome de exibição está ATIVADA para a instância. A updateDimensions API ignora as propriedades de nome de exibição code , displayNameType e description . O valor por padrão para displayNameEnabled é "0".
Conteúdo do elemento
Contém uma ou mais dimensões ou valores de dimensão.

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
código Disponível na API v39+.		O código da dimensão. O código deve ser exclusivo.	NewDimensionCode
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. Qualquer alteração nos componentes de um nome de exibição altera a ordem de classificação dos elementos, mesmo com a opção Manter classificado habilitada.	0
displayNameType Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	Controla a exibição de valores de dimensão. Os valores possíveis são NAME, CODE, NAME_CODE ou CODE_NAME. O valor por padrão é NOME quando deixado em branco ou não fornecido. Essa propriedade só fica disponível quando a opção Habilitar nome de exibição está ATIVADA para a instância.	"CODE_NAME"
descrição Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	A descrição da dimensão. Essa propriedade só fica disponível quando a opção Habilitar nome de exibição está ATIVADA para a instância.	"O desc sobre a dimensão"
propriedade1, propriedade2, ...	N	As propriedades da dimensão, se houver, conforme inseridas na Administração da dimensão. Cada dimensão pode ter até cinco propriedades.	"Latitude"
Conteúdo do elemento
Elementos dimensionValue opcionais.

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
ID	S	A ID do valor da dimensão.	34
código Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	O código exclusivo do valor da dimensão.	NewDimensionValue
nome	S	O nome do valor de dimensão. Quando Habilitar nome de exibição está ATIVADO para uma instância com API v30 ou superior, o nome permite valores duplicados. Quando Habilitar nome de exibição está DESATIVADO para uma instância, o código não fica disponível e o nome deve ser exclusivo. Caracteres de nova linha ( ) encontrados entre as palavras são substituídos por um único espaço durante o processamento da carga. Os caracteres de nova linha encontrados no início ou no fim do nome também são substituídos por espaços simples. Esses espaços não aparecem na interface de usuário devido à redução de espaços em branco durante o processamento da carga.	NewDimensionValue
shortName	N	O nome curto do valor de dimensão.	NewDimensionValueShortName
descrição	N	A descrição do valor da dimensão.	This is a NewDimensionValue
allVersions	N	"1" significa que o valor da dimensão está disponível em todas as versões de plano, "0" significa que não está. Se allVersions está ausente, o valor por padrão é 1. updateDimensions só atualiza a disponibilidade de versões de plano. Você não pode atualizar a disponibilidade da versão para versões de valores reais, mesmo quando allVersions = 1. Para indicar a disponibilidade de uma versão específica, defina allVersions como 0 e informe o valor de dimensão disponibilidade para cada versão. Exemplo: supondo que existam as versões 2018a, 2018b, 2018c, 2018d. Para incluir um valor de dimensão somente na versão 2018b: <dimensionValue .... allVersions="0"> <version name="2018a" Available="0"> <version name="2018c" Available="0"> <version name="2018d" Available="0" > No exemplo acima, se allVersions="1", os elementos da versão filho abaixo dela são ignorados.	0
Conteúdo do elemento
Pode conter o elemento de propriedades opcionais.

elemento atributo
Nome da etiqueta		atributo
Descrição		Contêiner para elemento de atributo de uma dimensão. Requer um nome e um valor de atributo preexistentes.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome do atributo de dimensão	Location
valor atualizado na API v34	S	O valor do atributo de dimensão. Se a opção A importação de dimensão cria automaticamente valores de atributo está habilitada na interface de usuário do administrador de atributos de dimensão, qualquer valor de atributo que ainda não existe se torna um novo valor de atributo na dimensão raiz. Para as APIs v32 e v33, esse atributo só é significativo quando a configuração Nome de exibição está DESATIVADA para a instância. Para a API v34 e versões mais recentes: Com suporte quando a configuração de Nome de exibição vigente está ATIVADA. A presença de valueCode e valueName causará erro. Quando a opção A importação de dimensão cria automaticamente valores de atributo está habilitada na interface de usuário do administrador de atributos, a cadeia de caracteres do valor se torna o código e o nome, se o valor ainda não existir. Defina value="" para remover essa marcação de atributo.	SFO
valueCode Disponível somente na API v32 e API v33 para instâncias que habilitam o nome de exibição. Sem suporte na API v34.	S	O código de valor deste atributo. A entrada valueCode é significativa somente quando displayNameEnabled = 1 e a configuração de nome de exibição está ATIVADA para a instância na API v32 e API v33. Defina valueCode="" para remover essa marcação de atributo.	SFO
valueName Disponível somente na API v32 e API v33 para instâncias que habilitam o nome de exibição. Sem suporte na API v34.	N	O nome de um valor de atributo recém-criado automaticamente. O atributo é significativo somente quando: valueCode contém um valor de atributo inexistente. A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1 Chamando a API v32 e a API v33. valueName é ignorado quando valueCode contém um valor de atributo existente.	São Francisco
Conteúdo do elemento
(nenhum)

elemento de versão
Nome da etiqueta		versão
Descrição		Especifica a disponibilidade da versão de plano de um valor de dimensão. Requer uma versão de plano preexistente. A disponibilidade da versão não pode ser alterada para versões virtuais, ocultas, de valores reais, bloqueadas ou arquivadas.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome da versão, como aparece em Administração de versão.	Orçamento de 2015
disponível	S	Se 1, esse valor de dimensão está disponível nesta versão.	1
Conteúdo do elemento
Um ou mais elementos de versão para cada valor de dimensão.

elemento de propriedades Com suporte na API v22
Nome da etiqueta	propriedades
Descrição	Elemento opcional que contém elementos de propriedade.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Contém até cinco elementos de propriedade.

elemento de propriedade Com suporte na API v22
Nome da etiqueta		propriedade
Descrição		Especifica uma propriedade personalizada a ser atualizada. Os valores do elemento de propriedade só podem conter caracteres numéricos.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome da propriedade.	Latitude
valor	S	O valor da propriedade. Um valor vazio apagará o valor da propriedade para o valor da dimensão.	33.6015
Conteúdo do elemento
(nenhum)

Formato da resposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
 <message type="INFO">Dimension was saved successfully.</message>
</messages>
<output>
 <dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" status="">
     <dimensionValue id="44" name="Documentation" description="docs" shortName="" status="created">
     </dimensionValue>
   </dimension>
   <dimension id="16" name="Geography" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0" property1="Latitude" property2="Longitude" status="">                
     <dimensionValue id="521" name="United States" shortName="" description="USA" status="">                    
       <dimensionValue id="555" name="Alabama" shortName="" description="1" status="">                        
         <dimensionValue id="579" name="205" shortName="" description="1" status="">                            
           <dimensionValue id="4718" name="35004" shortName="" description="33" status="">                                
             <properties>                                    
               <property name="Latitude" value="33.6015" status="created" />                                    
               <property name="Longitude" value="86.4895" status="" />                                
             </properties>                            
           </dimensionValue>                            
           <dimensionValue id="4719" name="35005" shortName="" description="" status="" />                        
         </dimensionValue>                        
         <properties>                            
           <property name="Latitude" value="" status="deleted" />                            
           <property name="Longitude" value="86.9023" status="updated" />                        
         </properties>                    
       </dimensionValue>                
     </dimensionValue>            
   </dimension>
 </dimensions>
</output>
</response>

elemento de dimensões
Nome da etiqueta			dimensões
Descrição			Contém uma ou mais dimensões ou valores de dimensão.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Contém uma ou mais dimensões ou valores de dimensão.
retainExistingOrder	N	Se 0, a API updateDimensions deve atualizar a ordem de classificação com base no conteúdo da carga XML. Se 1, a updateDimensions API deve manter a ordem de classificação existente.	1
displayNameEnabled Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.		displayNameEnabled = 1 indica que updateDimensions deve respeitar as propriedades de nome de exibição de code , displayNameType e description quando Habilitar nome de exibição está ATIVADO para a instância. displayNameEnabled=0 indica que a updateDimensions API deve continuar seguindo o contrato de API anterior a 2021.42, mesmo quando a opção Habilitar nome de exibição está ATIVADA para a instância. A updateDimensions API ignora as propriedades de nome de exibição code , displayNameType e description . O suporte para displayNameEnabled começou em 2021.42. O valor por padrão para displayNameEnabled é "0".	1

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	Para criar, a nova ID será fornecida.	16
nome	S	O nome da dimensão, como aparece em relatórios e planilhas.	Cliente
código Disponível na API v39+.	N	O código da dimensão.	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
displayNameType Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	Controla a exibição de valores de dimensão. Os valores possíveis são NAME, CODE, NAME_CODE ou CODE_NAME. O valor por padrão é NOME quando deixado em branco ou não fornecido. Essa propriedade só fica disponível quando a opção Habilitar nome de exibição está ATIVADA para a instância.	CODE_NAME
descrição Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	A descrição da dimensão.
propriedade1, propriedade2,...	N	As propriedades personalizadas da dimensão.
Conteúdo do elemento
Zero or more dimensionValue elements. 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	Para criar, a nova ID será fornecida.	16
código Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	O código exclusivo do valor da dimensão.	Uma empresa
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
status	S	O status do valor de dimensão após a atualização. Para aviso e erro, o elemento de mensagem contém o conteúdo da mensagem. O status atualizado não retorna nenhum conteúdo da mensagem. Erro: foi encontrado um erro na entidade Aviso: um aviso foi encontrado na entidade Criado: a entidade foi criada com êxito Atualizado: a entidade foi atualizada com êxito.	atualizado
mensagem	N	A mensagem de erro para uma entrada dimensionValue inválida.	O nome da dimensão ProductsFirst01234567890123456... não pode ter mais de 64 caracteres
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 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
nome	S	O nome do atributo de dimensão	Location
valor atualizado na API v32	S	O valor do atributo de dimensão. Para a API v32 e versões mais recentes, esse atributo só é significativo quando a configuração Nome de exibição está DESATIVADA para a instância.	São Francisco
valueCode Disponível somente na API v32+ para instâncias que habilitam o nome de exibição.	S	O código de valor deste atributo. Para a API v32 e versões mais recentes, valueCode só faz sentido quando: A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1	SFO
valueName Disponível somente na API v32+ para instâncias que habilitam o nome de exibição.	N	O nome de um valor de atributo recém-criado automaticamente. O atributo é significativo somente quando: valueCode contém um valor de atributo inexistente. A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1value O nome é ignorado quando o valueCode contém um valor de atributo existente.	São Francisco
status	S	O status do valor de dimensão após a atualização. Para aviso e erro, o elemento de mensagem contém o conteúdo da mensagem. O status atualizado não retorna nenhum conteúdo da mensagem. Erro: foi encontrado um erro na entidade Aviso: um aviso foi encontrado na entidade Criado: a entidade foi criada com êxito Atualizado: a entidade foi atualizada com êxito.	atualizado
mensagem	N	A mensagem de erro para uma entrada de atributo inválida.
Conteúdo do elemento
(nenhum)

elemento de versão
Nome da etiqueta		versão
Descrição		Especifica a disponibilidade da versão de plano de um valor de dimensão.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome da versão, como aparece em Administração de versão.	Orçamento de 2015
disponível	S	Se 1, esse valor de dimensão está disponível nesta versão de plano.	1
status	S	O status do valor de dimensão após a atualização. Para aviso e erro, o elemento de mensagem contém o conteúdo da mensagem. O status atualizado não retorna nenhum conteúdo da mensagem. Erro: foi encontrado um erro na entidade Aviso: um aviso foi encontrado na entidade Criado: a entidade foi criada com êxito Atualizado: a entidade foi atualizada com êxito.	atualizado
mensagem	N	A mensagem de erro para uma entrada de versão inválida.
Conteúdo do elemento
Um ou mais elementos de versão para cada valor de dimensão.

elemento de propriedades
Nome da etiqueta	propriedades
Descrição	Contém até cinco elementos de propriedade.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Contém até cinco elementos de propriedade.

elemento de propriedade
Nome da etiqueta		propriedade
Descrição		Especifica uma propriedade personalizada a ser atualizada.
Atributos do elemento
Nome do atributo	Valor		Exemplo
nome	O nome da propriedade.		Latitude
valor	O valor da propriedade. Um valor vazio apagará o valor da propriedade para o valor da dimensão.		33.6015
Status	O status da propriedade após a atualização. Para erro, o elemento de mensagem contém o conteúdo da mensagem de erro. O status atualizado não retorna nenhum conteúdo da mensagem. Erro: foi encontrado um erro na entidade Criado: a entidade foi criada com êxito Atualizado: a entidade foi atualizada com êxito. Nada alterado: um status vazio significa que nada foi alterado para a entidade.
Mensagem	A mensagem de erro para uma entrada de propriedade inválida.		A etiqueta de propriedade requer um atributo de nome.

Categoria	Modificação de metadados
Descrição	Atualize um conjunto de dimensões existentes e seus valores de dimensão. Várias dimensões e vários valores podem ser atualizados em uma chamada. Se for bem-sucedida, a API retorna detalhes das dimensões que acabaram de ser atualizadas.
Permissões obrigatórias para invocar	Modelo e permissões em cada dimensão
Parâmetros obrigatórios na solicitação	Credenciais