exportLevels

Adaptive Planning

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

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

exportLevels

Cette API prend en charge uniquement l’utilisateur Concept : règles d’accès dans l’API v22 et au-delà.

Catégorie	Metadata retrieval
Description	Renvoie les métadonnées de la liste complète de tous les niveaux d’organisation du système.
Autorisations obligatoires pour pouvoir être appelées	Aucun (doit être un identifiant valide pour l’instance)
Paramètres requis sur demande	Identifiants

La demande de cette méthode contient un marqueur d’identification pour désigner et autoriser l’utilisateur auteur de l’appel et un marqueur inclus facultatif pour indiquer les niveaux à inclure dans la réponse. Une fois les données d’identification de l’utilisateur vérifiées, la méthode renvoie un document XML décrivant l’ensemble des niveaux d’organisation du système correspondant à la demande. Les niveaux sont renvoyés sous forme d’arborescence imbriquée, un marqueur de niveau en incluant un autre si le niveau représenté par le marqueur enveloppant est le parent du niveau inclus.

Filtre de niveau

Le filtrage par niveau/version non disponible s’applique toujours lorsqu’une version est précisée.

Si un utilisateur précise une feuille affectée à des utilisateurs dans la demande :

Les niveaux sont retournés si l'utilisateur a accès à cette feuille. Pour les utilisateurs administrateurs, si

inaccessibleValues

est vraie, alors les niveaux seront de retour pour la feuille.

Tous les niveaux de la feuille sont retournés si l’utilisateur a accès à la feuille, quel que soit le niveau d’accès de l’utilisateur.

Si un utilisateur précise une feuille avec un niveau affecté dans la demande :

Le filtrage de l’accès des utilisateurs s’applique lorsque c’est nécessaire par

inaccessibleValues,

qui détermine si la réponse doit inclure les niveaux auxquels l’utilisateur n’a pas accès.

Ensuite, le filtrage de feuilles est appliqué.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportLevels" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_pwd"/>
   <include versionID="3" inaccessibleValues="false"/>
   <sheet id="3" />
</call>

é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.	sampleuser@company.com
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)

inclure un élément
Nom du marqueur		inclure
Description		Représente un ensemble d’indicateurs indiquant quels aspects de l’information des niveaux doivent être inclus ou exclus de la réponse. Cet élément est facultatif : s’il est absent, la valeur par défaut est fausse pour inaccessibleValeurs et vide (ou toutes les versions) pour versionName/versionID.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
groupes Disponible dans l'API v23+	N	Indique si les éléments de niveau dans la réponse incluent un attribut groupIds. Si cela est vrai, les groupIds dans la réponse contiennent une liste séparée par des virgules de tous les groupes dans lesquels le niveau est inclus. Si l’attribut n’est pas présent ou si sa valeur est autre que vraie ou fausse, la valeur par défaut faux est utilisée.	vrai
inaccessibleValues Disponible dans API v18+.	N	Si la réponse doit inclure des niveaux auxquels l’utilisateur n’a pas accès. Vrai ou faux. La valeur par défaut, si l’élément ou son attribut n’est pas présent, est Faux. Si la valeur est fausse, la réponse inclura uniquement les niveaux auxquels l’utilisateur a accès aux données, soit directement, soit implicitement. Notez que cela signifie que la réponse peut ne plus être une arborescence de niveaux à racine unique, mais peut être une série de sous-arborescence disjointes de l’arborescence globale. Seuls les utilisateurs ayant les autorisations Structure d’organisation : Tous les niveaux ou Importer à tous les niveaux peuvent définir cette option à Vrai.	faux
inaccessibleLevels Disponible dans API v17 et versions ultérieures. Non disponible dans l'API v18+.	N	Vrai ou faux. Si la réponse doit inclure des niveaux auxquels l’utilisateur n’a pas accès. La valeur par défaut, si l’élément ou son attribut n’est pas présent, est vraie. Si la valeur est fausse, la réponse inclura uniquement les niveaux auxquels l’utilisateur a accès aux données, soit directement, soit implicitement. Notez que cela signifie que la réponse peut ne plus être une arborescence de niveaux à racine unique, mais peut être une série de sous-arborescence disjointes de l’arborescence globale.	vrai
versionName Mis à jour dans l'API v18	N	Indique si la réponse doit uniquement inclure les niveaux disponibles pour le nom de la version demandée. La valeur par défaut, si l’élément ou son attribut n’est pas présent, doit renvoyer tous les niveaux. Si un nom de version est précisé, seuls les niveaux disponibles pour la version indiquée seront retournés. S’il est présent, l’attribut inaccessibleValeurs sera également appliqué et seuls les niveaux disponibles dans la version précisée et accessibles à l’utilisateur demandeur seront retournés. Si le nom de version indiqué est introuvable, cette API renvoie une erreur. Si à la fois les attributs versionName et versionID sont transmis, l’attribut versionID est ignoré. Quand une version est précisée, l’appel aboutit uniquement si l’utilisateur a accès à la version.	Ingénierie
versionID Mis à jour dans l'API v18	N	Identique à versionName (au-dessus), sauf en prenant un numéro d’identifiant de version comme paramètre. Indique si la réponse doit uniquement inclure les niveaux disponibles pour la version demandée. La valeur par défaut, si l’élément ou son attribut n’est pas présent, doit renvoyer tous les niveaux. Si un identifiant de version est précisé, seuls les niveaux disponibles pour la version indiquée seront retournés. S’il est présent, l’attribut inaccessibleValeurs sera également appliqué et seuls les niveaux disponibles dans la version précisée et accessibles à l’utilisateur demandeur seront retournés. Si l’identifiant de version indiqué est introuvable, cette API renvoie une erreur. Si à la fois les attributs versionName et versionID sont transmis, l’attribut versionID est ignoré. Quand une version est précisée, l’appel aboutit uniquement si l’utilisateur a accès à la version.	3
sans catégorie Pris en charge dans l’API v22+ lorsque l’instance utilise des règles d’accès pour la sécurité.	N	Indique s’il faut inclure les niveaux fantômes dans la réponse. La valeur par défaut est Faux. Les niveaux fantômes sont inclus dans la réponse uniquement lorsque l’utilisateur y a accès.	faux
displayNameEnabled Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	displayNameEnabled=true indique que exportLevels doit respecter les propriétés du nom d'affichage de code , displayNameType , et description lorsque l’option Activer le nom d’affichage est ACTIVÉE pour l’instance. L’option AfficherNameEnabled=false indique que l’API exportLevels 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 exportLevels ignore les propriétés du nom d'affichage code , displayNameType Et description . La valeur par défaut pour displayNameEnabled est « false ».	faux
Contenu de l'élément
(aucun)

élément de feuille
Nom du marqueur		feuille
Description		Représente une feuille, où seuls les niveaux disponibles pour cette feuille seront inclus dans la réponse. Cet élément est facultatif : s’il n’est pas présent, l’API renvoie des informations de niveau indépendamment d’une feuille particulière. Si la feuille donnée est une feuille avec un niveau affecté, ce filtrage serait appliqué en plus de la version et du filtrage de l’accès de l’utilisateur, s’il y a lieu. Si la feuille donnée est une feuille affectée à des utilisateurs à laquelle l’utilisateur actuel a accès, tous les niveaux de cette feuille après tout filtrage de version seront retournés.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Le numéro d’identifiant de système interne pour la feuille.	234
Contenu de l'élément
(aucun)

Format de réponse


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
 <levels seqNo="21">
   <level id="1" name="Corporate Rollup" currency="USD" isImportable="1" workflowStatus="I">
     <level id="2" name="Engineering" currency="USD" shortName="Engr" isImportable="1" workflowStatus="I">
       <level id="7" name="Development" currency="USD" shortName="Dev" isImportable="1" workflowStatus="I"/>
       <level id="8" name="QA" currency="INR" isImportable="0" workflowStatus="L"/>
       <level id="9" name="Documentation" currency="PKR" shortName="Doc" isImportable="1" workflowStatus=R"/>
     </level>
     <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" isImportable="0" workflowStatus="A">
       <attributes>
         <attribute name="Corporate Discount" value="Available" attributeId="20" valueId="188" />
         <attribute name="Transfers Restricted" value="Yes" attributeId="21" valueId="194" />
       </attributes>
     </level>
   </level>
 </levels>
</output>
</response>

élément de réponse
Nom du marqueur		réponse
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
réussite	Y	Vrai ou faux, indiquant si l’appel d’API a réussi ou non. Même les appels réussis peuvent contenir des messages d’avertissement dans leur réponse.	vrai
obsolète	N	S’il est présent dans le marqueur de réponse et défini à Vrai, cet attribut indique que la version de la méthode ou de l’API qui est appelée est obsolète et est officiellement dépréciée. Bien qu’elle continue de fonctionner pour le moment, elle pourrait cesser de fonctionner sous peu. En général, cet attribut n’est pas présent.	faux
Contenu de l'élément
Un seul élément de message facultatif et un seul élément de sortie obligatoire.

élément de sortie
Nom du marqueur	sortie
Attributs de l'élément
(aucun)
Contenu de l'élément
Un élément de comptes unique. Ce filtre de sortie est standard sur toutes les réponses d’API et enveloppe la sortie valide de tout appel d’API réussi.

élément niveaux
Nom du marqueur		niveaux
Description		Conteneur pour l'élément de niveau.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
seqNo Ajouté dans l'API v17, mais réservé pour une utilisation future.
Contenu de l'élément
Un ou plusieurs éléments de niveau. Si la demande comprend des niveaux inaccessibles, il n’y aura qu’un élément de niveau, qui représentera le niveau supérieur de l’organisation.

élément de niveau
Nom du marqueur		niveau
Description		Représente un niveau d’organisation unique retourné en réponse à un appel d’API exportLevels.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Le numéro d’identifiant de système interne pour le niveau.	7
code Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	Le code du niveau.	Développement
nom	Y	Le nom du niveau, tel qu’il apparaît sur les rapports et les feuilles.	Développement
displayName Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	Le nom d’affichage du niveau dérivé de displayNameType.	Développement
devise	Y	Le code de devise pour la devise affectée à ce niveau de l’organisation. La devise sera l’une des devises configurées pour l’instance, qui se trouve dans l’appel exportActiveDevises.	INR
publishDevise Disponible dans l'API v24+	N	Le code de devise pour la devise affectée à publier à partir de ce niveau. Cette propriété s’applique uniquement lorsque l’option Power of One est activée pour l’instance. La devise sera l’une des devises configurées pour l’instance, qui se trouve dans l’appel exportActiveDevises.	USD
shortName	N	L’abréviation du niveau, le cas échéant, telle qu’elle est entrée dans l’administration des niveaux.	Dév.
availableStart	N	La période de début de la disponibilité du niveau pour la version des chiffres réels, applicable uniquement lorsque la version des chiffres réels est indiquée dans la demande. La valeur peut être un code de période temporelle, tel que « 01/2012 » ou la valeur spéciale « START » indiquant le début de la version.	01/2013
availableEnd	N	La période de fin de la disponibilité du niveau pour la version des chiffres réels, applicable uniquement lorsque la version des chiffres réels est indiquée dans la demande. La valeur peut être un code de période temporelle, tel que « 12/2013 » ou la valeur spéciale « END » indiquant la fin de la version.	12/2013
isImportable	N	Indique si le niveau associé peut être importé dans la version indiquée. '0' signifie qu'il ne peut pas être importé et '1' signifie qu'il est importé. Un niveau peut être importé si au moins un créneau horaire dans la version indiquée est importé. L'attribut isImportable est émis uniquement si versionName ou versionID est indiqué dans la demande. Note : isImportable indique uniquement qu’un niveau est disponible pour l’importation dans la version indiquée, et non que l’utilisateur qui fait l’appel d’API est autorisé à effectuer l’importation dans la version ou le niveau. Utilisez exportVersions pour voir quelles versions sont disponibles pour l’utilisateur à l’importation.	1
workflowStatus	N	Émet le statut du flux des travaux pour le niveau associé. I pour « En cours », S pour « Soumis », R pour « Rejeté », A pour « Approuvé » et L pour « verrouillé ». Inclus dans la réponse uniquement si le flux des travaux est activé pour cette société et qu’une versionName ou une versionID de planification est indiquée dans la demande. Le flux de travaux n'est pas disponible pour les versions de chiffres réels.	I
isLinked	Y	1 si le niveau est un niveau associé; sinon, 0.	1
isElimination	Y	1 s’il s’agit d’un niveau d’élimination; sinon, 0.	0
hasChildren	N	Indique si le niveau a des enfants. "false" pour non, "true" pour oui. Cet attribut est défini pour tout niveau ayant des enfants, que les enfants soient accessibles ou non. Si un niveau a des enfants, mais que ces derniers ne sont pas accessibles, l’attribut hasChildren est toujours défini à Vrai.	vrai
description Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	La description du niveau, le cas échéant, telle qu’elle est entrée dans l’administration des niveaux.
Contenu de l'élément
Un élément de niveau imbriqué pour chaque niveau enfant direct de ce niveau. Un élément d’attributs si ce niveau est associé à un ou à plusieurs attributs.

élément d'attributs
Nom du marqueur		attributs
Description		Conteneur pour un ou plusieurs éléments d'attribut.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments d'attribut.

élément d'attribut
Nom du marqueur		attribut
Description		Représente un mappage d’attributs de niveau unique et non vide auquel un niveau est associé.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	Nom de l'attribut de niveau	Escompte d'entreprise
valeur Pris en charge dans l'API v34 lorsque le paramètre Nom d'affichage en vigueur est ACTIVÉ.	Y	La valeur de l'attribut de niveau associé au niveau.	Oui
valueCode Disponible uniquement dans API v32 et API v33 pour les instances qui activent le nom d’affichage. Non pris en charge dans l'API v34 lorsque le paramètre Nom d'affichage en vigueur est ACTIVÉ.	N	Le code de valeur d'attribut pour cet attribut. Pour les API v32 et v33, valueCode n’a de sens que lorsque : Le paramètre Nom d’affichage est ACTIVÉ pour l’instance. displayNameEnabled=1	Y
valueName Disponible uniquement dans API v32 et API v33 pour les instances qui activent le nom d’affichage. Non pris en charge dans l'API v34 lorsque le paramètre Nom d'affichage en vigueur est ACTIVÉ.	N	Le nom de la valeur d'attribut pour cet attribut. Pour les API v32 et API v33, valueName n’a de sens que lorsque : Le paramètre Nom d’affichage est ACTIVÉ pour l’instance. displayNameEnabled=1value	Oui
valueDisplayName Disponible uniquement dans l’API v32+ pour les instances qui activent le nom d’affichage.	Y	Le nom d'affichage de la valeur de l'attribut. Pour l’API v32 et les versions plus récentes, valueDisplayName n’a de sens que lorsque : Le paramètre Nom d’affichage est ACTIVÉ pour l’instance. displayNameEnabled=1value	Oui
attributeID	Y	Le numéro d’identifiant de système interne de l’attribut de niveau.	20
valueID	Y	Le numéro d’identifiant de système interne de la valeur de l’attribut de niveau.	188
Contenu de l'élément
(aucun)

exportInstances

export Locales

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

Que désirez-vous porter à notre attention? Information exacte Répond à ma question Facile à trouver Facile à comprendre M'aide à effectuer ma tâche Information complète et détaillée

Que désirez-vous porter à notre attention? Information inexacte Ne répond pas à ma question Difficile à trouver Difficile à comprendre Ne m'aide pas à effectuer ma tâche Information incomplète ou pas assez détaillée

Décrivez-nous la tâche que vous effectuez. Quelle information supplémentaire pourrait améliorer ce contenu? Voulez-vous partager d’autres détails?

Nom complet

Courriel

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

Merci pour vos commentaires