importDimensionMapping

Adaptive Planning

Novità (Workday 2025R2)

Supportato nell'API v19 +

Categoria	Inoltro dei metadati
Descrizione	L'API importDimensionMapping può essere utilizzata per importare i valori dimensione derivati.
Autorizzazioni necessarie per richiamare
Parametri obbligatori su richiesta	Credenziali

L'API importDimensionMapping può essere utilizzata per importare le condizioni di mappatura che determinano i valori delle dimensioni di mappatura da popolare automaticamente nelle righe del foglio modellato. Può essere utilizzato per creare, aggiornare ed eliminare le condizioni di mappatura. I valori dimensione derivati nelle righe del foglio modellato non supportano le versioni virtuali.

Formato richiesta

<?xml version='1.0' encoding='UTF-8'?>
<call method="importDimensionMapping" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_password"/>
  <version name="Budget 2017" id="7"/>
  <dimensions>
        <dimension id="345" name="Area">
            <mappingCriteria>
                <mappingCriterion id="121">
                    <mapTo dimensionValueId="877" dimensionValue="East"/>
                    <dimension name="Level" valueId="1" value="HQ"/>
                    <dimension name="State" valueId="15" value="MA"/>
                </mappingCriterion>
                <mappingCriterion id="122">
                    <mapTo dimensionValueId="876" dimensionValue="West"/>
                    <dimension name="Level" valueId="1" value="HQ"/>
                    <dimension name="State" id="5">
                        <dimensionValue id="900" code="CA"/>
                        <dimensionValue id="901" code="CO"/>
                    </dimension>
                </mappingCriterion>
            </mappingCriteria>
        </dimension>
    </dimensions>
</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 API exportInstances .	MYINSTANCE1
Contenuto dell'elemento
(nessuno)

elemento versione
Nome tag		versione
Descrizione		Specifica la versione per cui importare le mappature.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
Nome	Obbligatorio quando l'ID non è specificato.	Il nome della versione.	Budget 2017
ID	Obbligatorio quando il nome non è specificato.	ID versione	7
Contenuto dell'elemento
Contiene uno o più elementi di livello.

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	Obbligatorio quando l'ID non è specificato.	Il nome della dimensione per importare le mappature	Area
ID	Obbligatorio quando il nome non è specificato.	ID della dimensione per importare le mappature.	15
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
eliminare	N	Immettere "yes" per eliminare tutte le condizioni di mappatura in mappingCriterion. Un valore vuoto o qualsiasi valore diverso da "yes" viene ignorato e le condizioni di mappatura non vengono eliminate.	sì
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
dimensionValue	Obbligatorio quando dimensionValueId non è specificato.	Il nome del valore dimensione a cui questo criterio di mappatura è mappato.	Area
dimensionValueId	Obbligatorio quando dimensionValue non è specificato.	Il nome dell'ID valore dimensione a cui viene mappato il criterio di mappatura.	12
Contenuto dell'elemento
(nessuno)

Elemento dimensione
Nome tag		dimensione
Descrizione		Descrive una delle dimensioni utilizzate per derivare il valore della dimensione mapTo . È obbligatorio almeno un elemento dimensione per la dimensione "Livello" e un elemento dimensione per una dimensione personalizzata.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	Obbligatorio quando l'ID non è specificato.	Il nome della dimensione	Settore
ID	Obbligatorio quando il nome non è specificato.	ID della dimensione
valore	N	Il nome del valore dimensione. Obbligatorio a meno che non siano presenti dimensionValue	Vendita al dettaglio
valueId	N	ID del valore dimensione. O questo o il valore è obbligatorio, a meno che non siano presenti elementi dimensionValue
Contenuto dell'elemento
elementi dimensionValue

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 value .
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Il nome del valore dimensione	Vendita al dettaglio
codice In API v30+, utilizzare il codice anziché il nome.	Obbligatorio quando l'ID non è specificato.	Il codice del valore dimensione	Vendita al dettaglio
ID	Obbligatorio quando il codice non è specificato.	ID del valore dimensione	25
Contenuto dell'elemento
(nessuno)

Esempi:


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion>
            <mapTo dimensionValue="East"/>   
            <dimension name="Level" value="HQ"/> 
            <dimension name="State" value="MA"/> 
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Criterio di mappatura per mappare i valori dimensione HQ nella dimensione livello e MA nella dimensione Stato al valore della dimensione Est nella dimensione Area. Le righe in cui entrambi i valori corrispondono verranno aumentate con Est. Poiché l'attributo id è specificato, questo criterio di mappatura sostituirà un criterio di mappatura esistente con questo ID.


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion id="123">
            <mapTo dimensionValue="East"/>
            <dimension name="Level" value="HQ"/> 
            <dimension name="State" value="MA"/> 
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Criterio di mappatura per mappare i valori dimensione HQ nella dimensione livello e CA o CO nella dimensione Stato al valore della dimensione Est nella dimensione Area. Le righe in cui entrambi i valori corrispondono verranno aumentate con Est.


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion>
            <mapTo dimensionValue="East"/>   
            <dimension name="Level" value="HQ"/> 
            <dimension name="State">         
                <dimensionValue code="CA"/>  
                <dimensionValue code="CO"/>
            </dimension>
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Formato risposta

Risposta positiva


<?xml version="1.0" encoding="UTF-8"?>
<response success="true"/>

Risposta in caso di errore


<?xml version="1.0" encoding="UTF-8"?>
<response success="false">
    <messages>
        <message>There are duplicate mapping conditions. Make all mappingCriterion conditions unique</message>
    </messages>
</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.

Messaggi Elemento
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