exportDimensions

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-03-08

exportDimensions

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 tutte le dimensioni 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 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 completo di dimensioni personalizzate nel sistema, inclusi tutti i valori dei relativi membri. Questo metodo non restituisce nessuna delle dimensioni di sistema obbligatorie, ad esempio Versione, Tempo o Conti, ciascuna delle quali è disponibile nella propria chiamata API di metadati. I valori dei membri all'interno di una dimensione vengono restituiti sotto forma di struttura ad albero, con i membri padre che contengono i relativi figli.

È possibile trovare gli ID dimensione utilizzando un

exportDimensions

richiesta senza elemento dimensionIDs. Verrà visualizzato un elenco di tutte le dimensioni e dei relativi ID. Rivedere la risposta per trovare gli ID dimensione necessari. Gli ID dimensione non sono disponibili in

Adaptive Planning

interfaccia utente Web

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd"/>
<include versionName="Budget 2004" dimensionIDs="1,2,4,5" dimensionValues="true"/>
</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 sui "valori dimensione" devono essere inclusi o esclusi dalla risposta. Questo elemento è facoltativo: se non è presente, il valore predefinito è vuoto (o tutte le versioni) per versionName/versionID.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
versionName Aggiornato nell'API v18	N	Indica se la risposta deve escludere i valori dimensione non disponibili per il nome della versione richiesta. L'impostazione predefinita, se l'elemento o il relativo attributo non è presente, consiste nel restituire tutte le dimensioni e i valori. Se viene specificato un nome di versione, i valori dimensione non disponibili per la versione specificata non verranno restituiti. 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. <?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <dimensions> <dimension id="6" name="Department" shortName="" autoCreate=" 0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35"> <dimensionValue id="7" name="Engr" description="Engineering" shortName=""> <dimensionValue id=" 52" name="QA" description="Quality Assurance" shortName="" /> <dimensionValue id="53" name="Dev" description="Development" shortName="" /></dimensionValue> </dimension> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" seqNo="21"> <dimensionValue id="32" name ="Graduate" description="Graduate degree" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="197" value="Tech1" /> </attributes> </dimensionValue > <dimensionValue id="33" name="Masters" description="Masters degree" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="196" value="Management" /> </attribu tes> </dimensionValue> <dimensionValue id="34" name="Phd" description="Phd" shortName="" /> </dimension> </dimensions> </output> </response> Quando si specifica una versione, la chiamata avrà esito positivo solo se l'utente ha accesso alla versione.	Budget 2004
versionID Supportato nell'API v17 + Aggiornato nell'API v18	N	Uguale a versionName (sopra) tranne che accetta un numero ID versione come parametro. Indica se la risposta deve escludere i valori dimensione non disponibili per la versione richiesta. L'impostazione predefinita, se l'elemento o il relativo attributo non è presente, consiste nel restituire tutte le dimensioni e i valori. Se viene specificato un ID versione, i valori dimensione non disponibili per la versione specificata non verranno restituiti. 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
dimensionIDs Supportato nell'API v17 +	N	Un elenco di ID che verrà visualizzato nella risposta dell'API. Questo filtra una dimensione, ma non un valore dimensione.	"1,2,3,14"
attributi	N	Indica se la risposta deve includere gli attributi nella risposta per ogni dimensione fissa.	falso
inaccessibleValues Supportato nell'API v18 +	N	Indica se la risposta deve includere valori inaccessibili all'utente corrente. Il valore predefinito è false. Solo gli utenti con le autorizzazioni "Modellazione" o "Importa in tutti i livelli" possono impostare questa opzione su true.	1
dimensionValues Supportato nell'API v22+	N	Indica se la risposta deve includere i valori dimensione per ogni dimensione. Il valore predefinito è true. Se impostato su false, restituisce solo le dimensioni filtrate e non i valori dimensione. Se dimensionValues non fa parte dell'elemento include, restituisce tutte le dimensioni e i relativi valori. Se l'elemento di inclusione non fa parte della richiesta, verranno restituite tutte le dimensioni e i relativi valori.	falso
displayNameEnabled Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	displayNameEnabled=true indica che exportDimensions 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 exportDimensions deve continuare a seguire il contratto API precedente alla v30 anche quando l'opzione Abilita nome visualizzato è attiva per l'istanza. L'API exportDimensions ignora le proprietà del nome visualizzato code , displayNameType e description . Il valore predefinito per displayNameEnabled è "false".	true
Contenuto dell'elemento
(nessuno)

Formato risposta

<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <output>
       <dimensions>
           <dimension id="6" name="Department" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35">
               <dimensionValue id="7" name="Engr" description="Engineering" shortName=""/>
               <dimensionValue id="52" name="QA" description="Quality Assurance" shortName=""/>
               <dimensionValue id="53" name="Dev" description="Development" shortName=""/>
           </dimension>
           <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" seqNo="21">
               <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName="">
                   <attributes>
                       <attribute attributeId="21" name="Education Type" valueId="197" value="Tech1" />
                   </attributes>
               </dimensionValue>
               <dimensionValue id="33" name="Masters" description="Masters degree" shortName="">
                   <attributes>
                       <attribute attributeId="21" name="Education Type" valueId="196" value="Management" />
                   </attributes>
               </dimensionValue>
               <dimensionValue id="34" name="Phd" description="Phd" shortName=""/>
           </dimension>
           <dimension id="16" name="Geography" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0" seqNo="14" property1="Latitude" property2="Longitude">
               <dimensionValue id="521" name="United States" description="USA" shortName="">
                   <dimensionValue id="555" name="Alabama" description="1" shortName="">
                       <dimensionValue id="579" name="205" description="1" shortName="">
                           <dimensionValue id="4718" name="35004" description="1" shortName="">
                               <properties>
                                   <property name="Latitude" value="33.606" />
                                   <property name="Longitude" value="-86.502" />
                               </properties>
                           </dimensionValue>
                           <dimensionValue id="4719" name="35005" description="" shortName="">
                               <properties>
                                   <property name="Latitude" value="33.593" />
                                   <property name="Longitude" value="-86.96" />
                               </properties>
                           </dimensionValue>
                           <dimensionValue id="5073" name="35006" description="" shortName="" />
                           <dimensionValue id="5074" name="35007" description="" shortName="" />
                       </dimensionValue>
                   </dimensionValue>
                   <properties>
                       <property name="Latitude" value="37.0902" />
                       <property name="Longitude" value="95.7129" />
                   </properties>
               </dimensionValue>
           </dimension>
       </dimensions>
   </output>
</response>

Le dimensioni sono ordinate per nome.

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 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
codice Disponibile solo nell'API v39+.	N	Il nome della dimensione, così come appare nei report e nei fogli. Verrà visualizzato solo con API v39+	Customer
displayNameType Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	La rappresentazione interna del formato del nome visualizzato selezionato per i valori nelle pagine Amministrazione dimensioni. NOME CODICE NAME_CODE CODE_NAME	NOME
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
seqNo Aggiunto nell'API v17 ma riservato per un utilizzo futuro.
descrizione Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	La descrizione immessa in Amministrazione dimensioni.
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
codice Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Il codice per il valore membro della dimensione, se presente, immesso in Amministrazione dimensione.	Un'azienda
nome	S	L'etichetta del valore membro della dimensione, visualizzata nei report e utilizzata nelle formule.	Un'azienda
displayName Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Il nome visualizzato del valore membro, come derivato da displayNameType.	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. Un elemento delle proprietà facoltativo.

elemento delle proprietà
Nome tag		proprietà
Descrizione		Elemento facoltativo che contiene elementi proprietà.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Fino a cinque elementi proprietà.

elemento di proprietà
Nome tag		proprietà
Descrizione		Specifica una proprietà personalizzata. I valori degli elementi proprietà contengono solo caratteri numerici.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Il nome della proprietà.	Latitudine
valore	N	Il valore della proprietà.	33.6015
Contenuto dell'elemento
(nessuno)

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 Supportato nell'API v34 quando l'impostazione Nome visualizzato effettivo è attiva.	S	Il valore dell'attributo dimensione.	Tech1
valueCode Disponibile solo in API v32 e API v33 per le istanze che abilitano il nome visualizzato. Non supportato nell'API v34.	N	Il codice valore attributo per questo attributo. Per API v32 e API v33, valueCode è significativo solo quando: L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1	Tech1
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 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=1	Tech1
valueDisplayName Disponibile solo nell'API v32+ per le istanze che abilitano il nome visualizzato.	S	Per l'API v32 e successive, valueDisplayName è significativo solo quando: L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1	Tech1
Contenuto dell'elemento
(nessuno)

exportDimensionFamilies

exportGroups

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