exportModeledSheet

Adaptive Planning

Novità (Workday 2025R2)

exportModeledSheet

Aggiornato nella v40 (21 settembre 2024)

Categoria	Recupero dei metadati
Descrizione	Restituisce la definizione del foglio modellato specificato.
Autorizzazioni necessarie per richiamare	MOD (creazione, modifica ed eliminazione di fogli)
Parametri obbligatori su richiesta	Credenziali e una specifica del foglio richiesto.

Recuperare la definizione di un foglio modellato.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportModeledSheet" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_pwd"/>
  <exportModel sheetToExport="Name of Modeled Sheet" />
</call>

L'elemento call contiene un elemento credenziali e un singolo elemento exportModel.

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 exportModel
Nome tag	exportModel
Descrizione	Campi rilevanti per l'esportazione del foglio modello.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
sheetToExport	S	Il nome del foglio modellato.	Modello capitale
displayNameEnabled	N	displayNameEnabled=true indica che exportModeledSheet deve rispettare le proprietà del nome visualizzato quando l'opzione Abilita nome visualizzato è attiva per l'istanza. displayNameEnabled=false indica che l'API exportModeledSheet deve continuare a seguire il contratto API precedente alla v30 anche quando l'opzione Abilita nome visualizzato è attiva per l'istanza. L'API exportModeledSheet ignora le proprietà del nome visualizzato.	true

Formato risposta


<response success="true">
  <output>
      <ConfigurableModel allow-actuals="false" allow-allocation="true" allow-edits-in-rollup-mode="false" breakback-pattern="0" code="Open Positions" description="Open positions
to be filled" frozen-column-count="0" has-salary-detail="true" id="15" isglobal="1" prefix="Openings" revision="0" selected-plan-ids=
"1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18" state="A" strata-code="month" strata-id="3">
          <Columns>
              <AssignablePlan abbr="" code="Plan" id="0" is-splitable="false" name="Plan" read-only="false" show-total-at-bottom="false" tool-tip="" />
              <Driver abbr="" code="PositionCode" decimal-precision="0" driver-type="0" id="22" is-split-key="false" is-splitable="false" name="Position Code" read-only="false"
show-total-at-bottom="false" tool-tip="" />
              <Dimension abbr="" code="Department" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="6" is-splitable="true" isEditDimension="false" isHiddenOnSheet="false"
isTextSelector="false" name="Department" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip="" requiredColumn="true">
                  <DimensionValue abbr="" id="7" in-use="0" name="Engr" sort-order="0" />
                  <DimensionValue abbr="" id="40" in-use="0" name="QA" sort-order="1" />
                  <DimensionValue abbr="" id="8" in-use="0" name="PS" sort-order="3" />
                  <DimensionValue abbr="" id="41" in-use="0" name="Dev" sort-order="2" />
                  <DimensionValue abbr="" id="9" in-use="0" name="G & A" sort-order="4" />
                  <DimensionValue abbr="" id="10" in-use="0" name="Sales" sort-order="5" />
                  <LookupTables />
              </Dimension>
              <Dimension abbr="" code="Title" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="16" is-splitable="true" isEditDimension="false" isHiddenOnSheet="false"
isTextSelector="false" name="Title" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip="">
                  <DimensionValue abbr="" id="64" in-use="0" name="Sales Rep" sort-order="8" />
                  <DimensionValue abbr="" id="65" in-use="0" name="Engr Mgr" sort-order="10" />
                  <DimensionValue abbr="" id="66" in-use="0" name="Sr Engr" sort-order="11" />
                  <DimensionValue abbr="" id="67" in-use="0" name="Engr" sort-order="12" />
                  <DimensionValue abbr="" id="68" in-use="0" name="GUI Engr" sort-order="13" />
                  <DimensionValue abbr="" id="47" in-use="0" name="CFO" sort-order="1" />
                  <DimensionValue abbr="" id="48" in-use="0" name="VP Mkt" sort-order="3" />
                  <DimensionValue abbr="" id="49" in-use="0" name="Doc Mgr" sort-order="5" />
                  <DimensionValue abbr="" id="18" in-use="0" name="CEO" sort-order="0" />
                  <DimensionValue abbr="" id="50" in-use="0" name="VP Sales" sort-order="7" />
                  <DimensionValue abbr="" id="51" in-use="0" name="VP Engr" sort-order="9" />
                  <DimensionValue abbr="" id="61" in-use="0" name="Controller" sort-order="2" />
                  <DimensionValue abbr="" id="62" in-use="0" name="Mkt Assoc" sort-order="4" />
                  <DimensionValue abbr="" id="63" in-use="0" name="Doc Writer" sort-order="6" />
                  <LookupTables />
              </Dimension>
              <Dimension abbr="" code="Base Pay" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="1" is-splitable="true" isEditDimension="false" isHiddenOnSheet="false"
isTextSelector="false" name="Base Pay" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip="">
                  <DimensionValue abbr="" id="22" in-use="0" name="60-80K" sort-order="3" />
                  <DimensionValue abbr="" id="23" in-use="0" name="80-100K" sort-order="4" />
                  <DimensionValue abbr="" id="24" in-use="0" name="100-120K" sort-order="0" />
                  <DimensionValue abbr="" id="25" in-use="0" name="120-150K" sort-order="1" />
                  <DimensionValue abbr="" id="26" in-use="0" name="150-200K" sort-order="2" />
                  <DimensionValue abbr="" id="27" in-use="0" name="&gt;200K" sort-order="5" />
                  <LookupTables />
              </Dimension>
              <Dimension abbr="" code="Position Type" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="10" is-splitable="true" isEditDimension="false" isHiddenOnSheet=
"false" isTextSelector="false" name="Position Type" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip="">
                  <DimensionValue abbr="" id="28" in-use="0" name="Full Time" sort-order="1" />
                  <DimensionValue abbr="" id="29" in-use="0" name="Part Time" sort-order="2" />
                  <DimensionValue abbr="" id="30" in-use="0" name="Contract" sort-order="0" />
                  <LookupTables />
              </Dimension>
              <Dimension abbr="" code="Education" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="7" is-splitable="true" isEditDimension="false" isHiddenOnSheet="false"
isTextSelector="false" name="Education" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip="">
                  <DimensionValue abbr="" id="32" in-use="0" name="Masters" sort-order="1" />
                  <DimensionValue abbr="" id="33" in-use="0" name="Phd" sort-order="2" />
                  <DimensionValue abbr="" id="31" in-use="0" name="Graduate" sort-order="0" />
                  <LookupTables />
              </Dimension>
              <Driver abbr="" code="Rate" decimal-precision="0" display-as="1" driver-type="1" id="23" is-split-key="false" is-splitable="false" name="Rate" read-only="false"
show-total-at-bottom="false" tool-tip="" />
              <Driver abbr="" code="YearsOfExperience" decimal-precision="0" display-as="1" driver-type="1" id="24" is-split-key="false" is-splitable="false" name="Years Of
Experience" read-only="false" show-total-at-bottom="false" tool-tip="" />
              <Driver abbr="" code="FillBy" decimal-precision="0" driver-type="2" id="25" is-split-key="false" is-splitable="false" name="Fill By" read-only="false"
show-total-at-bottom="false" tool-tip="" />
          </Columns>
          <CalculatedAccounts />
          <Assumptions />
      </ConfigurableModel>
  </output>
</response>

La risposta conterrà la definizione del foglio in un elemento ConfigurableModel.

Elemento ConfigurableModel
Nome tag		ConfigurableModel
Descrizione		Rappresenta un singolo foglio modellato restituito nella risposta a una chiamata API export-ModeledSheet.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Il nome del foglio. Può essere utilizzato per identificare i fogli in altre chiamate API, ad esempio importModeledSheet.	Posizioni aperte
descrizione	N	La descrizione del foglio, se presente.	Posizioni aperte da coprire
Contenuto dell'elemento
Consultare l'XML della risposta

Codici colonna di visualizzazione foglio modellato per API v40+

exportModeledSheet

supporta codici univoci per le colonne di visualizzazione. Se un foglio modellato ha una colonna di visualizzazione,

exportModeledSheet

api response includerà una nuova proprietà per

DisplayColumn

<DisplayColumn abbr="" account-code="PayRate" account-id="370" code="PayRateDisplay" hiddenColumn="true" id="7" is-splitable="false" months="6" name="Pay Rate Display Column" read-only="true" show-total-at-bottom="true" start-time-adjust="1" start-time-index="2" start-time-relative-to="C" strata-code="qtr" tool-tip="Display Column" />

Prendere nota della nuova proprietà

account-code

, che ora punta al codice del conto associato. Nel frattempo, la proprietà code rimane, ma ora può essere utilizzata per creare un identificatore univoco modificabile per la colonna specificata.

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