Passa al contenuto principale
Documentazione
Documentazione
Adaptive Planning
Ultimo aggiornamento: 2025-10-03
updateDimensions

updateDimensions

Supportato nell'API v17 +
Per una singola richiesta chiamare
updateDimensions
 le richieste sono limitate all'aggiornamento di un massimo di 10.000 valori dimensione in una dimensione gerarchica o di 40.000 valori dimensione in una dimensione fissa. Questi limiti non si applicano alla creazione di nuovi valori dimensione all'interno di una richiesta.
Categoria
Modifica dei metadati
Descrizione
Aggiornare un insieme di dimensioni esistenti e i relativi valori. È possibile aggiornare più dimensioni e più valori in un'unica chiamata. In caso di esito positivo, l'API restituisce i dettagli per le dimensioni appena aggiornate.
Autorizzazioni necessarie per richiamare
Modello e autorizzazioni per ogni dimensione
Parametri obbligatori su richiesta
Credenziali
La richiesta di questo metodo contiene un tag delle credenziali per identificare e autorizzare l'utente chiamante. L'utente deve avere il "Modello" Concetto: Set di autorizzazioni e l'autorizzazione richiesta per amministrare le dimensioni da aggiornare.
Best practice: Invoke exportDimensions per recuperare gli ID dimensione di Planning necessari per la richiesta updateDimensions. Prima di inoltrare la richiesta di updateDimensions, non devono essere apportate modifiche alle dimensioni di pianificazione tramite l'interfaccia utente o le API di Planning.
HTTP
Descrizione
Method
Post
Content-Type
testo/xml

Esempio di arricciatura


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>

Allegare un esempio di arricciatura file XML



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>
Per i payload di grandi dimensioni, è possibile pubblicare file XML compressi (compressi). Consultare Aggiornamento in blocco dei metadati.

Formato richiesta


<?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>
Per l'aggiornamento delle dimensioni si applicano le seguenti condizioni:
  • Le dimensioni e i valori dimensione vengono entrambi identificati per l'aggiornamento tramite il loro numero ID interno.
  • La valuta, una dimensione di sistema, non può essere aggiornata tramite l'API.
  • Per creare nuove dimensioni e valori dimensione, assegnare loro una proprietà ID vuota o mancante.
    • All'interno di una dimensione esistente, è possibile spostare una dimensioneValore esistente (non nuova) in una nuova dimensioneValore. In questo modo si crea il nuovo dimensionValue e si sposta il dimensionValue esistente sotto di esso come figlio.
  • Tutti i valori dimensione creati per le dimensioni fisse sono visibili in tutte le versioni del piano per impostazione predefinita. Per specificare la visibilità, è necessario menzionarla esplicitamente utilizzando:
    • Il
      allVersions
       attributo in
      dimensionValue
       tag
    • O fornendo un figlio
      version
       tag sotto
      dimensionValue
       per fornire visibilità personalizzata
    updateDimensions aggiorna solo la disponibilità delle versioni per le versioni pianificate. Non è possibile aggiornare la disponibilità delle versioni per le versioni importi effettivi, anche quando allVersions=1.

Formato richiesta per la creazione di un nuovo valore dimensione

Per creare un nuovo valore dimensione, includerne il padre tramite l'ID. Ad esempio, per aggiungere un nuovo valore figlio al di sotto di
Engr
 valore che ha
id 7
, è possibile utilizzare:

<?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>
Questo metodo non modifica nulla del valore
id 7
. Crea un nuovo figlio denominato
Docs
 per
id 7
. Tutti i figli non menzionati si spostano alla fine dell'elenco dei figli. Equivale a "impostare il padre" per il nuovo valore, ma viene eseguito includendo il padre come elemento.

Formato richiesta per la creazione di un nuovo valore dimensione con codice e nome

Per creare un nuovo valore dimensione, includerne il padre tramite l'ID. Ad esempio, per aggiungere un nuovo valore figlio al di sotto del valore Engr con ID 7, è possibile utilizzare:
<?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 di input 1: il payload include l'intera struttura ad albero dimensioni

L'API updateDimensions funziona al meglio quando un chiamante desidera fornire il nuovo stato della struttura ad albero senza preoccuparsi delle modifiche.
L'API updateDimensions rileva le modifiche nella struttura dimensione e vengono aggiornati solo i valori dimensione/dimensioni modificati o nuovi. Il
dimensions
 contiene solo un figlio diretto
dimension
 o
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 di input 2: Payload include la struttura della sottostruttura dimensione

Questo formato supporta i casi d'uso quando le modifiche sono limitate a una sola parte della struttura ad albero delle dimensioni.
L'API updateDimensions rileva le modifiche nella struttura dimensione e vengono aggiornati solo i valori dimensione/dimensioni modificati o nuovi. Il
dimensions
 contiene solo un figlio diretto
dimensionValue
 elemento
Ad esempio, le modifiche sono all'interno dell'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>
Per le dimensioni fisse, è necessario specificare il padre
dimension
 tag sotto il
dimensions
 seguito da uno o più valori dimensione
dimensions
 contiene solo un figlio diretto
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 di input 3: aggiornamento di un valore dimensione singola

Questo formato supporta i casi d'uso quando le modifiche sono limitate a un solo valore dimensione.
Il
dimensions
 contiene solo un figlio diretto
dimensionValue
 elemento
Utilizzare il Formato di input 3 solo quando si aggiorna un singolo valore dimensione. Il formato di input 3 non è il formato preferito per l'aggiornamento di più valori dimensione. Non è possibile creare nuove dimensioni/valori dimensione con questo formato. Utilizzare il formato di input 2 per aggiungere nuove dimensioni/valori dimensione.
<?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>

Gestione di più rinominazioni in un'unica chiamata updateDimensions

In un sistema remoto possono essere eseguite più rinominazioni della stessa entità
updateDimensions
 chiamate I nomi delle entità nel sistema remoto possono essere scambiati con gli stessi ID entità. Quando
updateDimensions
 le chiamate avvengono dopo lo scambio del nome, il
updateDimensions
 call gestisce queste modifiche monitorando gli ID delle modifiche al nome. La chiamata può anche gestire l'introduzione di un nuovo ID che utilizza un nome esistente.
Affinché ciascuno degli esempi abbia esito positivo, è necessario che avvenga lo scambio completo degli ID con i valori univoci.
Esempio 1: un semplice scambio di nomi nel sistema remoto.

ID     Unique Value   New Unique Value
1      AA             BB
2      BB             AA
Esempio 2: una sequenza di tre rinominazioni nel sistema remoto.

ID     Unique Value   New Unique Value
1      AA             BB
2      BB             CC
3      CC             AA
Esempio 3: una nuova entità che utilizza un valore univoco esistente.

ID     Unique Value   New Unique Value
4                     AA
1      AA             BB
2      BB             Old BB
elemento credenziali
Nome tag
credenziali
Descrizione
Tutte le chiamate API devono contenere un singolo elemento di credenziali per identificare l'utente che richiama l'API. La chiamata API viene quindi eseguita come utente (qualsiasi audit trail o storico delle azioni nel sistema mostrerà che l'azione è stata eseguita dall'utente) e pertanto l'utente deve disporre delle autorizzazioni necessarie per eseguire l'azione affinché la chiamata API avere esito positivo.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
accedere
S
Il nome di accesso dell'utente che richiama il metodo API. L'utente deve disporre delle autorizzazioni necessarie per richiamare il metodo.
sampleuser@company.com
password
S
La password dell'utente che richiama il metodo API.
my_password
impostazioni internazionali
N
Specificare le impostazioni internazionali da utilizzare per interpretare i numeri e le date in entrata e per formattare i numeri e le date in uscita (utilizzando il separatore delle migliaia, i nomi dei mesi e la formattazione della data appropriati). Le impostazioni internazionali vengono utilizzate anche per specificare la lingua in cui devono essere visualizzati i messaggi di sistema nella risposta. Se non viene specificato, viene utilizzato en_US (inglese americano).
fr_FR
instanceCode
N
Se l'utente specificato nelle credenziali ha accesso a più istanze di Adaptive Planning, questo attributo può essere utilizzato per specificare che l'utente intende accedere a un'istanza diversa da quella predefinita. Se non viene specificata, verrà utilizzata l'istanza predefinita dell'utente. Per determinare i codici di istanza disponibili, utilizzare l'API exportInstances.
MYINSTANCE1
Contenuto dell'elemento
(nessuno)
elemento dimensioni
Nome tag
dimensioni
Descrizione
Contiene una o più dimensioni o valori dimensione.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
retainExistingOrder
Disponibile nell'API v27+
N
retainExistingOrder="1" indica che l'API updateDimensions deve ignorare l'ordine degli elementi nel payload XML e l'ordine definito esistente verrà mantenuto.
retainExistingOrder="0" indica che l'API updateDimensions deve aggiornare l'ordine degli elementi in base alla posizione del tag rispetto ad altri elementi di pari livello nel payload XML.
Il flag retainExistingOrder viene ignorato quando Dimension ha il flag keepSorted abilitato.
Il valore predefinito per retainExistingOrder è "1".
1
displayNameEnabled
Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.
N
displayNameEnabled=1 indica che updateDimensions deve rispettare le proprietà del nome visualizzato di
code
,
displayNameType
e
description
 quando Abilita nome visualizzato è attivo per l'istanza.
displayNameEnabled=0 indica che l'API updateDimensions deve continuare a seguire il contratto API precedente alla v30 anche quando l'opzione Abilita nome visualizzato è attiva per l'istanza. L'API updateDimensions ignora le proprietà del nome visualizzato
code
,
displayNameType
 e
description
.
Il valore predefinito per displayNameEnabled è "0".
Contenuto dell'elemento
Contiene una o più dimensioni o valori dimensione.
elemento dimensione
Nome tag
dimensione
Descrizione
Specifica una dimensione da creare.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
ID
S
ID della dimensione da aggiornare.
34
nome
N
Il nome della dimensione. Il nome deve essere univoco.
NewDimensionName
codice
Disponibile nell'API v39+.
Il codice della dimensione. Il codice deve essere univoco.
NewDimensionCode
shortName
N
Titolo visualizzabile della colonna, come mostrato nel foglio.
NewDimensionShortName
listDimension
N
"1" significa che si tratta di una dimensione elenco, "0" (o non specificato) significa che non lo è.
0
useOnLevels
N
"1" significa che questa dimensione può essere utilizzata nei livelli, "0" (o non specificato) significa che non può.
0
autoCreate
N
"1" significa che i valori per questa dimensione possono essere creati tramite l'importazione, "0" (o non specificato) significa che non è possibile.
0
keepSorted
N
"1" significa che i valori per questa dimensione sono sempre ordinati in ordine alfabetico, "0" (o non specificato) significa che possono essere ordinati manualmente.
Eventuali modifiche ai componenti di un nome visualizzato alterano l'ordinamento degli elementi, anche se l'opzione Mantieni ordinamento è abilitata.
0
displayNameType
Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.
N
Controlla la visualizzazione dei valori dimensione. I valori possibili sono NAME, CODE, NAME_CODE o CODE_NAME.
Il valore predefinito è NAME se lasciato vuoto o non specificato.
Questa proprietà è disponibile solo quando Abilita nome visualizzato è su ON per l'istanza.
"CODE_NAME"
descrizione
Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.
N
La descrizione della dimensione.
Questa proprietà è disponibile solo quando Abilita nome visualizzato è su ON per l'istanza.
"Descrizione su dim"
proprietà1, proprietà2, ...
N
Le proprietà della dimensione, se presenti, immesse in Amministrazione dimensioni. Ogni dimensione può avere fino a cinque proprietà.
"Latitudine"
Contenuto dell'elemento
Elementi facoltativi dimensionValue.
dimensionValue
Nome tag
dimensionValue
Descrizione
Specifica un valore dimensione da aggiornare.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
ID
S
ID del valore dimensione.
34
codice
Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.
N
Il codice univoco del valore dimensione.
NewDimensionValue
nome
S
Il nome del valore dimensione. Quando l'opzione Abilita nome visualizzato è attiva per un'istanza con API v30 o successiva, il nome consente valori duplicati. Quando l'opzione Abilita nome visualizzato è disattivata per un'istanza, il codice non è disponibile e il nome deve essere univoco.
Caratteri di nuova riga (
&#10;)
 le parole trovate tra le parole vengono sostituite con un singolo spazio durante l'elaborazione del payload.
Anche i caratteri di nuova riga che si trovano all'inizio o alla fine del nome vengono sostituiti con spazi singoli. Questi spazi non vengono visualizzati nell'interfaccia utente a causa della riduzione degli spazi durante l'elaborazione del payload.
NewDimensionValue
shortName
N
Il nome abbreviato del valore dimensione.
NewDimensionValueShortName
descrizione
N
La descrizione del valore dimensione.
This is a NewDimensionValue
allVersions
N
"1" significa che il valore dimensione è disponibile in tutte le versioni del piano, "0" significa che non lo è. Se allVersions è mancante, il valore predefinito è 1.
updateDimensions aggiorna solo la disponibilità delle versioni per le versioni pianificate. Non è possibile aggiornare la disponibilità delle versioni per le versioni importi effettivi, anche quando allVersions=1.
Per indicare la disponibilità di una versione specifica, impostare allVersions su 0 e fornire la disponibilità del valore dimensione per ogni versione.
Esempio: presupponendo che siano presenti le versioni 2018a, 2018b, 2018c, 2018d Per includere un valore dimensione solo nella versione 2018b:
<dimensionValue .... allVersions="0"> <version name="2018a" available="0"> <version name="2018c" available="0"> <version name="2018d" available="0" >
Nell'esempio precedente, se allVersions="1", gli elementi della versione figlio sottostanti vengono ignorati.
0
Contenuto dell'elemento
Può contenere l'elemento delle proprietà facoltativo.
elemento attributo
Nome tag
attributo
Descrizione
Contenitore per un elemento attributo dimensione. Richiede un nome e un valore di attributo preesistenti.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
nome
S
Il nome dell'attributo dimensione
Location
valore
aggiornato nell'API v34
S
Il valore dell'attributo dimensione.
Se l'opzione Importazione dimensione crea automaticamente valori attributo è abilitata nell'interfaccia utente dell'amministratore degli attributi dimensione, qualsiasi valore attributo che non esiste già diventa un nuovo valore attributo nella dimensione radice.
Per API v32 e v33, questo attributo è significativo solo quando l'impostazione Nome visualizzato è disattivata per l'istanza.
Per API v34 e versioni successive:
  • Supportato quando l'impostazione Nome visualizzato effettivo è attiva.
  • La presenza di valueCode e valueName comporterà un errore.
  • Quando l'opzione Importazione dimensione crea automaticamente valori attributo è abilitata nell'interfaccia utente dell'amministratore degli attributi, la stringa di valore diventa il codice e il nome se il valore non esiste già.
Impostare value="" per rimuovere la codifica di questo attributo.
SFO
valueCode
Disponibile solo in API v32 e API v33 per le istanze che abilitano il nome visualizzato.
Non supportato nell'API v34.
S
Il codice valore attributo per questo attributo.
L'input valueCode è significativo solo quando displayNameEnabled=1 e l'impostazione Nome visualizzato è ON per l'istanza in API v32 e API v33.
Impostare valueCode="" per rimuovere la codifica degli attributi.
SFO
valueName
Disponibile solo in API v32 e API v33 per le istanze che abilitano il nome visualizzato.
Non supportato nell'API v34.
N
Il nome di un nuovo valore attributo creato automaticamente.
L'attributo è significativo solo quando:
  • valueCode contiene un valore attributo inesistente.
  • L'impostazione Nome visualizzato è ATTIVA per l'istanza.
  • displayNameEnabled=1
  • API di chiamata v32 e API v33.
valueName viene ignorato quando valueCode contiene un valore attributo esistente.
San Francisco
Contenuto dell'elemento
(nessuno)
elemento versione
Nome tag
versione
Descrizione
Specifica la disponibilità della versione pianificata di un valore dimensione. Richiede una versione del piano preesistente. La disponibilità delle versioni non può essere modificata per le versioni virtuali, nascoste, effettive, bloccate o archiviate.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
nome
S
Il nome della versione, così come appare in Amministrazione versione.
Budget 2015
disponibile
S
Se 1, questo valore dimensione è disponibile in questa versione.
1
Contenuto dell'elemento
Uno o più elementi della versione per ogni valore dimensione.
elemento delle proprietà
Supportato nell'API v22
Nome tag
proprietà
Descrizione
Elemento facoltativo che contiene elementi proprietà.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Contiene fino a cinque elementi proprietà.
elemento di proprietà
Supportato nell'API v22
Nome tag
proprietà
Descrizione
Specifica una proprietà personalizzata da aggiornare. I valori degli elementi proprietà possono contenere solo caratteri numerici.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
nome
S
Il nome della proprietà.
Latitudine
valore
S
Il valore della proprietà. Un valore vuoto cancellerà il valore della proprietà per il valore dimensione.
33.6015
Contenuto dell'elemento
(nessuno)

Formato risposta


<?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 dimensioni
Nome tag
dimensioni
Descrizione
Contiene una o più dimensioni o valori dimensione.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Contiene una o più dimensioni o valori dimensione.
retainExistingOrder
N
Se 0, l'API updateDimensions dovrebbe aggiornare l'ordinamento in base al contenuto del payload XML.
Se 1, l'API updateDimensions deve mantenere l'ordinamento esistente.
1
displayNameEnabled
Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.
displayNameEnabled=1 indica che updateDimensions deve rispettare le proprietà del nome visualizzato di
code
,
displayNameType
e
description
 quando Abilita nome visualizzato è attivo per l'istanza.
displayNameEnabled=0 indica che l'API updateDimensions deve continuare a seguire il contratto API precedente alla versione 2021.42 anche quando l'opzione Abilita nome visualizzato è attiva per l'istanza. L'API updateDimensions ignora le proprietà del nome visualizzato
code
,
displayNameType
 e
description
.
Il supporto per displayNameEnabled è iniziato nel 2021.42. Il valore predefinito per displayNameEnabled è "0".
1
elemento dimensione
Nome tag
dimensione
Descrizione
Rappresenta una singola dimensione personalizzata restituita nella risposta a una chiamata API exportDimensions.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
ID
S
Per la creazione, verrà fornito il nuovo ID.
16
nome
S
Il nome della dimensione, così come appare nei report e nei fogli.
Customer
codice
Disponibile nell'API v39+.
N
Il codice della dimensione.
Customer
shortName
N
Il nome abbreviato della dimensione, se presente, immesso in Amministrazione dimensioni
personalizzato
autoCreate
S
1 se per la dimensione selezionata è impostato il campo "L'importazione dati crea automaticamente valori dimensione"; 0 in caso contrario.
0
listDimension
S
1 se la dimensione selezionata è una dimensione elenco; 0 in caso contrario.
1
keepSorted
S
1 se la dimensione selezionata viene mantenuta in ordine, 0 in caso contrario.
1
useOnLevels
S
1 se la dimensione selezionata può essere utilizzata nei livelli, 0 in caso contrario.
1
displayNameType
Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.
N
Controlla la visualizzazione dei valori dimensione. I valori possibili sono NAME, CODE, NAME_CODE o CODE_NAME.
Il valore predefinito è NAME se lasciato vuoto o non specificato.
Questa proprietà è disponibile solo quando Abilita nome visualizzato è su ON per l'istanza.
CODE_NAME
descrizione
Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.
N
La descrizione della dimensione.
proprietà1,proprietà2,...
N
Le proprietà personalizzate della dimensione
Contenuto dell'elemento
Zero o più elementi dimensionValue. Ogni elemento dimensionValue racchiuso rappresenta un "valore dimensione radice" nella dimensione, un valore che non ha un valore padre.
dimensionValue
Nome tag
dimensionValue
Descrizione
Rappresenta un singolo valore membro di una dimensione personalizzata restituito nella risposta a una chiamata all'API exportDimensions.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
ID
S
Per la creazione, verrà fornito il nuovo ID.
16
codice
Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.
N
Il codice univoco del valore dimensione.
Un'azienda
nome
S
L'etichetta del valore membro della dimensione, visualizzata nei report e utilizzata nelle formule.
Un'azienda
shortName
N
Il nome abbreviato del valore dimensione, se presente, immesso in Amministrazione dimensioni
A
descrizione
N
La descrizione dell'eventuale valore dimensione immesso in Amministrazione dimensioni
Un'azienda
stato
S
Lo stato del valore dimensione dopo l'aggiornamento. Per gli avvisi e gli errori, l'elemento del messaggio contiene il contenuto del messaggio. Lo stato di aggiornamento non restituisce alcun contenuto del messaggio.
  • Errore: è stato rilevato un errore nell'entità
  • Avviso: è stato trovato un avviso nell'entità
  • Created: l'entità è stata creata
  • Aggiornato: l'entità è stata aggiornata
aggiornato
messaggio
N
Il messaggio di errore per un input dimensionValue non valido.
Il nome della dimensione ProductsFirst01234567890123456... non può contenere più di 64 caratteri
Contenuto dell'elemento
Zero o più elementi facoltativi dimensionValue. Ogni elemento dimensionValue racchiuso rappresenta un "valore dimensione figlio" di questo valore dimensione, i cui membri eseguono implicitamente il rollup a questo valore.
elemento attributo
Nome tag
attributo
Descrizione
Contenitore per un elemento attributo dimensione.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
nome
S
Il nome dell'attributo dimensione
Location
valore
aggiornato nell'API v32
S
Il valore dell'attributo dimensione.
Per API v32 e versioni successive, questo attributo è significativo solo quando l'impostazione Nome visualizzato è disattivata per l'istanza.
San Francisco
valueCode
Disponibile solo nell'API v32+ per le istanze che abilitano il nome visualizzato.
S
Il codice valore attributo per questo attributo.
Per API v32 e versioni successive, valueCode è significativo solo quando:
  • L'impostazione Nome visualizzato è ATTIVA per l'istanza.
  • displayNameEnabled=1
SFO
valueName
Disponibile solo nell'API v32+ per le istanze che abilitano il nome visualizzato.
N
Il nome di un nuovo valore attributo creato automaticamente.
L'attributo è significativo solo quando:
  • valueCode contiene un valore attributo inesistente.
  • L'impostazione Nome visualizzato è ATTIVA per l'istanza.
  • displayNameEnabled=1value
Il nome viene ignorato quando valueCode contiene un valore attributo esistente.
San Francisco
stato
S
Lo stato del valore dimensione dopo l'aggiornamento. Per gli avvisi e gli errori, l'elemento del messaggio contiene il contenuto del messaggio. Lo stato di aggiornamento non restituisce alcun contenuto del messaggio.
  • Errore: è stato rilevato un errore nell'entità
  • Avviso: è stato trovato un avviso nell'entità
  • Created: l'entità è stata creata
  • Aggiornato: l'entità è stata aggiornata
aggiornato
messaggio
N
Il messaggio di errore per un attributo non valido.
Contenuto dell'elemento
(nessuno)
elemento versione
Nome tag
versione
Descrizione
Specifica la disponibilità della versione pianificata di un valore dimensione.
Attributi dell'elemento
Nome attributo
Obbligatorio?
Valore
Esempio
nome
S
Il nome della versione, così come appare in Amministrazione versione.
Budget 2015
disponibile
S
Se 1, questo valore dimensione è disponibile in questa versione del piano.
1
stato
S
Lo stato del valore dimensione dopo l'aggiornamento. Per gli avvisi e gli errori, l'elemento del messaggio contiene il contenuto del messaggio. Lo stato di aggiornamento non restituisce alcun contenuto del messaggio.
  • Errore: è stato rilevato un errore nell'entità
  • Avviso: è stato trovato un avviso nell'entità
  • Created: l'entità è stata creata
  • Aggiornato: l'entità è stata aggiornata
aggiornato
messaggio
N
Il messaggio di errore per un input di versione non valido.
Contenuto dell'elemento
Uno o più elementi della versione per ogni valore dimensione.
elemento delle proprietà
Nome tag
proprietà
Descrizione
Contiene fino a cinque elementi proprietà.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Contiene fino a cinque elementi proprietà.
elemento di proprietà
Nome tag
proprietà
Descrizione
Specifica una proprietà personalizzata da aggiornare.
Attributi dell'elemento
Nome attributo
Valore
Esempio
nome
Il nome della proprietà.
Latitudine
valore
Il valore della proprietà. Un valore vuoto cancellerà il valore della proprietà per il valore dimensione.
33.6015
Stato
Lo stato della proprietà dopo l'aggiornamento. In caso di errore, l'elemento message contiene il contenuto del messaggio di errore. Lo stato di aggiornamento non restituisce alcun contenuto del messaggio.
  • Errore: è stato rilevato un errore nell'entità
  • Created: l'entità è stata creata
  • Aggiornato: l'entità è stata aggiornata
  • Nothing Changed: uno stato vuoto significa che non è stato modificato nulla per l'entità.
Messaggio
Il messaggio di errore per un input di proprietà non valido.
Il tag proprietà richiede un attributo name.