exportAttributes

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

exportAttributes

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 tutti gli attributi 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 tutti gli attributi personalizzati (escluso l'attributo di sistema del partner commerciale per le istanze di consolidamento), inclusi tutti i valori dei membri. I valori dei membri all'interno di un attributo vengono restituiti sotto forma di struttura ad albero, con i membri padre che contengono i relativi figli.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportAttributes" 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é 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)

elemento include Supportato nell'API v17 +
Nome tag		includere
Descrizione		Rappresenta un insieme di flag che indicano quali aspetti delle informazioni sui "valori attributo" devono essere inclusi o esclusi dalla risposta. Questo elemento è facoltativo: se non è presente, tutti gli attributi verranno visualizzati nella risposta.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
attributeIDs Supportato nell'API v17 +	N	Un elenco di ID che verrà visualizzato nella risposta dell'API. Funziona come un filtro.	"1,2,3,14"
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.	falso
non categorizzato Supportato nell'API v22+ quando l'istanza utilizza le regole di accesso per motivi di sicurezza.	N	Indica se la risposta deve includere i nodi fantasma nella risposta per ogni attributo. Il valore predefinito è false. I nodi fantasma vengono inclusi nella risposta solo quando l'utente può accedervi.	falso
displayNameEnabled Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	displayNameEnabled=true indica che exportAttributes deve rispettare le proprietà del nome visualizzato quando l'opzione Abilita nome visualizzato è attiva per l'istanza. displayNameEnabled=false indica che l'API exportAttributes deve continuare a seguire il contratto API precedente alla v30 anche quando l'opzione Abilita nome visualizzato è attiva per l'istanza. L'API exportAttributes ignora le proprietà del nome visualizzato. Il valore predefinito per displayNameEnabled è "false".	true
Contenuto dell'elemento
(nessuno)

Formato risposta


<?xml version='1.0' encoding='UTF-8'?>
  <response success="true">
   <output>
     <attributes>
       <attribute id="13" name="AP Eligible" type="account" seqNo="21">
         <attributeValue id="118" name="No" />
         <attributeValue id="117" name="Yes">
           <attributeValue id="136" name="Full" />
           <attributeValue id="135" name="Partial" />
         </attributeValue>
       </attribute>
       <attribute id="11" name="Product Line" type="account" seqNo="3">
         <attributeValue id="34" name="A" />
         <attributeValue id="35" name="B" />
       </attribute>
       <attribute id="9" name="Corporate Discount" type="level" seqNo="11">
         <attributeValue id="56" name="Available" />
         <attributeValue id="54" name="Not Applicable" />
         <attributeValue id="57" name="Not Available" />
         <attributeValue id="55" name="TBD" />
       </attribute>
       <attribute id="10" name="Tax Code" type="level" seqNo="33">
         <attributeValue id="146" name="TT-PYT" />
         <attributeValue id="145" name="TT-TRE" />
       </attribute>
       <attribute id="16" name="Industry" type="dimension" dimension-id="15" seqNo="43">
         <attributeValue id="335" name="Apparel">
            <attributeValue id="354" name="Mens Apparel" />
            <attributeValue id="355" name="Shoes" />
            <attributeValue id="356" name="Womens Apparel" />
         </attributeValue>
       </attribute>
     </attributes>
   </output>
</response>

elemento di risposta
Nome tag		risposta
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	"True" o "false", che indica se la chiamata API è stata eseguita correttamente 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
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Un singolo elemento attributi obbligatori. Questo wrapper di output è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita.

elemento attributi
Nome tag		attributi
Descrizione		Contenitore per zero o più elementi attributo. Gli attributi verranno ordinati in modo che siano nel seguente ordine in base al tipo: "conto", "livello" e "dimensione". Gli attributi con lo stesso tipo verranno ordinati per nome.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Zero o più elementi attributo.

elemento attributo
Nome tag		attributo
Descrizione		Rappresenta un singolo attributo restituito nella risposta a una chiamata API exportAttributes.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID sistema interno per l'attributo.	16
nome	S	Il nome dell'attributo visualizzato nella pagina di amministrazione degli attributi.	Settore
displayNameType Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.		La rappresentazione interna del formato del nome visualizzato selezionato per i valori nelle pagine Amministrazione attributi. NOME CODICE NAME_CODE CODE_NAME	NOME
type	S	Il tipo dell'attributo. Sarà "conto" se l'attributo è per un conto, "livello" se l'attributo è per un livello o "dimensione" se l'attributo è per una dimensione.	dimensione
autoCreate Supportato nell'API v20+	S	1 se l'attributo selezionato ha impostato il campo "L'importazione di livello/conto/dimensione crea automaticamente valori attributo", 0 in caso contrario.	0
keepSorted Supportato nell'API v20+	S	"1" indica che i valori per questo attributo sono sempre ordinati in ordine alfabetico. "0" (o non specificato) indica che i valori degli attributi vengono ordinati in base alla loro posizione nel payload della richiesta. Se l'XML contiene sia il padre sia almeno un fratello di un valore attributo gerarchico non elencato, il valore non elencato viene spostato alla fine dei fratelli elencati durante l'aggiornamento (nel riordino dei figli del padre, tutti i fratelli elencati vengono prima, in nell'ordine in cui sono specificati nell'XML. Tutti i fratelli non elencati sono ultimi, nell'ordine in cui sono già presenti nel sistema). keepSorted si applica ai figli di ogni valore attributo padre.	1
dimension-id	N	L'ID della dimensione se l'attributo è di tipo "dimensione".	15
seqNo Aggiunto nell'API v17 ma riservato per un utilizzo futuro.
Contenuto dell'elemento
Zero o più elementi attributeValue facoltativi. Ogni elemento attributeValue racchiuso rappresenta un "valore attributo radice" nell'attributo, un valore che non ha un valore padre.

elemento attributeValue
Nome tag		attributeValue
Descrizione		Rappresenta un singolo valore membro di un attributo restituito nella risposta a una chiamata API exportAttributes.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID sistema interno per questo valore membro dell'attributo.	34
codice Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Il codice del valore membro dell'attributo.	Disponibile
nome	S	L'etichetta per il valore membro dell'attributo visualizzato nella pagina di amministrazione degli attributi.	Disponibile
displayName Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Il valore displayName del valore membro dell'attributo derivato dal valore displayNameType dell'attributo.	Disponibile
descrizione Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	La descrizione del valore membro dell'attributo visualizzato nella pagina di amministrazione degli attributi.
Contenuto dell'elemento
Zero o più elementi attributeValue facoltativi. Ogni elemento attributeValue racchiuso rappresenta un "valore attributo figlio" di questo valore attributo, i cui membri eseguono implicitamente il rollup a questo valore.

exportActiveCurrencies

exportCalendar

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