createLevel

Non supportato nell'API v20 +. Utilizzare updateLevels.

Categoria	Modifica dei metadati
Descrizione	Creare un livello. In caso di esito positivo, l'API restituisce i dettagli per il livello appena creato.
Autorizzazioni necessarie per richiamare	Struttura organizzazione
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 Struttura organizzativa per creare il livello.

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

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="createLevel" callerName="fred">
    <credentials login="sampleuser@company.com" password="my_pwd" />
    <level
       name="New Level Name"
       shortName="NewLvlName"
       parentId="2"
    >
         <attributes>
             <attribute attributeId="20" valueId="199" />
         </attributes>
     </level>
</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 livello
Nome tag		level
Descrizione		Specifica un livello da creare.
Attributi dell'elemento
parentId	S	L'ID del livello di cui creare il livello come figlio.	34
nome	S	Il nome del livello. Il nome deve essere univoco.	Nuovo nome livello
shortName	N	Il nome abbreviato del livello.	NewLvName
procedere- WithWarnings	N	Indica se l'utente desidera ignorare i messaggi di avviso e procedere con l'operazione di creazione. 0 per no, 1 per sì. Se sono presenti avvisi e procedereWithWarnings=0, il livello non verrà creato. Impostare proceWithWarnings=1 per creare il livello quando sono presenti avvisi.	1
Contenuto dell'elemento
Un elemento attributi facoltativo se si desidera impostare uno o più attributi di livello associati al livello.

elemento attributi
Nome tag		attributi
Descrizione		Contenitore per uno o più elementi attributo di livello.
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 di livello.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
attributeID	S	ID dell'attributo di livello generato dal sistema.	20
valueID	S	L'ID univoco del valore dell'attributo di livello generato dal sistema. Se questo valore è 0, l'attributo viene rimosso dal conto.	170
Contenuto dell'elemento
(nessuno)

Formato risposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <output>
       <levels>
           <level="41" name="New Level Name" shortName="NewLvlName" currency="USD">
               <attribute attributeId="20" name="Regional Code" valueId="199" value="A-145" />
           </level>
       </levels>
   </output>
</response>

elemento di output
Nome tag	output
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Un singolo elemento di livello obbligatorio. Questo wrapper di output è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita.

elemento livelli
Nome tag		livelli
Descrizione		Contenitore per l'elemento livello.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
Contenuto dell'elemento
Uno o più elementi di livello. Se la richiesta include livelli inaccessibili, sarà presente un solo elemento livello, che rappresenta il livello più alto dell'organizzazione.

elemento livello
Nome tag		level
Descrizione		Rappresenta un singolo livello di organizzazione restituito nella risposta a una chiamata API exportLevels.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID sistema interno per il livello.	7
nome	S	Il nome del livello, come appare nei report e nei fogli.	Sviluppo
valuta	S	Il codice valuta assegnato a questo livello dell'organizzazione. La valuta sarà una delle valute configurate per l'istanza, trovata nella chiamata exportActiveCurrencies.	INR
shortName	N	Abbreviazione del livello, se presente, immessa in Amministrazione organizzazione.	Dev
disponibileStart	N	La data di inizio della disponibilità del livello per la verifica degli importi effettivi, applicabile solo quando nella richiesta è specificata la versione Importi effettivi. Il valore può essere un mese specifico, nel formato "MM/AAAA" o il valore speciale "INIZIO" che indica l'inizio della versione.	01/2013
disponibileEnd	N	La data di fine della disponibilità del livello per la verifica degli importi effettivi, applicabile solo quando nella richiesta è specificata la versione Importi effettivi. Il valore può essere un mese specifico, nel formato "MM/AAAA" o il valore speciale "END" che indica la fine della versione.	12/2013
isImportable	N	Indica se il livello associato è importabile nella versione specificata. "0" significa che non è importabile e "1" significa che è importabile. Un livello è importabile se è importabile almeno una fascia oraria nella versione specificata. L'attributo isImportable viene emesso solo se nella richiesta è specificato versionName o versionID. Nota: isImportable indica solo che un livello è disponibile per l'importazione nella versione specificata, non che l'utente che effettua la chiamata API dispone dell'autorizzazione per l'importazione nella versione o nel livello. Utilizzare exportVersions per vedere quali versioni sono disponibili per l'importazione.	1
workflowStatus	N	Specifica lo stato del workflow per il livello associato. I per "In corso", S per "Inoltrato", R per "Rifiutato", A per "Approvato" e L per "Bloccato". Incluso nella risposta solo se il workflow è abilitato per l'azienda e nella richiesta è specificato un versionName o un versionID di pianificazione. Workflow non è disponibile nelle versioni importi effettivi.	I
isLinked	S	Indica se il livello è collegato. 0 per no, 1 per sì.	1
isElimination	S	Indica se il livello è un livello di eliminazione. 0 per no, 1 per sì.	0
Contenuto dell'elemento
Un elemento di livello nidificato per ogni livello figlio diretto di questo livello. Un elemento attributi se a questo livello sono associati uno o più attributi.

elemento attributi
Nome tag		attributi
Descrizione		Contenitore per uno o più elementi attributo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi attributo.

elemento attributo
Nome tag		attributo
Descrizione		Rappresenta una singola mappatura degli attributi di livello non vuoti a cui è associato un livello.
Attributi dell'elemento
Nome attributo	Obbligatorio ?	Valore	Esempio
nome	S	Il nome dell'attributo di livello	Sconto aziendale
valore	S	Il valore dell'attributo di livello associato al livello.	Sì
attributeID	S	Il numero ID sistema interno dell'attributo livello.	20
valueID	S	Il numero ID sistema interno del valore attributo livello.	188
Contenuto dell'elemento
(nessuno)