exportModeledSheet

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

exportModeledSheet

Mis à jour en v40 (21 septembre 2024)

Catégorie	Metadata retrieval
Description	Renvoie la définition de 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.

Récupérez la définition d'une feuille modèle.

Format de demande


<?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'élément d'appel contient un élément identifiants, ainsi qu'un seul élément exportModel.

é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 (toute la piste d'audit ou l'historique des 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 dans l'ordre pour l'API appelez pour 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 exportModel
Nom du marqueur	exportModel
Description	Les champs pertinents pour l'export de la feuille modèle.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
sheetToExport	O	Le nom de la feuille modèle.	Modèle d'investissement
displayNameEnabled	N	displayNameEnabled=true indique que exportModeledSheet doit respecter les propriétés du nom d'affichage lorsque l'option Activer le nom d'affichage est activée pour l'instance. displayNameEnabled=false indique que l'API exportModeledSheet doit continuer après le contrat API pré-v30, même lorsque l'option Activer le nom d'affichage est activée pour l'instance. L'API exportModeledSheet ignore les propriétés du nom d'affichage.	vrai

Format de la réponse


<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 réponse contient la définition de la feuille dans un élément ConfigurableModel.

Élément ConfigureModel
Nom du marqueur		ConfigurableModel
Description		Représente une feuille modèle unique renvoyée en réponse à un appel d'API export-ModedSheet.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Nom de la feuille. Cela peut être utilisé pour identifier des feuilles dans d'autres appels d'API, tels que importModeledSheet.	Postes à pourvoir
description	N	La description de la feuille, le cas échéant.	Postes à pourvoir à pourvoir
Contenu de l'élément
Afficher le fichier XML de la réponse

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

exportModeledSheet

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.

exportDimensionMapping

exportPermissionSets

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