exportDimensionMapping

Adaptive Planning

Novità (Workday 2025R2)

Supportato nell'API v19 +

Categoria	Recupero dei metadati
Descrizione	Esporta i criteri di mappatura delle dimensioni derivate per una o più dimensioni in una determinata versione.
Autorizzazioni necessarie per richiamare
Parametri obbligatori su richiesta	Credenziali

Questa API viene utilizzata per recuperare un elenco di criteri di mappatura per una o più dimensioni derivate. Per ogni dimensione nella richiesta verranno recuperati i valori mapTo e le condizioni dei valori dimensione.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportDimensionMapping" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_password"/>
  <dimensions>
    <dimension name="Area">                       
    </dimension>
  </dimensions>
  <version name = "Budget 2017"/>
  <filters>
    <keyword value="Alameda" />
    <levels>
      <level code="HQ" includeDescendants="true" />
    </levels>
    <dimensionValues>
      <dimensionValue dimName="Geography" code="California" />
      <dimensionValue dimId="34" uncategorized="true" />
      <dimensionValue dimName="Region" code="Bay Area" uncategorized="true" />
      <dimensionValue dimId="19" id="78" />
    </dimensionValues>
    <attributes>
      <attribute id="1" uncategorized="true"/>
      <attribute name="attributeName1" value="attributeValue1"/>
      <attribute id="3" valueId="31" uncategorized="true"/>
    </attributes>
  </filters>
</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 periodi di tempo 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 il metodo dell'API xrif.	MYINSTANCE1
Contenuto dell'elemento
(nessuno)

elemento versione
Nome tag		versione
Descrizione		Specifica la versione da cui recuperare le righe modellate.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
Nome	S	Il nome della versione.	Budget 2017
Contenuto dell'elemento
(nessuno)

elemento dimensioni
Nome tag		dimensioni
Descrizione		Contenitore per un elenco di elementi <dimension>.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
elementi dimensione

Elemento dimensione
Nome tag		dimensione
Descrizione		Descrive una dimensione per la quale si desidera importare le mappature.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Il nome della dimensione per cui importare le mappature	Area
Contenuto dell'elemento
A mappingCriteria element.

Filtri Elemento
Nome tag		filtri:
Descrizione		Contiene le specifiche per i filtri che determinano quali dati della versione e delle dimensioni richieste vengono recuperati dall'API. Questo elemento specifica la parola chiave, i livelli e i valori dimensione contenuti nelle voci dei criteri di mappatura corrispondenti.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Un singolo elemento parola chiave facoltativo, un singolo elemento facoltativo livelli e un singolo elemento facoltativo dimensionValues .

Elemento livelli
Nome tag		livelli
Descrizione		Contenitore per elementi di livello zero o uno.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Zero o un elemento di livello

Elemento di livello
Nome tag		level
Descrizione		Specifica un livello di organizzazione per l'esportazione dei dati in questa chiamata API.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Il nome del livello da esportare. Questo nome è specificato in Amministrazione organizzazione.	Sviluppo
codice In API v30+, utilizzare il codice anziché il nome.	Obbligatorio quando l'ID non è specificato.	Il codice del livello da esportare. Questo codice è specificato in Amministrazione organizzazione.	Sviluppo
ID	Obbligatorio quando il codice non è specificato.	Il numero ID sistema interno del livello da esportare.	8
includeDiscendenti	S	Indica se l'esportazione deve includere o meno tutti i discendenti del livello specificato. Se impostato su true, verranno esportati anche tutti i figli di questo livello, così come i loro figli e così via. Se impostato su false, questo livello verrà esportato da solo.	Vero
Contenuto dell'elemento
(nessuno)

elemento dimensionValues
Nome tag		dimensionValues
Descrizione		Contenitore per zero o più elementi dimensionValue .
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Zero o più elementi dimensionValue .

elemento dimensionValue
Nome tag		dimensionValue
Descrizione		Indica che i dati esportati devono contenere solo le voci dei criteri di mappatura che contengono il valore dimensionValue corrispondente. Se più di un elemento dimensionValue si trova all'interno dell'elemento dimensionValues, le voci dei criteri di mappatura esportate devono contenere tutte le dimensioni/valori specificati. Ad esempio, se una richiesta specifica i valori dimensione Area=Est e Prodotto=Prodotto_A, per poter essere esportata, il criterio di mappatura deve avere Area contenente Est e Prodotto contiene Prodotto_A. Si noti inoltre che ogni dimensionValue all'interno dell'elemento dimensionValues deve appartenere a una dimensione diversa. Ad esempio, una richiesta con valori dimensione Area=Est e Area geografica=Ovest non verrà accettata. Nel caso in cui le dimensioni del filtro di input non appartengano a nessuna delle dimensioni richieste, verranno ignorate.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
dimName	obbligatorio quando non è specificato uncategorizedOfDimension	Il nome della dimensione a cui appartiene il valore dimensione (consultare l'attributo name di seguito).	Area geografica
nome	N	Il nome del valore dimensione da esportare.	Stati Uniti occidentali
codice Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	Obbligatorio quando l'ID non è specificato	Il codice del valore dimensione da esportare.	Stati Uniti occidentali
non categorizzato	N	Se è impostato su true, i dati esportati conterranno il criterio di mappatura con solo il valore dimensione corrispondente e non i valori dei relativi valori discendenti (se presenti). Non ha effetto sui valori dimensione senza figli. Se non specificato, il valore predefinito è false.	true
dimId	obbligatorio quando dimName non è specificato.	Il numero ID di sistema interno della dimensione a cui appartiene il valore dimensione (vedere l'attributo name sopra).	15
uncategorizedOfDimension	N	Specificare uncategorizedOfDimension al posto degli attributi dimName/uncategorized . Se specificato, il valore dell'attributo deve essere un numero ID di sistema interno di una dimensione (non un valore dimensione) e il filtro specifica che i dati devono essere completamente non categorizzati in questa dimensione per poter corrispondere al filtro. Gli attributi non categorizzati verranno ignorati e ritenuti veri. Ignorato se dimName è specificato.	15
ID	Obbligatorio quando il codice non è specificato	Specificare l'ID al posto degli attributi del nome . Il numero ID sistema interno del valore dimensione da esportare. Deve essere specificato al posto degli attributi name per specificare il valore dimensione. Per determinare gli ID interni, consultare l'API exportDimensions . Ignorato se si specifica il nome.	14
Contenuto dell'elemento
(nessuno)

Formato risposta


<response success="true">
 <output>
        <mappings>
            <version name="Budget 2017"/>
            <dimensions>
                <dimension name="Area">
                    <mappingCriteria>
                        <mappingCriterion id="121">
                            <mapTo dimensionValue="East"/>
                            <dimension name="Level" value="HQ"/>
                            <dimension name="State" value="MA"/>
                        </mappingCriterion>
                        <mappingCriterion id="122">
                            <mapTo dimensionValue="West"/>
                            <dimension name="Level" value="HQ"/>
                            <dimension name="State">
                                <dimensionValue name="CO"/>
                                <dimensionValue name="CA"/>
                            </dimension>
                        </mappingCriterion>
                    </mappingCriteria>
                </dimension>
            <dimensions/>
        </mappings>
    </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
Contenuto dell'elemento
Un singolo elemento di messaggi facoltativo ed esattamente un elemento di output obbligatorio.

Dimensions Elemento
Nome tag		dimensioni
Descrizione		Contenitore per un elenco di elementi <dimension>.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
elementi dimensione

Elemento dimensione
Nome tag		dimensione
Descrizione		Descrive una dimensione per la quale si desidera importare le mappature.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Il nome della dimensione per cui importare le mappature	Area
Contenuto dell'elemento
A mappingCriteria element.

mappingCriteria Element
Nome tag		mappingCriteria
Descrizione Descrizione		Contenitore per un elenco di elementi <mappingCriterion>
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	N	Se viene fornito un ID, verrà aggiornato un criterio di mappatura esistente con tale ID. Se non viene specificato alcun ID, alla dimensione viene aggiunto un nuovo criterio di mappatura.	12
Contenuto dell'elemento
mappingCriterion per ogni valore dimensione per la dimensione derivata.

mappingCriterion Element
Nome tag		mappingCriterion
Descrizione Descrizione		Descrive le singole dimensioni e i valori dimensione che determinano la mappatura di un valore dimensione. Deve essere seguito da un gruppo di tag mapTo , dimension e dimensionValue .
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	N	Se viene fornito un ID, verrà aggiornato un criterio di mappatura esistente con tale ID. Se non viene specificato alcun ID, alla dimensione viene aggiunto un nuovo criterio di mappatura.	12
Contenuto dell'elemento
Contiene un elemento mapTo e fino a sei elementi dimensione.

mapTo Element
Nome tag		mapTo
Descrizione		Specifica il valore dimensione derivato in base ai criteri di mappatura.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
dimensionValueId	S	ID del valore dimensione a cui viene mappato questo criterio di mappatura.	11
dimensionValue	S	Il nome del valore dimensione a cui questo criterio di mappatura è mappato.	California
dimensionValueCode	S	Il codice del valore dimensione a cui viene mappato questo criterio di mappatura.	CA
dimensionValueDisplayName	S	Il nome visualizzato del valore dimensione a cui viene mappato questo criterio di mappatura.	California
Contenuto dell'elemento
(nessuno)

Elemento dimensione
Nome tag		dimensione
Descrizione		Descrive una delle dimensioni utilizzate per derivare il valore della dimensione mapTo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Il nome della dimensione	Area
ValueId	N	ID del valore dimensione. Obbligatorio a meno che non siano presenti elementi dimensionValue.	282
valore	N	Il nome del valore dimensione. Obbligatorio a meno che non siano presenti elementi dimensionValue	West
valueCode	N	Il codice del valore dimensione. Obbligatorio a meno che non siano presenti elementi dimensionValue.	Noi
valueDisplayName	N	Il nome visualizzato del valore dimensione. Obbligatorio a meno che non siano presenti elementi dimensionValue.	West
Contenuto dell'elemento
(nessuno)

elemento dimensionValue
Nome tag		dimensionValue
Descrizione		(Facoltativo) Se è necessario elencare più di un valore dimensione per un'etichetta dimensione , è possibile utilizzare una serie di tag dimensionValue al posto dell'attributo name .
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	ID del valore dimensione	10
nome	S	Il nome del valore dimensione	Colorado
codice	S	Il codice del valore dimensione	CO
displayName	S	Il nome visualizzato del valore dimensione	Colorado
Contenuto dell'elemento
(nessuno)

elemento messaggi
Nome tag	messaggi
Descrizione	Contenitore per uno o più elementi del messaggio.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o più elementi del messaggio.

elemento messaggio
Nome tag		messaggio
Descrizione		Rappresenta un messaggio inviato dal sistema al chiamante. I messaggi vengono utilizzati per i messaggi di errore quando le richieste non hanno esito positivo, per i messaggi di avviso quando le richieste hanno esito positivo e per i messaggi di conferma in caso di esito positivo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
chiave	N	Quando viene assegnata, una chiave è un modo per identificare un particolare messaggio o tipo di messaggio, utile ai fini della registrazione automatica degli errori e del ripristino nei programmi client. Le chiavi non cambiano nelle diverse impostazioni internazionali delle richieste, anche quando cambia la lingua del messaggio. Inoltre, è improbabile che le chiavi cambino in futuro a causa di rettifiche di testo o modifiche della terminologia.	invalid-attributevalueid
Contenuto dell'elemento
Il testo del messaggio. Questo testo è nella lingua delle impostazioni internazionali specificate nella richiesta (supponendo che le impostazioni internazionali siano supportate). Il testo può anche contenere informazioni variabili come il numero di righe elaborate o la colonna o il valore specifico che ha causato un errore.

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