exportModeledSheet
Mis à jour dans la version 40 (21 septembre 2024)
Catégorie | Metadata retrieval |
Description | Renvoie la définition de la feuille modélisée donnée. |
Autorisations obligatoires pour pouvoir être appelées | MOD (créer, modifier et supprimer des feuilles) |
Paramètres requis sur demande | Des données d’identification et une spécification de la feuille demandée. |
Récupérez la définition d’une feuille modélisée.
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 Call contient un élément d’identification, ainsi qu’un seul élément exportModel.
élément de données d'identification | |||
Nom du marqueur | données d'identification | ||
Description | Tous les appels d’API doivent contenir un élément d’identification unique pour identifier l’utilisateur qui invoque l’API. L’appel d’API est alors effectué en tant que cet utilisateur (toute piste d’audit ou tout historique des actions dans le système indiquera que cet utilisateur a effectué l’action), et par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action dans l’ordre pour l’API. appel pour réussir. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire ? | Valeur | Exemple |
ouvrir une session | Y | Le nom de connexion de l’utilisateur qui invoque la méthode API. Cet utilisateur doit disposer des autorisations requises pour invoquer la méthode. | |
mot de passe | Y | Le mot de passe de l’utilisateur qui invoque la méthode API. | my_password |
paramètres régionaux | N | Indiquez les paramètres régionaux à utiliser pour interpréter les numéros et les dates entrants et pour mettre en forme les numéros et les dates sortants (à l’aide du séparateur des milliers, des noms de mois et du format de date appropriés). Les paramètres régionaux sont également utilisés pour préciser la langue dans laquelle tous les messages de système de la réponse doivent être affichés. Si cette valeur n’est pas précisée, la valeur en_US (rubrique en anglais américain) est utilisée. | fr_FR |
instanceCode | N | Si l’utilisateur indiqué dans les données d’identification a accès à plusieurs instances de Adaptive Planning , cet attribut peut être utilisé pour préciser que l’utilisateur a l’intention d’accéder à une instance autre que celle par défaut. Si elle n’est pas précisée, l’instance par défaut de l’utilisateur sera utilisée. Pour déterminer les codes d’instances disponibles, utilisez l’API exportInstances. | MYINSTANCE1 |
Contenu de l'élément | |||
(aucun) | |||
Élément exportModel | |||
Nom du marqueur | exportModel | ||
Description | Champs pertinents pour l’exportation de la feuille modèle. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
sheetToExport | Y | Le nom de la feuille modélisée. | Modèle immobilisable |
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.
afficherNameEnabled=false indique que l’API exportModeledSheet doit continuer à suivre le contrat de l’API antérieure à la version v30, même lorsque l’option Activer le nom d’affichage est ACTIVÉE pour l’instance. L’API exportModedSheet ignore les propriétés du nom d’affichage. | vrai |
Format de 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=">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 contiendra la définition de la feuille dans un élément ConfigureableModel.
Élément ConfigureableModel | |||
Nom du marqueur | ConfigurableModel | ||
Description | Représente une seule feuille modélisée retournée en réponse à un appel d’API export- ModeledSheet. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
code | Y | Le nom de la feuille. Cela peut être utilisé pour désigner des feuilles dans d’autres appels d’API, tels que ImportModedSheet. | Postes à pourvoir |
description | N | La description de la feuille, le cas échéant. | Postes à pourvoir à pourvoir |
Contenu de l'élément | |||
Afficher la réponse XML | |||
Codes de colonne d'affichage de feuille modélisée pour l'API v40+
exportModeledSheet
prend en charge des codes uniques pour les colonnes d’affichage. Si une feuille modélisée comporte une colonne d’affichage, laexportModeledSheet
la réponse API inclura une nouvelle propriété pourDisplayColumn
:
Remarquez la nouvelle propriété,<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" />
account-code
, qui indique maintenant le code du compte associé. Pendant ce temps, la propriété du code reste conservée, mais peut maintenant être utilisée pour créer un identifiant unique et modifiable pour la colonne donnée.