exportLevels

Adaptive Planning

Novità (Workday 2025R2)

exportLevels

Questa API supporta solo l'utente Concetto: Regole di accesso nell'API v22 e versioni successive.

Categoria	Recupero dei metadati
Descrizione	Restituisce i metadati per l'elenco completo di tutti i livelli dell'organizzazione nel sistema.
Autorizzazioni necessarie per richiamare	Nessuno (devono essere credenziali valide per l'istanza)
Parametri obbligatori su richiesta	Credenziali

La richiesta di questo metodo contiene un tag delle credenziali per identificare e autorizzare l'utente chiamante e un tag di inclusione facoltativo per indicare quali livelli includere nella risposta. Una volta verificate le credenziali dell'utente, il metodo restituisce un documento XML che descrive l'insieme di livelli dell'organizzazione nel sistema corrispondente alla richiesta. I livelli vengono restituiti ad albero nidificato, con un tag di livello che ne racchiude un altro se il livello rappresentato dal tag di inclusione è il padre del livello racchiuso.

Filtraggio livelli

Il filtro per livello/versione non disponibile si applica sempre quando viene specificata una versione.

Se un utente specifica un foglio assegnato a un utente nella richiesta:

I livelli vengono restituiti se l'utente ha accesso al foglio. Per gli utenti amministratori, se

inaccessibleValues

è vero, i livelli verranno restituiti per il foglio.

Tutti i livelli del foglio vengono restituiti se l'utente ha accesso al foglio, indipendentemente dall'accesso al livello dell'utente.

Se un utente specifica un foglio assegnato a un livello nella richiesta:

Il filtro per l'accesso degli utenti si applica quando richiesto da

inaccessibleValues,

che determina se la risposta deve includere livelli a cui l'utente non ha accesso.

Quindi viene applicato il filtro dei fogli.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportLevels" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_pwd"/>
   <include versionID="3" inaccessibleValues="false"/>
   <sheet id="3" />
</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é l'API chiamata per ottenere l'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 include
Nome tag		includere
Descrizione		Rappresenta un insieme di flag che indicano quali aspetti delle informazioni dei livelli devono essere inclusi o esclusi dalla risposta. Questo elemento è facoltativo: se non è presente, il valore predefinito è false per inaccessibleValues e vuoto (o tutte le versioni) per versionName/versionID.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
gruppi Disponibile nell'API v23+	N	Indica se gli elementi del livello nella risposta includono un attributo groupIds. Se è vero, il valore groupIds nella risposta contiene un elenco separato da virgole di tutti i gruppi in cui si trova il livello. Se l'attributo non è presente o se il suo valore è diverso da vero o falso, viene utilizzato il valore predefinito false.	true
inaccessibleValues Disponibile nell'API v18+.	N	Se la risposta deve includere livelli a cui l'utente non ha accesso. Vero o falso. Il valore predefinito, se l'elemento o il relativo attributo non è presente, è false. Se è impostata su false, la risposta includerà solo i livelli a cui l'utente ha accesso ai dati, direttamente o implicitamente. Si noti che ciò significa che la risposta potrebbe non essere più un singolo albero di livelli con radice, ma una serie di sottostrutture disgiunte dell'albero generale. Solo gli utenti con le autorizzazioni "Struttura organizzazione: tutti i livelli" o "Importa in tutti i livelli" possono impostare questa opzione su true.	falso
inaccessibleLevels Disponibile nell'API v17 e versioni precedenti. Non disponibile nell'API v18+.	N	Vero o falso. Se la risposta deve includere livelli a cui l'utente non ha accesso. Il valore predefinito, se l'elemento o il relativo attributo non è presente, è vero. Se è impostata su false, la risposta includerà solo i livelli a cui l'utente ha accesso ai dati, direttamente o implicitamente. Si noti che ciò significa che la risposta potrebbe non essere più un singolo albero di livelli con radice, ma una serie di sottostrutture disgiunte dell'albero generale.	true
versionName Aggiornato nell'API v18	N	Indica se la risposta deve includere solo i livelli disponibili per il nome della versione richiesta. L'impostazione predefinita, se l'elemento o il relativo attributo non è presente, restituisce tutti i livelli. Se viene specificato un nome di versione, verranno restituiti solo i livelli disponibili per la versione specificata. Se presente, verrà applicato anche l'attributo inaccessibleValues e verranno restituiti solo i livelli disponibili nella versione specificata e accessibili dall'utente richiedente. Se il nome della versione specificato non viene trovato, questa API restituisce un errore. Se vengono passati entrambi gli attributi versionName e versionID, il versionID viene ignorato. Quando si specifica una versione, la chiamata avrà esito positivo solo se l'utente ha accesso alla versione.	Ingegneria
versionID Aggiornato nell'API v18	N	Uguale a versionName (sopra) tranne che accetta un numero ID versione come parametro. Indica se la risposta deve includere solo i livelli disponibili per la versione richiesta. L'impostazione predefinita, se l'elemento o il relativo attributo non è presente, restituisce tutti i livelli. Se viene specificato un ID versione, verranno restituiti solo i livelli disponibili per la versione specificata. Se presente, verrà applicato anche l'attributo inaccessibleValues e verranno restituiti solo i livelli disponibili nella versione specificata e accessibili dall'utente richiedente. Se l'ID versione specificato non viene trovato, questa API restituisce un errore. Se vengono passati entrambi gli attributi versionName e versionID, il versionID viene ignorato. Quando si specifica una versione, la chiamata avrà esito positivo solo se l'utente ha accesso alla versione.	3
non categorizzato Supportato nell'API v22+ quando l'istanza utilizza le regole di accesso per motivi di sicurezza.	N	Indica se includere i livelli fantasma nella risposta. Il valore predefinito è false. I livelli fantasma vengono inclusi nella risposta solo quando l'utente può accedervi.	falso
displayNameEnabled Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	displayNameEnabled=true indica che exportLevels deve rispettare le proprietà del nome visualizzato di code , displayNameType e description quando Abilita nome visualizzato è attivo per l'istanza. displayNameEnabled=false indica che l'API exportLevels deve continuare a seguire il contratto API precedente alla v30 anche quando l'opzione Abilita nome visualizzato è attiva per l'istanza. L'API exportLevels ignora le proprietà del nome visualizzato code , displayNameType e description . Il valore predefinito per displayNameEnabled è "false".	falso
Contenuto dell'elemento
(nessuno)

elemento del foglio
Nome tag		foglio
Descrizione		Rappresenta un foglio, in cui nella risposta verranno inclusi solo i livelli disponibili per quel foglio. Questo elemento è facoltativo: se non è presente, l'API restituirà informazioni sul livello indipendentemente da un determinato foglio. Se il foglio specificato è un foglio assegnato a un livello, questo filtro viene applicato alla versione e al filtro di accesso degli utenti, se presente. Se il foglio specificato è un foglio assegnato a un utente a cui l'utente corrente ha accesso, verranno restituiti tutti i livelli di quel foglio dopo qualsiasi filtro delle versioni.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID di sistema interno per il foglio.	234
Contenuto dell'elemento
(nessuno)

Formato risposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
 <levels seqNo="21">
   <level id="1" name="Corporate Rollup" currency="USD" isImportable="1" workflowStatus="I">
     <level id="2" name="Engineering" currency="USD" shortName="Engr" isImportable="1" workflowStatus="I">
       <level id="7" name="Development" currency="USD" shortName="Dev" isImportable="1" workflowStatus="I"/>
       <level id="8" name="QA" currency="INR" isImportable="0" workflowStatus="L"/>
       <level id="9" name="Documentation" currency="PKR" shortName="Doc" isImportable="1" workflowStatus=R"/>
     </level>
     <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" isImportable="0" workflowStatus="A">
       <attributes>
         <attribute name="Corporate Discount" value="Available" attributeId="20" valueId="188" />
         <attribute name="Transfers Restricted" value="Yes" attributeId="21" valueId="194" />
       </attributes>
     </level>
   </level>
 </levels>
</output>
</response>

elemento di risposta
Nome tag		risposta
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	Vero o falso, a indicare se la chiamata API è riuscita o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.	true
obsoleto	N	Se presente nel tag di risposta e impostato su true, questo attributo indica che la versione del metodo o dell'API richiamata è diventata obsoleta ed è ufficialmente obsoleta. Sebbene continui a funzionare in questo momento, potrebbe cessare di funzionare in breve tempo. In genere, questo attributo non è presente.	falso
Contenuto dell'elemento
Un singolo elemento di messaggi facoltativo ed esattamente un elemento di output obbligatorio.

elemento di output
Nome tag	output
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Un singolo elemento di conti. 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
seqNo Aggiunto nell'API v17 ma riservato per un utilizzo futuro.
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
codice Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Il codice del livello.	Sviluppo
nome	S	Il nome del livello, come appare nei report e nei fogli.	Sviluppo
displayName Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Il nome visualizzato del livello derivato da displayNameType.	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	Il codice valuta per la valuta assegnata alla pubblicazione da questo livello. Questa proprietà è applicabile solo quando è stato abilitato Power of one per l'istanza. La valuta sarà una delle valute configurate per l'istanza, trovata nella chiamata exportActiveCurrencies.	USD
shortName	N	Abbreviazione del livello, se presente, immessa in Amministrazione livelli.	Dev
disponibileStart	N	Il periodo di tempo di inizio per la disponibilità del livello per la versione importi effettivi, applicabile solo quando nella richiesta è specificata la versione ACTUALS. Il valore può essere un codice periodo di tempo, ad esempio "01/2012" o il valore speciale "START" che indica l'inizio della versione.	01/2013
disponibileEnd	N	Il periodo di tempo finale per la disponibilità del livello per la versione importi effettivi, applicabile solo quando nella richiesta è specificata la versione ACTUALS. Il valore può essere un codice periodo di tempo, ad esempio "12/2013", 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	1 se il livello è collegato; in caso contrario, 0.	1
isElimination	S	1 se il livello è un livello di eliminazione; in caso contrario, 0.	0
hasChildren	N	Indica se il livello ha figli. "false" per no, "true" per sì. Questo attributo è impostato per qualsiasi livello con figli, indipendentemente dal fatto che i figli siano accessibili o meno. Se un livello ha figli ma i figli non sono accessibili, l'attributo hasChildren è comunque impostato su true.	true
descrizione Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	La descrizione del livello, se presente, immessa in Amministrazione livelli.
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 Supportato nell'API v34 quando l'impostazione Nome visualizzato effettivo è attiva.	S	Il valore dell'attributo di livello associato al livello.	Sì
valueCode Disponibile solo in API v32 e API v33 per le istanze che abilitano il nome visualizzato. Non supportato nell'API v34 quando l'impostazione Nome visualizzato effettivo è attiva.	N	Il codice valore attributo per questo attributo. Per le API v32 e v33, valueCode è significativo solo quando: L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1	S
valueName Disponibile solo in API v32 e API v33 per le istanze che abilitano il nome visualizzato. Non supportato nell'API v34 quando l'impostazione Nome visualizzato effettivo è attiva.	N	Il nome del valore attributo per questo attributo. Per API v32 e API v33, valueName è significativo solo quando: L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1value	Sì
valueDisplayName Disponibile solo nell'API v32+ per le istanze che abilitano il nome visualizzato.	S	Il nome visualizzato del valore dell'attributo. Per l'API v32 e successive, valueDisplayName è significativo solo quando: L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1value	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)

Questo contenuto è stato utile?

Che cosa richiede la nostra attenzione? Preciso Risponde alla mia domanda Facile da trovare Di facile comprensione Utile per completare l'attività Completo di dettagli

Che cosa richiede la nostra attenzione? Impreciso Non risponde alla mia domanda Non facile da trovare Di non facile comprensione Non utile per completare l'attività Incompleto o senza dettagli

Indica l'attività che stai eseguendo. Quali informazioni aggiuntive potrebbero migliorare questo contenuto? Hai altri dettagli da condividere?

Nome completo

E-mail

Workday utilizzerà il vostro nome e la vostra e-mail per fornirvi le risposte relative al vostro feedback. I vostri dati saranno trattati in conformità con la nostra Informativa sulla privacy.

Grazie per il feedback