updateDimension

Non supportato nell'API v20 +. Utilizzare updateDimensions.

Categoria	Modifica dei metadati
Descrizione	Aggiornare una dimensione. In caso di esito positivo, l'API restituisce i dettagli per la dimensione appena aggiornata.
Autorizzazioni necessarie per richiamare	Modello
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 disporre dell'autorizzazione Modello per creare la dimensione.

Le seguenti condizioni si applicano a questa API:

Questo metodo restituisce un errore se sono presenti modifiche non pubblicate.

Non è possibile disattivare listDimension se sono stati definiti attributi dimensione o se i valori non sono tutti disponibili in tutte le versioni.

Non è possibile disattivare listDimension se si dispone di dimensionValues gerarchici.

Non è possibile abilitare sia useOnLevels che listDimension. È possibile disattivare uno e l'altro nello stesso comando.

Formato richiesta


<?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 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 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
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.	0
Contenuto dell'elemento
(nessuno)

Formato risposta


<?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 dimensioni
Nome tag	dimensioni
Descrizione	Contenitore per uno o più elementi dimensione.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o più elementi dimensione.

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	Il numero ID di sistema interno per la dimensione. Può essere utilizzato per identificare le dimensioni in altre chiamate API, ad esempio exportDimensionFamilies.	16
nome	S	Il nome della dimensione, così come appare nei report e nei fogli.	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
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	Il numero ID sistema interno per questo valore membro della dimensione.	34
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
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 attributi
Nome tag		attributi
Descrizione		Contenitore per uno o più elementi attributo dimensione.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi attributo.

elemento attributo
Nome tag		attributo
Descrizione		Contenitore per un elemento attributo dimensione.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
attributeID	S	ID dell'attributo dimensione generato dal sistema.	20
nome	S	Il nome dell'attributo dimensione	Tipo di istruzione
valueID	S	L'ID univoco del valore dell'attributo dimensione generato dal sistema.	170
valore	S	Il valore dell'attributo dimensione.	Tech1
Contenuto dell'elemento
(nessuno)