exportLevels

Adaptive Planning

Nouveautés (Workday 2025R2)

exportLevels

Cette API prend uniquement en charge l'utilisateur Concept : règles d'accès dans API v22 et supérieure.

Catégorie	Metadata retrieval
Description	Renvoie les métadonnées de la liste complète de tous les niveaux d'organisation dans le système.
Autorisations requises pour appeler	Aucun (doit être des identifiants valides pour l'instance)
Paramètres obligatoires à la demande	Identifiants

La demande de ce mode contient un marqueur identifiants pour identifier et autoriser l'utilisateur appelant, et un marqueur facultatif d'inclure pour indiquer les périmètres à inclure dans la réponse. Une fois les identifiants de l'utilisateur vérifiés, la méthode renvoie un document XML décrivant l'ensemble des niveaux d'organisation dans le système correspondant à la demande. Les périmètres sont renvoyés sous forme d'arbre imbriqué, avec un marqueur de périmètre en serrant un autre si le périmètre représenté par le marqueur en englobant est le parent du périmètre inclus.

Filtre par périmètre

Le filtre de périmètre/de version non disponible s'applique toujours lorsqu'une version est indiquée.

Si un utilisateur indique une feuille affectée à un utilisateur dans la demande :

Les périmètres reviennent si l'utilisateur a accès à cette feuille. Pour les utilisateurs administrateurs, si

inaccessibleValues

est vraie, alors les périmètres reviendront pour la feuille.

Tous les périmètres de la feuille sont renvoyés si l'utilisateur a accès à la feuille, quel que soit son accès au périmètre.

Si un utilisateur indique une feuille affectée à un périmètre dans la demande :

Le filtrage de l'accès utilisateur s'applique lorsque requis par

inaccessibleValues,

qui détermine si la réponse doit inclure des périmètres auxquels l'utilisateur n'a pas accès.

Ensuite, le filtrage de la feuille s'applique.

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

inclure l'élément
Nom du marqueur		inclure
Description		Représente un ensemble d'indicateurs indiquant les aspects de l'information des périmètres qui 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 inaccessibleValues et vide (ou toutes les versions) pour versionName/versionID.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
groupe(s) Disponible dans API v23 et supérieure	N	Indique si les éléments de périmètre de la réponse incluent un attribut groupIds. Si true (vrai), groupIds de la réponse contient une liste de tous les groupes dans lesquels se trouve le périmètre. Si l'attribut n'est pas présent ou si sa valeur est différente de true ou false, la valeur par défaut false est utilisée.	vrai
inaccessibleValues Disponible dans API v18 et supérieure.	N	Si la réponse doit inclure des périmètres 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 false (faux). Si la valeur est false (faux), la réponse n'inclura que les périmètres pour lesquels l'utilisateur a accès aux données, que ce soit directement ou implicite. Notez que cela signifie que la réponse peut ne plus être une arborescence de périmètres racine unique, mais une série de sous-arbres distincts de l'arborescence globale. Seuls les utilisateurs disposant des autorisations "Structure de l'organisation : tous les périmètres" ou "Importer dans tous les périmètres" peuvent définir cette option sur Vrai.	false
inaccessibleLevels Disponible dans API v17 et antérieures. Non disponible dans API v18 et supérieure.	N	Vrai ou Faux. Si la réponse doit inclure des périmètres 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 false (faux), la réponse n'inclura que les périmètres pour lesquels l'utilisateur a accès aux données, que ce soit directement ou implicite. Notez que cela signifie que la réponse peut ne plus être une arborescence de périmètres racine unique, mais une série de sous-arbres distincts de l'arborescence globale.	vrai
versionName Mis à jour dans l'API v18	N	Indique si la réponse doit uniquement inclure les périmètres disponibles pour le nom de la version demandée. Par défaut, si l'élément ou son attribut n'est pas présent, il faut renvoyer tous les périmètres. Si un nom de version est indiqué, seuls les périmètres disponibles pour cette version seront renvoyés. S'il est présent, l'attribut inaccessibleValues sera également appliqué, et seuls les périmètres disponibles dans la version indiquée et accessibles par l'utilisateur demandeur seront renvoyés. Si le nom de version indiqué est introuvable, cette API génère une erreur. Si les deux attributs versionName et versionID sont validés, versionID est ignoré. Lorsque vous indiquez une version, l'appel ne passera que si l'utilisateur y a accès.	Ingénierie
versionID Mis à jour dans l'API v18	N	Identique à versionName (ci-dessus), sauf que le numéro d'identification de version est utilisé comme paramètre. Indique si la réponse doit uniquement inclure les périmètres disponibles pour la version demandée. Par défaut, si l'élément ou son attribut n'est pas présent, il faut renvoyer tous les périmètres. Si un identifiant de version est indiqué, seuls les périmètres disponibles pour la version indiquée seront renvoyés. S'il est présent, l'attribut inaccessibleValues sera également appliqué, et seuls les périmètres disponibles dans la version indiquée et accessibles par l'utilisateur demandeur seront renvoyés. Si l'identifiant de version indiqué est introuvable, cette API génère une erreur. Si les deux attributs versionName et versionID sont validés, versionID est ignoré. Lorsque vous indiquez une version, l'appel ne passera que si l'utilisateur y a accès.	3
sans catégorie Prise en charge dans API v22 et supérieure lorsque l'instance utilise des règles d'accès pour la sécurité.	N	Indique s'il faut inclure les périmètres fictifs dans la réponse. La valeur par défaut est false (faux). Les périmètres facturables sont inclus dans la réponse uniquement si l'utilisateur y a accès.	false
displayNameEnabled Uniquement disponible dans API v30 et supérieure 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. displayNameEnabled=false indique que l'API exportLevels 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 exportLevels ignore les propriétés du nom d'affichage code , displayNameType et description . La valeur par défaut pour displayNameEnabled est "faux".	false
Contenu de l'élément
(aucun)

élément de feuille
Nom du marqueur		feuille
Description		Représente une feuille où seuls les périmètres disponibles pour cette feuille seront inclus dans la réponse. Cet élément est facultatif : s'il est absent, l'API renvoie les informations du périmètre indépendamment d'une feuille particulière. Si la feuille donnée est une feuille affectée à un périmètre, ce filtre sera appliqué en haut de la version et, le cas échéant, du filtre d'accès utilisateur. Si la feuille donnée est une feuille affectée à un utilisateur à laquelle l'utilisateur actuel a accès, alors tous les périmètres de cette feuille après tout filtrage par version seront renvoyés.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Numéro d'identifiant système interne de la feuille.	234
Contenu de l'élément
(aucun)

Format de la 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	O	Vrai ou faux, indiquant si l'appel d'API a réussi ou non. Même les appels traités avec succès peuvent contenir des messages d'avertissement dans leur réponse.	vrai
obsolète	N	S'il figure sur le marqueur de réponse et qu'il est défini sur true (vrai), cet attribut indique que la version de la méthode ou de l'API en cours d'appel est obsolète et qu'elle est officielement dépréciée. Même si elle continue de fonctionner à ce moment, elle peut cesser de fonctionner prochainement. En général, cet attribut n'est pas présent.	false
Contenu de l'élément
Un seul élément de messages facultatifs et exactement un é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 seul élément comptes. Ce filtre de sortie est standard sur toutes les réponses d'API et contient la sortie valide de tout appel d'API réussi.

élément périmètres
Nom du marqueur		périmètre(s)
Description		Conteneur de l'élément de périmètre.
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 périmètre. Si la demande inclut des périmètres inaccessibles, il n'y aura qu'un seul élément de périmètre qui représente le niveau supérieur de l'organisation.

élément de périmètre
Nom du marqueur		level
Description		Représente un périmètre d'organisation unique renvoyé en réponse à un appel d'API exportLevels.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Le numéro d'identifiant système interne du périmètre.	7
code Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.	N	Le code du périmètre.	Développement
nom	O	Le nom du périmètre, tel qu'il apparaît sur les rapports et les feuilles.	Développement
displayName Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.	N	Le nom d'affichage du périmètre issu du type d'affichage du nom de l'affichage.	Développement
devise	O	Le code de la devise affectée à ce niveau de l'organisation. La devise sera l'une des devises configurées pour l'instance, trouvées dans l'appel exportActiveCurrencies.	INR
publishCurrency Disponible dans API v24 et supérieure	N	Le code de la devise affectée à la publication à partir de ce périmètre. Cette propriété s'applique uniquement lorsque Power of One a été activé pour l'instance. La devise sera l'une des devises configurées pour l'instance, trouvées dans l'appel exportActiveCurrencies.	USD
shortName	N	L'abréviation du périmètre, le cas échéant, telle qu'elle est saisie dans Administration des périmètres.	Développeur
availableStart	N	Période de début indiquant la disponibilité du périmètre pour la version des montants réels, applicable uniquement lorsque la version des montants réels est indiquée dans la demande. La valeur peut être un code de période, tel que "01/2012" ou la valeur spéciale "START" indiquant le début de la version.	01/2013
availableEnd	N	Période de fin de la disponibilité du périmètre pour la version des montants réels, applicable uniquement lorsque la version des montants réels est indiquée dans la demande. La valeur peut être un code de période, tel que "12/2013", ou la valeur spéciale "END" indiquant la fin de la version.	12/2013
isImportable	N	Indique si le périmètre associé peut être importé dans la version spécifiée. '0' signifie qu'il n'est pas importable et '1' qu'il peut être importé. Un périmètre est importable si au moins un créneau horaire dans la version indiquée l'est. L'attribut isImportable est émis uniquement si versionName ou versionID est indiqué dans la demande. Remarque : isImportable indique uniquement qu'un périmètre est disponible pour l'import dans la version spécifiée, et non que l'utilisateur qui a fait l'appel d'API est autorisé à importer dans la version ou le périmètre. Utilisez exportVersions pour voir quelles versions sont disponibles pour l'utilisateur.	1
workflowStatus	N	Émet le statut du workflow pour le périmètre 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 workflow est activé pour cette unité légale et qu'un nom de version Planning ou un identifiant de version Planning est indiqué dans la demande. Le workflow n'est pas disponible sur les versions de montants réels.	I
isLinked	O	1 si le périmètre est un périmètre lié ; sinon 0.	1
isElimination	O	1 si le périmètre est un périmètre d'élimination ; sinon 0.	0
hasChildren	N	Indique si le périmètre a des enfants. "faux" pour non, "vrai" pour oui. Cet attribut est défini pour n'importe quel périmètre avec des enfants, indépendamment de ceux-ci étant accessibles ou non. Si un périmètre a des enfants mais que ces derniers ne sont pas accessibles, l'attribut hasChildren est toujours défini sur true (vrai).	vrai
description Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.	N	La description du périmètre, le cas échéant, telle qu'elle est saisie dans Administration des périmètres.
Contenu de l'élément
Un élément de périmètre imbriqué pour chaque périmètre enfant direct de ce périmètre. Un élément d'attribut si ce périmètre est associé à un ou plusieurs attributs.

élément 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 périmètre unique et non vide auquel un périmètre est associé.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	Le nom de l'attribut de périmètre	Escompte d'entreprise
valeur Prise en charge dans l'API v34 lorsque le paramètre Nom d'affichage en vigueur est activé.	O	La valeur de l'attribut de périmètre associé au périmètre.	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 d'effet est activé.	N	Le code de la 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	O
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 d'effet est activé.	N	Le nom de la valeur d'attribut pour cet attribut. Pour 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 Uniquement disponible dans API v32 et supérieure pour les instances qui activent le nom d'affichage.	O	Le nom d'affichage de la valeur de l'attribut. Pour l'API v32 et les versions ultérieures, valueDisplayName n'a de sens que lorsque : Le paramètre Nom d'affichage est activé pour l'instance. displayNameEnabled=1value	Oui
attributeID	O	Le numéro d'identification du système interne de l'attribut de périmètre.	20
valueID	O	Numéro d'identifiant du système interne de la valeur d'attribut de périmètre.	188
Contenu de l'élément
(aucun)

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