updateLevels

HTTP	Descrizione
Method	Post
Content-Type	testo/xml

Esempio di arricciatura


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

updateLevels.xml

Formato richiesta

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd"/>
<levels>
<level id="1" name="HQ">
 <level id="2" name="Engineering" currency="USD" shortName="Engr">
   <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0"/>
   <level id="9" name="QA" currency="INR" eliminationTradingPartner="1"/>
   <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1">
      <version name="Budget 2011" available="1"/>
      <version name="Budget 2012" available="0"/>
      <version name="Budget 2013" available="1"/>
   </level>
 </level>
 <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" eliminationLevel="1">
     <attribute name="Corporate Discount" value="Available"/>
     <attribute name="Transfers Restricted" value="Yes"/>
     <dimension name="Region" value="C-US"/>
 </level>
</level>
</levels>
</call>

Per i payload di grandi dimensioni, è possibile pubblicare file XML compressi (compressi). Consultare Aggiornamento in blocco dei metadati.

Per updateLevels si applicano le seguenti condizioni:

I livelli vengono identificati per l'aggiornamento tramite il loro numero ID interno.

Per creare nuovi livelli, assegnare loro una proprietà ID vuota o mancante.

È possibile spostare un elemento esistente (non nuovo) in modo che diventi figlio di un nuovo elemento. In questo modo si crea il nuovo elemento e si sposta l'elemento esistente sotto di esso come figlio.

Impossibile aggiornare la disponibilità dei fogli e l'accesso degli utenti

updateLevels

.

Formato richiesta per la creazione di un nuovo livello

Per creare un nuovo livello, includerne il padre tramite l'ID. Ad esempio, per aggiungere un nuovo livello figlio al di sotto di

Engr

valore che ha

id 7

, è possibile utilizzare:

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateLevels" callerName="Steve C">
 <credentials login="stevec@greenco.com" password="password"/>
 <levels>
   <level id="7">
     <level id="" name="Documentation" description="docs" shortName="" >
     </level>
   </level>
 </levels>
</call>

Questo metodo non modifica nulla del livello

id 7

. Crea un nuovo figlio denominato

Documnentation

per

id 7

. Tutti i figli non menzionati di

Engr

spostarsi alla fine dell'elenco figlio. Equivale a "impostare il padre" per il nuovo livello.

Formato di input 1: il payload include l'intero albero

L'API updateLevels funziona al meglio quando un chiamante desidera fornire il nuovo stato della struttura ad albero senza preoccuparsi delle modifiche.

L'API updateLevels rileva le modifiche nella struttura dei livelli e vengono aggiornati solo i livelli appena aggiunti o modificati. Si noti che il

levels

contiene un solo figlio diretto

level

elemento L'elemento figlio contiene quindi il resto della gerarchia.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<levels>
   <level id="1" name="HQ">
      <level id="2" name="Engineering" currency="USD" shortName="Engr">
         <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0" />
         <level id="9" name="QA" currency="INR" eliminationTradingPartner="1" />
         <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1" />
      </level>
      <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" eliminationLevel="1" />
   </level>
</levels>
</call>

Formato di input 2: Payload include la struttura della sottostruttura a livello

Questo formato supporta i casi d'uso quando le modifiche sono limitate a una sola parte della struttura ad albero dei livelli.

Ad esempio, le modifiche rientrano nel livello Engineering. Anche in questo caso, il

levels

contiene solo un figlio diretto

level

elemento Tale livello contiene il resto dei livelli della struttura ad albero secondario. La sottostruttura più piccola per questo formato include solo un padre e un figlio.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<levels>
   <level id="2" name="Engineering" currency="USD" shortName="Engr">
      <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0" />
      <level id="9" name="QA" currency="INR" eliminationTradingPartner="1" />
      <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1" />
   </level>
</levels>
</call>

Formato di input 3: aggiornamento di un singolo livello

Questo formato supporta la gestione del caso d'uso quando le modifiche sono limitate a un solo livello. Il

levels

contiene solo un figlio diretto

level

elemento

Utilizzare solo il formato di input 3 quando si aggiorna un singolo livello. Il formato di input 3 non è il formato preferito per l'aggiornamento di più livelli. Non è possibile creare un nuovo livello con questo formato. Utilizzare il formato di input 2 per aggiungere nuovi livelli figlio.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<levels>
   <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1" />
</levels>
</call>

Formato di input 4: formato semplice contenente tutte le etichette di livello sotto l'etichetta dei livelli

Questo formato contiene

level

sotto i tag

levels

tag in un formato semplice senza una gerarchia. Si aggiornano solo le proprietà di ogni livello elencato, senza alterare le gerarchie dei livelli.

Utilizzare il formato flat solo per i delta o le modifiche incrementali a porzioni molto ridotte della gerarchia. Il formato di input 1 offre le prestazioni migliori per il caricamento dell'intera gerarchia di livelli.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="steve@steveco.com" password="" />
<levels>
   <level id="2" name="Engineering" currency="USD" shortName="Engr" />
   <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0" />
   <level id="9" name="QA" currency="INR" eliminationTradingPartner="1" />
   <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1">
      <version name="Budget 2011" available="1" />
      <version name="Budget 2012" available="0" />
      <version name="Budget 2013" available="1" />
   </level>
</levels>
</call>

Gestione di più rinominazioni in un'unica chiamata updateLevels

In un sistema remoto possono essere eseguite più rinominazioni della stessa entità

updateLevels

chiamate I nomi delle entità nel sistema remoto possono essere scambiati con gli stessi ID entità. Quando

updateLevels

le chiamate avvengono dopo lo scambio del nome, il

updateLevels

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 livelli
Nome tag		livelli
Descrizione		È consentita una sola richiesta di elemento livelli per payload. Contiene uno o più elementi di livello.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
retainExisitingOrder Disponibile nell'API v26+	N	retainExistingOrder="1" indica che l'API updateLevels deve ignorare l'ordine degli elementi nel payload XML e l'ordine definito esistente verrà mantenuto. retainExistingOrder="0" indica che l'API updateLevels deve aggiornare l'ordine degli elementi in base alla posizione del tag rispetto ad altri elementi di pari livello nel payload XML. L'attributo retainExistingOrder viene ignorato nella versione API precedente all'API v26. Il valore predefinito per retainExistingOrder è "0" per la versione 26. Per la versione API v27 e successive, 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 updateLevels 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 updateLevels deve continuare a seguire il contratto API precedente alla v30 anche quando l'opzione Abilita nome visualizzato è attiva per l'istanza. L'API updateLevels ignora le proprietà del nome visualizzato code , displayNameType e description . Il valore predefinito per displayNameEnabled è "0".	1
Contenuto dell'elemento
Contiene uno o più elementi di livello.

elemento livello
Nome tag		level
Descrizione		Specifica un livello da creare.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	ID del livello da aggiornare.	34
codice Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Il codice univoco del livello. Questa proprietà è disponibile solo quando Abilita nome visualizzato è su ON per l'istanza.	NewLevelName
nome	N	Il nome del livello. 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.	NewLevelName
shortName aggiornato nell'API v30	N	Titolo visualizzabile della colonna, come mostrato nel foglio.	NewLevelShortName
valuta	N	Il codice valuta assegnato a questo livello dell'organizzazione. La valuta sarà una delle valute configurate per l'istanza, trovata nella chiamata exportActiveCurrencies.	USD
publishCurrency Disponibile nell'API v24+	N	PublishCurrency imposta la valuta dell'azienda Workday quando si pubblica un piano finanziario. La valuta di pubblicazione viene caricata tramite il caricatore livelli di Planning nell'integrazione di Workday Adaptive Planning come attributo di valuta aggiuntivo per un livello. PublishCurrency indica una delle valute configurate per l'istanza, che si trova nella chiamata exportActiveCurrency e nell'interfaccia utente di Levels Admin. Disponibile solo quando si configura Adaptive Planning for Workday. Consultare la sezione Pubblicazione piani di Procedura: Configurare Adaptive Planning per HCM e dati finanziari.	CAD
inWorkflow	N	Indica se questo livello partecipa a un workflow.	1
propagateToDescendants	N	Indica se le modifiche vengono propagate ai figli di questo livello. 0 per no, 1 per sì. Non tutte le proprietà del livello sono coperte da propagateToDescendants. Per un elenco delle proprietà interessate da propagateToDescendants , vedere propagateToDescendants durante le richieste UpdateLevels.	0
eliminationLevel	N	Indica se questo livello è un livello di eliminazione da utilizzare nelle eliminazioni interaziendali. Un livello può essere un livello di eliminazione o un partner commerciale di eliminazione, ma non entrambi.	1
eliminationTradingPartner	N	Indica se questo livello è un partner commerciale di eliminazione. Un livello può essere un partner commerciale di eliminazione o un livello di eliminazione, ma non entrambi.	0
actualsStart	N	Indica l'inizio degli importi effettivi per questo livello. Deve essere un codice orario esistente da Amministrazione ore nello strato temporale predefinito.	Maggio-2013
actualsEnd	N	Indica la fine degli importi effettivi per questo livello. Deve essere un codice orario esistente da Amministrazione ore nello strato temporale predefinito.	Dec-2018
descrizione Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	La descrizione del livello. Questa proprietà è disponibile solo quando Abilita nome visualizzato è su ON per l'istanza.	Il reparto più in alto
Contenuto dell'elemento
Uno o più elementi attributo se si desidera impostare uno o più attributi di livello associati al livello.

elemento versione
Nome tag		versione
Descrizione		Specifica la disponibilità della versione di un livello. Richiede una versione preesistente.
Attributi dell'elemento
Nome attributo	Obbligatorio?		Esempio
nome	S	Il nome della versione, così come appare in Amministrazione versione.	Budget 2015
disponibile	S	Se 1 questa versione è disponibile in questo livello.	1
Contenuto dell'elemento
Uno o più elementi della versione per ogni livello

elemento attributo
Nome tag		attributo
Descrizione		Specifica un attributo da aggiornare.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome aggiornato nell'API v30	S	Il nome dell'attributo.	Location
valore aggiornato nell'API v34	S	Il valore dell'attributo per questo attributo. 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 livelli crea automaticamente valori attributo è abilitata nell'interfaccia utente di amministrazione 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.	170
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	L'attributo valueName è 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 dimensione
Nome tag		dimensione
Descrizione		Specifica le assegnazioni dei valori dimensione del livello.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome aggiornato nell'API v30	S	Il nome della dimensione.	Budget 2015
valore aggiornato nell'API v34	S	Il valore dimensione per questa dimensione disponibile in questo livello. Per API v32 e API v33, il valore è 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 dati crea automaticamente valori dimensione è abilitata nell'interfaccia utente di amministrazione dimensione, la stringa di valore diventa il codice e il nome se il valore non esiste già.	Lahore
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 dimensione per questa dimensione disponibile in questo livello. Per API v32 e API v33, valueCode è significativo solo quando: L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1	LHE
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 dimensione creato automaticamente. Per API v32 e API v33, valueName ha senso solo quando valueCode contiene un valore dimensione inesistente. L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1	Lahore
Contenuto dell'elemento
(nessuno)

Elaborazione payload dall'alto verso il basso

Gli attributi per i livelli raggruppano logicamente i valori e i livelli di tag. Poiché l'API updateLevels elabora il payload XML dall'alto verso il basso, assegnare un attributo di livello per il livello padre prima di modificare i valori del livello attributo figlio. I livelli figlio possono essere contrassegnati con qualsiasi valore attributo quando il valore attributo del livello padre è vuoto. Se gli attributi di livello non si allineano con l'attributo padre, si verifica un errore di convalida della compatibilità.

Si consideri la struttura ad albero seguente in cui il padre "California" ha due livelli figlio "Palo Alto" e "Pleasanton". Gli attributi di livello "Palo Alto" e "Pleasanton" sono di pari livello.


Location
|__USA                              
|__California
   |__Palo Alto
   |__Pleasanton

Esempio di XML richiesta originale con attributi di livello

Si noti che il valore dell'attributo sede "Palo Alto" è assegnato sia a "Ingegneria" sia a "Sviluppo".


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <attribute name="Location" value="" />
   <level id="2" name="Engineering">
      <attribute name="Location" value="Palo Alto" />
      <level id="8" name="Development">
         <attribute name="Location" value="Palo Alto" />
      </level>
   </level>  
</level>
</levels>

Esempio di ordine errato per elaborazione payload

Il payload XML seguente genera un errore "

The attribute value Pleasanton is not compatible with the parent's attribute value

". L'elaborazione del payload dall'alto verso il basso considera il livello padre "Engineering" come valore dell'attributo di sede "Palo Alto" del blocco di codice precedente ed elabora "Pleasanton" come figlio di "Palo Alto". L'errore viene generato perché il livello figlio "Sviluppo" può avere solo l'attributo sede "Palo-Alto", come indicato nella struttura ad albero.


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <level id="2" name="Engineering">
      <level id="8" name="Development">
         <attribute name="Location" value="Pleasanton" />
      </level>
      <attribute name="Location" value="California" /> <!-- Level Attribute change ignored due to placement order-->
   </level>
   <attribute name="Location" value="" />
</level>
</levels>

Esempio di ordine valido per elaborazione payload

La riorganizzazione dell'ordine di posizionamento dell'attributo "California" sotto "Ingegneria" consente all'API di elaborare prima l'attributo di livello padre, consentendo al livello figlio "Sviluppo" di avere il valore dell'attributo di sede "Palo Alto" o "Pleasanton" .


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <attribute name="Location" value="" /> <!-- Level Attribute change processed due to correct placement order-->
   <level id="2" name="Engineering">
      <attribute name="Location" value="California" />
      <level id="8" name="Development">
         <attribute name="Location" value="Pleasanton" />
      </level>
   </level>
</level>
</levels>

La disponibilità delle versioni di un livello funziona allo stesso modo. Impostare la disponibilità della versione di un livello prima di modificare i livelli figlio per evitare errori di compatibilità.

Esempio di XML richiesta originale con versioni

Si noti che la disponibilità della versione "Budget 2020" per i livelli "Ingegneria" e "Sviluppo" è impostata su "0".


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <version name="Budget 2020" available="0" />
   <level id="2" name="Engineering">
      <version name="Budget 2020" available="0" />
      <level id="8" name="Development">
         <version name="Budget 2020" available="0" />
      </level>
   </level>
</level>
</levels>

Esempio di ordine errato per elaborazione payload

Il payload XML riportato di seguito genera un errore poiché l'elaborazione dall'alto verso il basso considera l'elemento "Engineering" padre non disponibile ("

available=0")

per la versione "Budget 2020" dal blocco di codice precedente ed elabora la disponibilità del livello figlio "Sviluppo" come "1". Il livello figlio "Sviluppo" non può essere disponibile quando il livello padre "Ingegneria" non è disponibile.


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <level id="2" name="Engineering">
      <level id="8" name="Development">
         <version name="Budget 2020" available="1" />
      </level>
      <version name="Budget 2020" available="1" /><!-- Parent version availability change ignored due to placement order-->
   </level>
   <version name="Budget 2020" available="1" />
</level>
</levels>

Esempio di ordine valido per elaborazione payload

La riorganizzazione dell'ordine di posizionamento per la versione "Budget 2020" al di sotto del livello padre "Ingegneria" consente all'API di elaborare prima la disponibilità padre, consentendo a "Sviluppo" di avere il valore di disponibilità della versione "1" o "0".


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <version name="Budget 2020" available="1" />
   <level id="2" name="Engineering"><!-- Parent Version availability change processed due to correct placement order-->
      <version name="Budget 2020" available="1" />
      <level id="8" name="Development">
         <version name="Budget 2020" available="1" />
      </level>
   </level>
</level>
</levels>

Formato risposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<levels>
  <level id="1" name="HQ" currency="CAD" shortName="" eliminationLevel="1" eliminationTradingPartner="0" inWorkflow="0" status="">
    <level id="2" name="Engineering" currency="USD" shortName="Engr" eliminationLevel="0" eliminationTradingPartner="1" inWorkflow="0" status="updated">
      <level id="8" name="Development" currency="USD" shortName="Dev" eliminationLevel="0" eliminationTradingPartner="0" inWorkflow="0" status="updated" />
      <level id="9" name="QA" currency="INR" shortName="" eliminationLevel="0" eliminationTradingPartner="0" inWorkflow="0" status="updated" />
      <level id="10" name="Documentation" currency="PKR" shortName="Doc" eliminationLevel="0" eliminationTradingPartner="0" inWorkflow="1" propagateToDescendants="1" actualsStart="05/2013" actualsEnd="12/2018" status="updated">
        <version name="Budget 2011" available="1" status="" />
        <version name="Budget 2012" available="0" status="updated" />
        <version name="Budget 2013" available="1" status="" />
      </level>
    </level>
    <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" eliminationLevel="1" eliminationTradingPartner="0" inWorkflow="0" status="updated">
      <attribute name="Corporate Discount" value="Available" status="" />
      <attribute name="Transfers Restricted" value="Yes" status="" />
      <dimension name="Region" value="C-US" status="" />
    </level>
  </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 uno o più elementi di livello.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
retainExisting Order	N	0 updateLevels API deve aggiornare l'ordinamento in base al contenuto del payload XML. 1 updateLevels API deve mantenere l'ordinamento esistente.	1
displayNameEnabled Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	displayNameEnabled=1 indica che updateLevels deve rispettare le proprietà del nome visualizzato di code , displayNameType e description quando Abilita nome visualizzato è attivo per l'istanza.	1
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 updateLevels.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID sistema interno per il livello.	7
codice Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Il codice univoco del livello. Questa proprietà è disponibile solo quando Abilita nome visualizzato è su ON per l'istanza.	Sede centrale
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
publishCurrency Disponibile nell'API v24+	N	PublishCurrency imposta la valuta dell'azienda Workday quando si pubblica un piano finanziario. La valuta di pubblicazione viene caricata tramite il caricatore livelli di Planning nell'integrazione di Workday Adaptive Planning come attributo di valuta aggiuntivo per un livello. La valuta di pubblicazione indica una delle valute configurate per l'istanza, trovata nella chiamata exportActiveCurrencies e indicata nell'interfaccia utente di amministrazione del livello. Richiede Workday Power of One abilitato da Provisioning.	CAD
shortName	N	Abbreviazione del livello, se presente, immessa in Amministrazione livelli.	Dev
eliminationLevel	N	Indica se il livello è un livello di eliminazione. 0 per no, 1 per sì.	1
eliminationTradingPartner	N	description	1
inWorkflow	N	Indica se il livello si trova in un workflow. 0 per no, 1 per sì.	1
propagateToDescendants	N	Indica se le modifiche vengono propagate ai figli di questo livello. 0 per no, 1 per sì. Per ulteriori informazioni sul comportamento propagateToDescendants, consultare propagateToDescendants durante le richieste UpdateLevels.	1
actualsStart	N	Il codice orario definito in Amministrazione ore per l'inizio della versione importi effettivi per questo livello.	05/2013
actualsEnd	N	Il codice orario definito in Amministrazione ore per la fine della versione importi effettivi per questo livello.	12/2018
descrizione Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	La descrizione del livello. Questa proprietà è disponibile solo quando Abilita nome visualizzato è su ON per l'istanza.	Il reparto più in alto
stato	S	Lo stato del livello 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 l'input di livello non valido	Il livello UKregion2 è duplicato nel payload o esiste già nel sistema con ID 6.
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 attributo
Nome tag		attributo
Descrizione		Contenitore per un elemento attributo di livello.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Il nome dell'attributo di livello	Location
valore	S	Il valore dell'attributo di livello.	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. Per API v32 e versioni successive, valueCode è significativo solo quando: L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1	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 valueName è 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 dell'attributo 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.	Il livello UKregion2 è duplicato nel payload o esiste già nel sistema con ID 6.
Contenuto dell'elemento
(nessuno)

elemento versione
Nome tag		versione
Descrizione		Specifica la disponibilità della versione di un livello.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Il nome della versione, così come appare in Amministrazione versione.	Budget 2015
valore	S	Se 1 questo livello è disponibile in questa versione.	1
stato	S	Lo stato della versione successiva all'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
Contenuto dell'elemento
Uno o più elementi della versione per ogni valore dimensione.

elemento dimensione
Nome tag		dimensione
Descrizione		Rappresenta una singola dimensione personalizzata restituita nella risposta a una chiamata API updateLevels.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Il nome della dimensione, così come appare nei report e nei fogli.	Area geografica
valore	N	Il valore dimensione disponibile per questo livello.	C-USA
valueCode Disponibile solo nell'API v32+ per le istanze che abilitano il nome visualizzato.	S	Il codice valore dimensione per questa dimensione. Per API v32 e versioni successive, valueCode è significativo solo quando: L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1	CUS
valueName Disponibile solo nell'API v32+ per le istanze che abilitano il nome visualizzato.	N	Il nome di un nuovo valore dimensione creato automaticamente. Per API v32 e versioni successive, valueName è significativo solo quando: valueCode contiene un valore dimensione inesistente. L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1 valueName viene ignorato quando valueCode contiene un valore dimensione esistente.	C-USA
stato	N	Lo stato della versione successiva all'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
Contenuto dell'elemento
(nessuno)

Descrizioni dei messaggi di errore e di avviso

Tipo	Messaggio	Esempio/Descrizione
Errore	Si è verificato un errore di sistema, contattare l'assistenza per ulteriori informazioni.	Errore di sistema
Errore	Impossibile trovare il file content.xml.	Esiste già nell'API updateDimensions
Errore	I dati forniti non contengono tag di livello.	Nel carico utile manca l'etichetta di livello.
Errore	{0} non è riconosciuto come {1} definito.	Utilizzato quando il nome o il valore della versione è sconosciuto.
Errore	{0} non può essere vuoto.	Il nome della versione è vuoto.
Errore	Impossibile modificare la disponibilità della versione per gli importi effettivi.	Quando l'utente tenta di modificare la visibilità della versione per la versione importi effettivi.
Errore	La disponibilità della versione non può essere modificata per il livello radice {0}.	Quando l'utente tenta di modificare la visibilità della versione per il livello radice.
Errore	La visibilità della versione {0} al livello {1} non è compatibile con il padre di {1}.	Quando la visibilità della versione fornita per il livello non è compatibile con il livello padre.
Errore	Non si dispone dell'accesso per aggiornare uno o più livelli o versioni specificati nella richiesta.	Quando l'utente tenta di aggiornare le informazioni sul livello non accessibile.
Errore	{0} non è riconosciuto come {1} definito.	Utilizzato quando il nome o il valore della dimensione è sconosciuto.
Errore	{0} non può essere vuoto.	Il nome della dimensione è vuoto.
Errore	Impossibile utilizzare la dimensione elenco nel livello.	L'utente tenta di mappare un valore dimensione fissa per un livello.
Errore	La dimensione {0} è disabilitata per il livello.	La dimensione è disabilitata per questo livello.
Errore	Il valore dimensione {0} non è compatibile con il valore dimensione padre.	Quando la mappatura dimensione del livello fornita non è compatibile con il livello padre.
Errore	{0} non è riconosciuto come {1} definito.	Utilizzato quando il nome o il valore dell'attributo è sconosciuto.
Errore	Il valore attributo {0} non è compatibile con il valore attributo padre.	Quando il valore dell'attributo di livello specificato non è compatibile con il livello padre.
Errore	{0} non può essere vuoto.	Il nome attributo è vuoto.
Errore	Si è verificata un'eccezione durante l'elaborazione della richiesta API updateLevels.	Errore di sistema
Errore	L'ID {0} non esiste.	ID livello inesistente specificato nel payload della richiesta.
Errore	Un {0} non può avere lo stesso ID del padre.	Il livello figlio e il livello padre hanno lo stesso ID.
Errore	{0} non può essere figlio di {1}.	Un livello specifico non può essere figlio di un altro livello specifico.
Errore	ID livello radice mancante.	L'ID per il livello radice non è stato fornito.
Errore	L'ID livello radice {0} con nome livello {1} non può diventare un livello figlio.	Il livello radice non può diventare un livello figlio.
Errore	Impossibile modificare la valuta del livello radice.	La valuta non può essere modificata per il livello radice.
Errore	La valuta {0} non è valida.	Nome di valuta sconosciuto specificato nell'etichetta di livello.
Errore	Il livello {0} è duplicato per gli ID {1}.	Nome livello duplicato specificato.
Errore	Il livello {0} è duplicato nel payload {1} {2}.	Più nuovi livelli contengono lo stesso nome.
Errore	Impossibile modificare il workflow del livello radice.	Lo stato InWorkflow non può essere modificato per il livello radice.
Errore	L'assegnazione dell'attributo di livello {0} non è compatibile con il valore dell'attributo padre.	Il valore dell'attributo di livello fornito per il livello non è compatibile con il livello padre.
Errore	Il livello con ID {0} non esiste.	Non esiste alcun livello con l'ID specificato in Planning.
Errore	Non si dispone dell'accesso per aggiornare uno o più livelli o versioni specificati nella richiesta.	Autorizzazione utente mancante per un livello indicato nel payload.
Errore	La visibilità della versione del livello {0} non è compatibile con {0} padre {1}.	La visibilità della versione del livello non è compatibile con il livello padre.
Errore	Il livello {0} ha una disponibilità importi effettivi contenente più periodi di tempo rispetto al livello padre {1}.	L'intervallo degli importi effettivi del livello corrente è stato modificato. L'intervallo di importi effettivi modificato lo rende più piccolo di uno degli intervalli di importi effettivi discendenti.
Errore	Non è possibile disabilitare il workflow per il livello ({0}) se deleteWorkflowSilently, 0. Se si imposta deleteWorkFlowSilently, 1, tutte le attività del workflow associate a questo livello verranno eliminate.	Quando l'eliminazione automatica del workflow è disattivata, non è possibile disabilitare il workflow. Se l'opzione Eliminazione automatica flusso di lavoro è attivata, tutte le attività del flusso di lavoro per il livello vengono eliminate.
Errore	Impossibile aggiornare le date di inizio e fine importi effettivi per {0} poiché l'intervallo di date è inferiore alle date di inizio e di fine definite per la versione importi effettivi e deleteActualsSilently è impostato su false per impedire l'eliminazione degli importi effettivi per {1}.	L'utente tenta di ridurre l'intervallo degli importi effettivi senza che il flag deleteActuals sia impostato.
Errore	Impossibile abilitare il workflow per il livello {0} perché il workflow padre è disabilitato.	Impossibile abilitare il flusso di lavoro per il livello perché il flusso di lavoro padre è disabilitato.
Errore	TradingPartner o RemovalLevel non possono essere abilitati per il livello {0} perché il relativo padre ha tradingPartner abilitato.	Quando il partner commerciale è già abilitato per un padre, i suoi figli non possono avere il partner commerciale o il livello di eliminazione abilitati.
Errore	Un padre con ID {0} non esiste.	È stato fornito un ID inesistente per un livello padre.
Errore	Il nodo padre {0} sta diventando figlio del relativo nodo figlio diretto/indiretto corrente {1}.	È in corso la creazione di una relazione ciclica tra padre e figli.
Errore	Un livello non può essere padre di se stesso.	Un livello non può diventare padre di se stesso in un payload.
Errore	Un livello con ID {0} non esiste.	L'entità specificata non esiste in Planning.
Errore	Elimination e TradingPartner non possono essere veri contemporaneamente.	Un livello può essere un livello di eliminazione o un partner commerciale, ma non entrambi contemporaneamente.
Errore	È possibile modificare l'eliminazione solo a questo livello mentre il relativo padre ha TradingPartner disabilitato.	La modifica dell'eliminazione per un livello può essere eseguita solo quando il partner commerciale di tale livello è disabilitato.
Errore	Un sottolivello che si trova al di sotto di questo livello è un livello di eliminazione, quindi non può essere contrassegnato come partner commerciale.	Il livello corrente non può essere contrassegnato come partner commerciale perché un livello sottostante è un livello di eliminazione.
Errore	Impossibile abilitare workflow in questo livello se nel livello padre workflow è disabilitato.	Il flusso di lavoro del livello padre del livello è disabilitato.
Errore	{0} può essere abilitato solo insieme per un nodo e i relativi discendenti. Per modificarli, impostare propagateToDescendants=1.	Per ulteriori informazioni sul comportamento propagateToDescendants, consultare propagateToDescendants durante le richieste UpdateLevels.
Errore	Impossibile impostare il livello ''{0}'' come livello di eliminazione perché contiene dati in uno o più conti interaziendali.	Un livello non può diventare un livello di eliminazione se contiene dati in conti interaziendali.
Errore	actualsStart o actualsEnd non possono essere modificati per il livello radice {0}.	L'utente tenta di modificare l'intervallo degli importi effettivi per il livello radice.
Errore	Impossibile aggiungere figli a un livello collegato.	L'utente tenta di aggiungere un livello figlio per un livello collegato.
Errore	Il codice tempo {0} non esiste.	Il codice orario specificato non esiste.
Errore	La data di inizio degli importi effettivi {0} non può essere successiva alla data di fine degli importi effettivi {1}.	L'ora di inizio degli importi effettivi specificata è successiva all'ora di fine. L'ora di inizio degli importi effettivi deve essere precedente all'ora di fine.
Errore	Codice orario "{0}" non valido. I codici tempo impostati per actualsStart e actualsEnd devono corrispondere allo strato più basso tra quelli disponibili in Amministrazione tempi.	Il codice orario specificato non è al livello di strati più basso.
Errore	Codice orario "{0}" non valido. L'oggetto actualsStart {0} è precedente al valore padre actualsStart {1}.	L'ora di inizio actualsStart specificata è precedente all'ora di inizio degli importi effettivi del livello padre.
Errore	Codice orario "{0}" non valido. Il valore actualsEnd {0} è successivo a actualsEnd padre {1}.	L'ora di fine actualsEnd specificata va oltre l'ora di fine degli importi effettivi del livello padre.
Errore	Il valore actualsStart di {0} è precedente all'inizio della versione Actuals di {1}. Il valore actualsStart deve essere successivo a {1}.	L'ora di inizio importi effettivi specificata è precedente all'ora di inizio della versione importi effettivi.
Errore	Il valore actualsEnd di {0} è successivo alla fine della versione Actuals di {1}. Il valore actualsEnd deve essere precedente a {1}.	L'ora di fine importi effettivi specificata va oltre l'ora di fine della versione importi effettivi.
Errore	Valore "{0}" non valido "{1}". Il valore deve essere "1" o "0".	L'utente ha fornito un valore diverso da "0" o "1" come valore per una proprietà booleana.
Errore	{0} {1} non valido.	L'utente ha fornito un valore non valido.
Errore	{0} NON è consentito come nome.	Come nome del livello è stata specificata la parola riservata "this", che termina con "(+)" o "(-)".
Errore	L'ID "{0}" non esiste.	L'entità specificata non esiste in Planning.
Avviso	Il livello {0} non può essere spostato a un altro padre se la procedura procedeWithWarnings=0.	L'utente tenta di spostare il livello senza procedereWithWarning="1". procedeWithWarning="1" significa che la visibilità della versione, la mappatura degli attributi e i dati verranno adeguati in modo che corrispondano al nuovo livello padre.
Avviso	L'intervallo di disponibilità degli importi effettivi è stato ridotto per il livello {0}. I dati degli importi effettivi esclusi dall'intervallo sono stati eliminati.	L'intervallo di disponibilità degli importi effettivi è stato ridotto. I dati al di fuori dell'intervallo vengono eliminati.
Avviso	deleteWorkflowSilently è un flag globale. Deve trovarsi nel tag dei livelli.	L'eliminazione automatica del workflow è un flag globale. Appartiene al tag dei livelli, non a un altro tag.
Avviso	deleteActualsSilently è un flag globale. Deve trovarsi nel tag dei livelli.	L'eliminazione automatica degli importi effettivi è un flag globale. Appartiene al tag dei livelli, non a un altro tag.
Avviso	Impossibile modificare i livelli perché sono presenti modifiche non pubblicate.	In Planning sono presenti modifiche in attesa per la pubblicazione da parte degli amministratori.

Categoria	Modifica dei metadati
Descrizione	Aggiornare un insieme di livelli esistenti o creare nuovi livelli e le relative proprietà. È possibile aggiornare più livelli con più valori in un'unica chiamata. In caso di esito positivo, l'API restituisce i dettagli per i livelli aggiornati/creati. Se l'API non riesce, viene restituito un elenco completo degli errori e delle relative cause.
Autorizzazioni necessarie per richiamare	Modello e autorizzazioni a ogni livello
Parametri obbligatori su richiesta	Credenziali