exportModeledSheet

Adaptive Planning

Workday Adaptive Planning-Dokumentation (Workday 2025R2)
Integration
Datenintegration verwalten
API-Dokumentation
Metadaten und Methoden zum Erstellen, Aktualisieren und Lesen von Daten

Zuletzt aktualisiert: 2023-06-23

exportModeledSheet

Aktualisiert in Version 40 (21. September 2024)

Kategorie	Abrufen von Metadaten
Beschreibung	Gibt die Definition des angegebenen modellierten Tabellenblatts zurück.
Zum Aufrufen sind Berechtigungen erforderlich	Modifikator (Tabellenblätter erstellen, bearbeiten und löschen)
Auf Anforderung erforderliche Parameter	Zugangsdaten und eine Angabe, welches Tabellenblatt angefordert wird.

Rufen Sie die Definition eines modellierten Tabellenblatts ab.

Anforderungsformat


<?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>

Das Element aufrufen enthält ein Element credentials sowie ein einzelnes Element exportModel.

Element „Zugangsdaten“.
Tag-Name		-Zugangsdaten
Beschreibung		Alle API-Aufrufe müssen ein einzelnes Element mit den Zugangsdaten enthalten, um den Benutzer zu identifizieren, der die API aufruft. Der API-Aufruf wird dann als dieser Benutzer ausgeführt (jeder Audit-Trail oder jede Aktionshistorie im System zeigt, dass dieser Benutzer die Aktion ausgeführt hat). Daher muss der Benutzer über die erforderlichen Berechtigungen verfügen, um die Aktion in Reihenfolge für die API auszuführen -Aufruf erfolgreich ist.
Attribute des Elements
Name des Attributs	erforderlich ?	Wert	Beispiel
anmelden	J	Der Anmeldename des Benutzers, der die API-Methode aufruft. Dieser Benutzer muss über die erforderlichen Berechtigungen zum Aufrufen der Methode verfügen.	sampleuser@company.com
Kennwort	J	Das Kennwort des Benutzers, der die API-Methode aufruft.	my_password
Gebietsschema	N	Geben Sie das Gebietsschema an, das verwendet werden soll, um eingehende Zahlen und Datumsangaben zu interpretieren und ausgehende Zahlen und Datumsangaben zu formatieren (mit dem entsprechenden Tausendertrennzeichen, den Monatsnamen und der Datumsformatierung). Das Gebietsschema wird auch verwendet, um die Sprache anzugeben, in der Systemmeldungen in der Antwort angezeigt werden sollen. Wenn nicht angegeben, wird en_US (amerikanisches Englisch) verwendet.	fr_FR
instanceCode	N	Wenn der in den Zugangsdaten angegebene Benutzer Zugriff auf mehr als eine Instanz von hat, Adaptive Planning : Dieses Attribut kann verwendet werden, um anzugeben, dass der Benutzer auf eine andere Instanz als seine Standardinstanz zugreifen möchte. Wenn nicht angegeben, wird die Standardinstanz des Benutzers verwendet. Verwenden Sie die exportInstances-API, um die verfügbaren Instanzcodes zu ermitteln.	MYINSTANCE1
Inhalt des Elements
(Keine)

exportModel-Element
Tag-Name	exportModel
Beschreibung	Felder, die für den Export des Modelltabellenblatts relevant sind.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
sheetToExport	J	Der Name des modellierten Tabellenblatts.	Kapitalmodell
displayNameEnabled	N	displayNameEnabled=true gibt an, dass exportModeledSheet die Eigenschaften des Anzeigenamens berücksichtigen soll, wenn "Anzeigenamen aktivieren" für die Instanz auf EIN gesetzt ist. displayNameEnabled=false gibt an, dass die exportModeledSheet-API weiterhin den API-Vertrag vor v30 einhalten soll, auch wenn "Anzeigenamen aktivieren" für die Instanz auf EIN gesetzt ist. Die exportModeledSheet-API ignoriert die Eigenschaften des Anzeigenamens.	wahr

Antwortformat


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

Die Antwort enthält die Tabellenblattdefinition in einem ConfigurableModel-Element.

Element „ConfigurableModel“.
Tag-Name		ConfigurableModel
Beschreibung		Stellt ein einzelnes modelliertes Tabellenblatt dar, das in der Antwort auf einen export-ModeledSheet-API-Aufruf zurückgegeben wird.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Der Name des Tabellenblatts. Dies kann verwendet werden, um Tabellenblätter in anderen API-Aufrufen zu identifizieren, z. B. importModeledSheet.	Offene Stellen
Beschreibung	N	Die Beschreibung des Tabellenblatts, falls vorhanden.	Zu besetzende offene Stellen
Inhalt des Elements
Siehe Antwort-XML

Anzeige-Spaltencodes für modellierte Tabellenblätter für API v40 +

exportModeledSheet

unterstützt eindeutige Codes für Anzeigespalten. Wenn ein modelliertes Tabellenblatt eine Anzeigespalte hat, gilt Folgendes:

exportModeledSheet

API-Antwort enthält eine neue Eigenschaft für

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" />

Beachten Sie die neue Eigenschaft:

account-code

, das nun auf den Code des zugehörigen Kontos verweist. Die Eigenschaft „Code“ bleibt dabei erhalten, kann aber verwendet werden, um eine bearbeitbare, eindeutige Kennung für die angegebene Spalte zu erstellen.

exportDimensionMapping

exportPermissionSets

War dies hilfreich?

Was erfordert unsere Aufmerksamkeit? Zutreffend Beantwortet meine Frage Leicht zu finden Leicht zu verstehen Hilft mir bei der Bearbeitung meiner Aufgabe Vollständig und mit Details

Was erfordert unsere Aufmerksamkeit? Nicht zutreffend Beantwortet nicht meine Frage Nicht leicht zu finden Nicht leicht zu verstehen Hilft mir nicht bei der Bearbeitung meiner Aufgabe Unvollständig oder ohne Details

Beschreiben Sie uns Ihre Aufgabe. Welche zusätzlichen Informationen könnten diesen Inhalt verbessern? Möchten Sie weitere Details teilen?

Vollständiger Name

E-Mail

Workday nutzt Ihren Namen und Ihre E-Mail-Adresse, um Ihnen Antworten zu Ihrem Feedback zu geben. Ihre Daten werden entsprechend unserer Datenschutzerklärung behandelt.

Vielen Dank für Ihr Feedback