exportVersions

Adaptive Planning

Documentazione di Workday Adaptive Planning (Workday 2025R2)
Integrazione
Gestione dell'integrazione dei dati
Documentazione API
Metodi di creazione, aggiornamento e lettura di metadati e dati

Ultimo aggiornamento: 2024-09-20

exportVersions

Aggiornato nell'API v40. (21 settembre 2024).

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

Categoria	Recupero dei metadati
Descrizione	Una volta verificato, il metodo restituisce un documento XML che descrive l'insieme di tutte le versioni definite nell'istanza che non sono nascoste all'utente richiedente.
Autorizzazioni necessarie per richiamare	Nessuno (devono essere credenziali valide per l'istanza)
Parametri obbligatori su richiesta	Credenziali

La richiesta di questo metodo contiene solo un tag di credenziali per identificare e autorizzare l'utente chiamante. Una volta verificato, il metodo restituisce un documento XML che descrive l'insieme di tutte le versioni definite nell'istanza che non sono nascoste all'utente richiedente.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportVersions" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</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 include
Nome tag		includere
Descrizione		Rappresenta un insieme di flag che indicano quali aspetti delle informazioni della versione devono essere inclusi o esclusi dalla risposta. Questo elemento è facoltativo: se non è presente, l'API restituirà tutte le informazioni sulla versione.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
rootActuals Non supportato in nessuna versione API a partire dalla 2019.3	N	Indica se la versione degli importi effettivi radice deve essere inclusa quando gli importi effettivi sono nascosti dal selettore di versione.	falso
scenari	N	Indica se includere nella risposta scenari ipotetici privati.	falso
currencyVersions Disponibile nell'API v40+	N	Indica se includere nella risposta le versioni in valuta per gli importi effettivi convertiti. È necessario contattare il contatto designato per l'assistenza per verificare se l'istanza è idonea per questa funzionalità.	falso
Contenuto dell'elemento
(nessuno)

Formato risposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<versions seqNo="32">
  <version id="1" name="Actuals" shortName="" type="ACTUALS" isVirtual="false" description="Total Actuals" isDefaultVersion="false"
           isLocked="false" hasAuditTrail="false" isImportable="0"
           startVer="2012" completedValuesThru="03/2012"
           startScroll="01/2012" endVer="2016" lockLeading="" >
    <version id="5" name="Adjusted Actuals" shortName="SV-13" type="ACTUALS" isVirtual="false" description="Actuals SubVersion" isDefaultVersion="false"
             isLocked="false" hasAuditTrail="false" isImportable="0" >
      <version id="6" name="Original Import" shortName="SSV-13" type="ACTUALS" isVirtual="false" description="Values Imported from the GL" isDefaultVersion="false"
               isLocked="false" hasAuditTrail="false" isImportable="1" />
      <version id="8" name="Manual Adjustments" shortName="SSV-14" type="ACTUALS" isVirtual="false" description="Actuals Sub-Version for Manual Adjustments" isDefaultVersion="false"
               isLocked="false" hasAuditTrail="true" isImportable="1" />
    </version>
    <version id="9" name="Eliminations" shortName="ELIM" type="ACTUALS" isVirtual="false" description="Eliminating entries" isDefaultVersion="false"
             isLocked="false" hasAuditTrail="false" isImportable="0" />
  </version>
  <version id="2" name="Budget 2013" shortName="" type="PLANNING" isVirtual="false" description="This is the budget for 2013 with a five-year span." isDefaultVersion="true"
           isLocked="false" hasAuditTrail="true" isImportable="1"
           leftScroll="2013" startPlan="01/2013" endPlan="2017" lockLeading="05/2013" />
    <version id="10" name="Worst Case" shortName="S13-A-WC" type="SCENARIO" isVirtual="false" description="Worst Case for Budget 2013" isDefaultVersion="false" isLocked="false"
             hasAuditTrail="false" isImportable="0" isPredictive="false" />
  </version>
 <version id="3" name="Budget 2014" shortName="B-14" type="PLANNING" isVirtual="false" description="This is the budget for 2014 with a five-year span." isDefaultVersion="false"
           isLocked="false" hasAuditTrail="false" isImportable="1"
           leftScroll="2014" startPlan="01/2014" endPlan="2018" lockLeading="" />
</versions>
</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 è 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 versioni
Nome tag		versioni
Descrizione		Contenitore per uno o più elementi della versione.
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 della versione.

elemento versione
Nome tag		versione
Descrizione		Rappresenta una singola versione restituita nella risposta a una chiamata API exportVersions.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID di sistema interno per la versione o la cartella. Tutti gli ID sono univoci in tutte le versioni, sottoversioni e cartelle.	2
nome	S	Il nome della versione o della cartella, così come appare in Amministrazione versione.	Budget 2015
shortName	N	Un nome abbreviato per la versione, se presente, immesso in Amministrazione versione	B2015
type Aggiornato nell'API v37.	S	Uno dei seguenti valori: ACTUALS = Versione importi effettivi standard o Sottoversione JOURNAL_ENTRY = Sottoversione voci effettivi registrazione a giornale PLANNING = Versione pianificata VERSION_FOLDER = Cartella SCENARIO = Uno scenario ipotetico personale	EFFETTIVI
isVirtual Disponibile nell'API v16+	S	true o false per indicare se si tratta di una versione virtuale	falso
descrizione	S	La descrizione della versione o della cartella, così come appare in Amministrazione versione.	Questo è il budget per il 2015 con un arco di tempo di cinque anni.
isDefaultVersion	S	Indica se la versione è la versione predefinita. True se la versione è la versione predefinita, altrimenti false.	true
isLocked	N	Indica se la versione è stata "bloccata a livello globale" (la casella di controllo Versione bloccata è selezionata). Se non è presente, la versione non è considerata bloccata. Sarà sempre "falso" per le versioni importi effettivi o per le cartelle.	true
hasAuditTrail	S	Indica se la versione ha l'audit trail abilitato.	true
enabledForWorkflow Disponibile nell'API v17+	N	Indica se la versione è abilitata per il workflow.	1
isImportable	N	Indica se l'utente che richiede questa API può importare i dati nella versione. 0 significa che la versione non può accettare importazioni e 1 significa che può farlo. Una versione è importabile se almeno una fascia oraria nella versione specificata è importabile per questo utente.	1
startVer	N	Il codice del periodo di tempo radice in cui inizia la versione. Equivalente all'inizio della versione nella pagina di amministrazione della versione. Questo attributo viene visualizzato solo per la versione radice importi effettivi. Questo attributo è obbligatorio per la versione radice importi effettivi.	2015
endVer	N	Il codice del periodo di tempo radice in cui termina la versione. Equivalente alla fine della versione nella pagina di amministrazione della versione. Questo attributo viene visualizzato solo per la versione radice importi effettivi. Questo attributo è obbligatorio per la versione radice importi effettivi.	2015
startScroll	N	Il codice del periodo di tempo foglia in cui inizia la pianificazione. Equivale al percorso di scorrimento iniziale nella pagina di amministrazione della versione. Questo attributo viene visualizzato solo per la versione radice importi effettivi. Questo attributo è obbligatorio per la versione radice importi effettivi.	01/2015
completedValuesThru	N	Il codice dell'ultimo periodo di tempo foglia per il quale gli importi effettivi radice contengono dati compilati. In un calendario standard, questo sarebbe un mese. Equivalente ai valori completati nella pagina di amministrazione della versione. Questo attributo viene visualizzato solo per la versione radice importi effettivi. Questo attributo è facoltativo per la versione degli importi effettivi radice.	03/2015
leftScroll	N	Il codice del periodo di tempo radice in cui inizia la versione. Equivalente al limite di scorrimento a sinistra nella pagina di amministrazione della versione. Questo attributo viene visualizzato solo per le versioni di pianificazione. Questo attributo è obbligatorio per le versioni di pianificazione.	2015
startPlan	N	Il codice del periodo di tempo foglia in cui inizia la pianificazione. Equivalente all'inizio del piano nella pagina di amministrazione della versione. Questo attributo viene visualizzato solo per le versioni di pianificazione ed è obbligatorio per le versioni di pianificazione.	02/2015
endPlan	N	Il codice del periodo di tempo radice in cui termina la versione. Equivalente alla fine del piano nella pagina di amministrazione della versione. Questo attributo viene visualizzato solo per le versioni di pianificazione. Questo attributo è obbligatorio per le versioni di pianificazione.	2015
lockLeading	N	Il codice del periodo di tempo foglia fino al quale i valori della versione sono bloccati. Equivalente a bloccare i mesi iniziali nella pagina di amministrazione della versione. Questo attributo viene visualizzato solo per la versione importi effettivi radice e per le versioni di pianificazione. Questo attributo è facoltativo per la versione importi effettivi radice e le versioni di pianificazione.	05/2015
isPredictive Disponibile nell'API v28 +	S	Indica se la versione è una versione predittiva.	falso
Contenuto dell'elemento
Un elemento di versione nidificato per ogni versione figlio diretto di questa versione.

exportUsers

importDimensionMapping

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