importModeledSheet

Adaptive Planning

Documentation Workday Adaptive Planning (Workday 2025R2)
Intégration
Gérer l'intégration des données
Documentation de l'API
Méthodes de création, de mise à jour et de lecture des métadonnées et des données

Dernière mise à jour : 2023-06-23

importModeledSheet

Mise à jour dans API v40 (21 septembre 2024)

Catégorie	Metadata retrieval
Description	Importe la feuille modèle donnée.
Autorisations requises pour appeler	MOD (créer, modifier et supprimer des feuilles)
Paramètres obligatoires à la demande	Identifiants et spécifications de la feuille demandée.

Format de demande


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

L'élément d'appel contient un élément identifiants, ainsi qu'un seul élément ConfigureableModel.

Codes de feuille modifiables (applicables à partir de API v39 et supérieure)

Format de la demande pour API v39 + configurableModelElement nécessitant un nom et un attribut de code

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

Règles de validation des données du modèle (applicables à l'API v39 et au-delà)

Nous prenons en charge la possibilité d'importer des règles de validation de données à l'aide de la demande importModeledSheet. Voir l'exemple de demande ci-dessous :

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

élément identifiants
Nom du marqueur		identifiants
Description		Tous les appels d'API doivent contenir un seul élément identifiants pour identifier l'utilisateur qui a appelé l'API. L'appel d'API est ensuite effectué en tant qu'utilisateur ( n'importe quelle piste d'audit ou historique d'actions dans le système indique que cet utilisateur a effectué l'action) et, par conséquent, l'utilisateur doit avoir les autorisations requises pour effectuer l'action afin que l'appel d'API s'appelle réussir.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
se connecter	O	Le nom de connexion de l'utilisateur appelant la méthode API. Cet utilisateur doit avoir les autorisations requises pour appeler la méthode.	sampleuser@company.com
mot de passe	O	Mot de passe de l'utilisateur appelant la méthode API.	my_password
paramètres régionaux	N	Indiquez les paramètres régionaux à utiliser pour interpréter les chiffres et les dates entrants, et pour formater les chiffres et les dates sortants (en utilisant le séparateur des milliers, les noms de mois et la mise en forme de date appropriés). Les paramètres régionaux sont également utilisés pour indiquer la langue dans laquelle doivent s'afficher les messages système figurant dans la réponse. Si aucune option n'est indiquée, l'expression en_US (anglais américain) est utilisée.	fr_FR
instanceCode	N	Si l'utilisateur spécifié dans les identifiants a accès à plusieurs instances de : Adaptive Planning , cet attribut peut être utilisé pour indiquer que l'utilisateur a l'intention d'accéder à une instance autre que son instance par défaut. Si aucune option n'est indiquée, l'instance par défaut de l'utilisateur sera utilisée. Pour déterminer les codes d'instance disponibles, utilisez l'API exportInstances.	MYINSTANCE1
Contenu de l'élément
(aucun)

Élément ConfigureModel
Nom du marqueur		ConfigurableModel
Description		Représente une seule feuille modèle téléchargée.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code (API v38 et inférieure) nom (API v39 et supérieure)	O	Nom de la feuille. Cela peut être utilisé pour identifier des feuilles dans d'autres appels d'API, tels que importModeledSheet. La feuille sera importée si aucune feuille portant ce nom n'existe dans l'instance.	Cloner des postes à pourvoir
préfixe (API v38 et inférieure) code (API v39 et supérieure)	O	Préfixe de la feuille utilisé pour préfixer les comptes de la feuille. (elle doit être unique). Le code de la feuille utilisé pour préfixer les comptes de la feuille. Ce champ doit être unique.	Clone de l'ouverture d'ouverture
description	N	La description de la feuille, le cas échéant.	Clone des postes à pourvoir à pourvoir
Contenu de l'élément
Voir le document Request XML ci-dessus.

Format de la réponse


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

L'attribut de réussite de la réponse sera défini sur vrai si l'import réussit. En outre, un ou plusieurs messages d'information seront éventuellement indiqués si de nouvelles dimensions ont été créées.

Si la création échoue en raison d'une erreur système, la réponse sera la suivante :


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

Format de la réponse lors de la création d'un attribut de périmètre

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

Codes de colonne d'affichage de feuille modèle pour API v40+

ImportModeledSheet

prend en charge les codes uniques pour les colonnes d'affichage. Si une feuille modèle comporte une colonne d'affichage :

exportModeledSheet

la réponse de l'API inclura une nouvelle propriété pour

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

Notez la nouvelle propriété.

account-code

, qui indique désormais le code du compte associé. Pendant ce temps, la propriété du code est conservée, mais elle peut désormais être utilisée pour créer un identifiant unique et modifiable pour la colonne donnée. Toutefois, pour garantir la compatibilité rétroactive, les

account-code

La propriété est facultative. Si :

account-code

n'est pas incluse dans la demande, le code unique sera généré de manière procédelle et, au lieu de cela, la propriété de code sera utilisée pour lier la colonne d'affichage à un compte donné.

importGroups

Mise à jour en bloc des métadonnées

Cela vous a-t-il été utile?

Souhaitez-vous nous signaler quelque chose ? Exact Répond à ma question Facile à trouver Facile à comprendre Utile pour ma tâche Complet et détaillé

Souhaitez-vous nous signaler quelque chose ? Inexact Ne répond pas à ma question Pas facile à trouver Pas facile à comprendre Inutile pour ma tâche Incomplet ou pas assez détaillé

Décrivez-nous votre tâche en cours. Quelles informations supplémentaires pourraient améliorer ce contenu ? Voulez-vous partager des informations supplémentaires ?

Nom complet

E-mail

Workday utilisera votre nom et votre adresse électronique pour répondre à vos commentaires. Vos données seront traitées conformément à notre Déclaration de confidentialité.

Merci pour votre feedback