importModeledSheet

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

importModeledSheet

Aktualisiert in API v40 (21. September 2024)

Kategorie	Abrufen von Metadaten
Beschreibung	Importiert das angegebene modellierte Tabellenblatt.
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.

Anforderungsformat


<call method="importModeledSheet" callerName="a string that identifies your client application">
  <credentials credentials login="sampleuser@company.com" password="my_pwd" />

  <ConfigurableModel allow-actuals="false"
              allow-allocation="true" allow-edits-in-rollup-mode="false"
              breakback-pattern="0" code="Open Positions Clone" description="Open positions Clone to be filled"
              frozen-column-count="0" has-salary-detail="true" id="15" isglobal="1"
              prefix="OpeningsClone" 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">
      <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="1" 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="1" name="G & A"
                          sort-order="4" />
              <DimensionValue abbr="" id="10" in-use="1" 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="" requiredColumn="false">
              <DimensionValue abbr="" id="64" in-use="1" 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="1" 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="1" 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="" requiredColumn="false">
              <DimensionValue abbr="" id="22" in-use="1" 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="1" 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=">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="" requiredColumn="false">
              <DimensionValue abbr="" id="28" in-use="1" name="Full Time"
                          sort-order="1" />
              <DimensionValue abbr="" id="29" in-use="1" name="Part Time"
                          sort-order="2" />
              <DimensionValue abbr="" id="30" in-use="1" 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="" requiredColumn="false">
              <DimensionValue abbr="" id="32" in-use="1" name="Masters"
                          sort-order="1" />
              <DimensionValue abbr="" id="33" in-use="0" name="Phd"
                          sort-order="2" />
              <DimensionValue abbr="" id="31" in-use="1" 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>
</call>

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

Bearbeitbare Tabellenblattcodes (anwendbar für API v39 +)

Anforderungsformat für API v39 + configurableModelElement erfordert Name und Code-Attribut

<call method="importModeledSheet" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_pwd" />

  <ConfigurableModel allow-actuals="false"
              allow-allocation="true" allow-edits-in-rollup-mode="false"
              breakback-pattern="0" name="Open Positions Clone" description="Open positions Clone to be filled"
              frozen-column-count="0" has-salary-detail="true" id="15" isglobal="1"
              code="OpeningsClone" 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">
 ...

Regeln für Modelldatenvalidierung (anwendbar ab API v39)

Wir unterstützen die Möglichkeit, Datenvalidierungsregeln mithilfe der Anforderung importModeledSheet zu importieren. Beispielanforderung siehe unten:

<call method="importModeledSheet" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_pwd" />
<ConfigurableModel allow-actuals="false" allow-allocation="false" allow-edits-in-rollup-mode="false" breakback-pattern="7" code="SampleDef" description="TestDef Sheet" frozen-column-count="0" has-salary-detail="false" id="142" isglobal="0" name="SampleDef" recalculateOnDemand="false" revision="0" selected-plan-ids="1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24" state="A" strata-code="month" strata-id="1">
 <Columns>
    <Driver abbr="" code="InitialBalance" data-privacy="0" decimal-precision="0" display-as="0" driver-type="3" formula="0" hiddenColumn="true" id="1163" is-split-key="false" is-splitable="false" name="Initial Balance" read-only="false" show-total-at-bottom="false" tool-tip="" />
    <Dimension abbr="" code="CorporateDiscount" codeHasBeenUpdated="false" hasOverriddenTitle="false" hiddenColumn="true" id="25" is-splitable="false" isEditDimension="false" isHiddenOnSheet="false" isTextSelector="false" name="CorporateDiscount" read-only="true" show-total-at-bottom="false" tagType="2" tool-tip="">
       <DimensionValue abbr="" id="215" in-use="0" name="Not Applicable" sort-order="0" />
       <DimensionValue abbr="" id="216" in-use="0" name="TBD" sort-order="1" />
       <DimensionValue abbr="" id="217" in-use="1" name="Available" sort-order="2" />
       <DimensionValue abbr="" id="218" in-use="1" name="Not Available" sort-order="3" />
       <LookupTables />
    </Dimension>
    <AssignablePlan abbr="" code="Plan" id="0" is-splitable="false" name="Level" read-only="false" show-total-at-bottom="false" tool-tip="" />
 </Columns>
 <CalculatedAccounts />
 <Assumptions />
 <DataValidationRules>
    <Rule actionType="C" expression="if (ROW.InitialBalance=10, 1, 0)" helpText="Test" id="268" name="TestInitialBalance" status="A" />
    <Rule actionType="C" expression="if (ROW.CorporateDiscount="na"
, 1, 0)" helpText="Test" id="137" name="TestLAttribRule" status="A" />
 </DataValidationRules>
</ConfigurableModel>
</call>

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 zum Ausführen der Aktion verfügen, damit der API-Aufruf ausgeführt werden kann 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)

Element „ConfigurableModel“.
Tag-Name		ConfigurableModel
Beschreibung		Stellt ein einzelnes modelliertes Tabellenblatt dar, das hochgeladen wurde.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
code (API v38 und niedriger) name (API v39 +)	J	Der Name des Tabellenblatts. Dies kann verwendet werden, um Tabellenblätter in anderen API-Aufrufen zu identifizieren, z. B. importModeledSheet. Das Tabellenblatt wird importiert, wenn ein Tabellenblatt mit diesem Namen in der Instanz noch nicht vorhanden ist.	Offene Stellen klonen
prefix (API v38 und niedriger) Code (API v39 +)	J	Das Präfix des Tabellenblatts, das als Präfix für die Konten des Tabellenblatts verwendet wird. Dies muss eindeutig sein. Der Code des Tabellenblatts, der zum Präfix der Konten des Tabellenblatts verwendet wird. Dies muss eindeutig sein	OpeningsClone
Beschreibung	N	Die Beschreibung des Tabellenblatts, falls vorhanden.	Klon von zu besetzenden offenen Stellen
Inhalt des Elements
Siehe Anforderungs-XML oben

Antwortformat


<response success="true">
  <messages>
      <message type="INFO">Dimension Created: Base Pay New</message>
      <message type="INFO">Dimension Created: ABC</message>
  </messages>
</response>

Für die Antwort wird das Erfolgsattribut auf „Wahr“ gesetzt, wenn der Import erfolgreich ist. Darüber hinaus geben eine oder mehrere Informationsmeldungen an, ob neue Dimensionen erstellt wurden.

Wenn die Erstellung aufgrund eines Systemfehlers fehlschlägt, lautet die Antwort wie folgt:


<response success="false">
  <messages>
      <message key="exception-caught">Caught Exception: Failed to create modeled
          sheet.
      </message>
  </messages>
</response>

Antwortformat beim Erstellen des Ebenenattributs

<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<messages>
<message type="INFO">Level attribute created: CorporateDiscount</message>
<message type="INFO">The modeled sheet named SampleDef has been created.</message>
</messages>
</response>

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

ImportModeledSheet

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. Um jedoch eine Rückwärtskompatibilität zu gewährleisten, muss die

account-code

-Eigenschaft ist optional. Wenn die

account-code

nicht in der Anforderung enthalten ist, wird der eindeutige Code prozessual generiert. Stattdessen wird die Code-Eigenschaft verwendet, um die Anzeigespalte mit einem bestimmten Konto zu verknüpfen.

importGroups

Massenaktualisierung von Metadaten

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