updateDimensionValue

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: 2023-06-23

Non supportato nell'API v20 +

Categoria	Modifica dei metadati
Descrizione	Aggiornare un valore dimensione. In caso di esito positivo, l'API restituisce i dettagli per la dimensione e tutti i valori dimensione, incluso quello appena aggiornato.
Autorizzazioni necessarie per richiamare	Modello
Parametri obbligatori su richiesta	Credenziali

La richiesta di questo metodo contiene un tag delle credenziali per identificare e autorizzare l'utente chiamante. L'utente deve disporre dell'autorizzazione Modello per creare la dimensione.

Questo metodo restituisce un errore se sono presenti modifiche non pubblicate.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensionValue" callerName="fred">
    <credentials login="sampleuser@company.com" password="my_pwd" />
    <dimensionValue
       id="10"
       name="New Dimension Value">
       <attributes>
         <attribute attributeId="20" valueId="170" />
       </attributes>
   </dimensionValue>
</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)

dimensionValue
Nome tag		dimensionValue
Descrizione		Specifica un valore dimensione da aggiornare.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
dimensionId	N	ID della dimensione a cui appartiene il valore.	3
ID	S	ID del valore dimensione.	34
nome	S	Il nome del valore dimensione.	NewDimensionValue
shortName	N	Il nome abbreviato del valore dimensione.	NewDimensionValue- ShortName
parentId	N	ID del valore dimensione padre.	220
descrizione	N	La descrizione del valore dimensione.	Questo è un NewDimensionValue
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
valueID	S	L'ID univoco del valore dell'attributo dimensione generato dal sistema. Se questo valore è 0, l'attributo viene rimosso dal conto.	170
Contenuto dell'elemento
(nessuno)

Formato risposta

Questi sono esempi di risposte per l'aggiornamento riuscito e non riuscito di un valore dimensione.

Esempio di successo


<?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">
               <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">
               <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>
   </dimensions>
 </output>
</response>

Esempio di errore


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
    <messages>
        <message type="ERROR" key="invalid-attributevalueid" values="-50" dimensionValueId="10">Invalid attribute value id: "-50"</message>
    </messages>
</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
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
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
nome	S	L'etichetta del valore membro della dimensione, visualizzata nei report e utilizzata nelle formule.	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 Dimen - Administration	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.

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	L'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 attributo dimensione generato dal sistema.	170
valore	S	Il valore dell'attributo dimensione.	Tech1
Contenuto dell'elemento
(nessuno)

updateDimensions

updateLevel

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