exportAttributes

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

exportAttributes

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 attributs du 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 uniquement un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. Une fois vérifiée, la méthode renvoie un document XML décrivant l'ensemble complet de tous les attributs personnalisés (à l'exception de l'attribut système du partenaire commercial pour les instances de consolidation), y compris toutes leurs valeurs de membre. Les valeurs de membre au sein d'un attribut sont renvoyées sous forme d'arbre, les membres parents contenant leurs enfants.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportAttributes" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd"/>
</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 Prise en charge dans API v17 et supérieure
Nom du marqueur		inclure
Description		Représente un ensemble d'indicateurs indiquant les aspects des informations des valeurs d'attribut à inclure ou exclure de la réponse. Cet élément est facultatif : s'il est absent, tous les attributs apparaîtront dans la réponse.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
attributeIDs Prise en charge dans API v17 et supérieure	N	La liste des identifiants qui apparaîtra dans la réponse API. Il agit comme un filtre.	"1,2,3,14"
inaccessibleValues Prise en charge dans API v18 et supérieure	N	Indique si la réponse doit inclure des valeurs inaccessibles à l'utilisateur actuel. La valeur par défaut est false (faux). Seuls les utilisateurs disposant des autorisations "Modélisation" ou "Importer dans tous les périmètres" peuvent définir cette option sur vrai.	false
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 si la réponse doit inclure les nœuds virtuels dans la réponse pour chaque attribut. La valeur par défaut est false (faux). Les nœuds facturables sont inclus dans la réponse uniquement lorsque 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 exportAttributes 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 exportAttributes doit continuer à suivre le contrat API pré-v30, même lorsque l'option Activer le nom d'affichage est activée pour l'instance. L'API exportAttributes ignore les propriétés du nom d'affichage. La valeur par défaut pour displayNameEnabled est "faux".	vrai
Contenu de l'élément
(aucun)

Format de la réponse


<?xml version='1.0' encoding='UTF-8'?>
  <response success="true">
   <output>
     <attributes>
       <attribute id="13" name="AP Eligible" type="account" seqNo="21">
         <attributeValue id="118" name="No" />
         <attributeValue id="117" name="Yes">
           <attributeValue id="136" name="Full" />
           <attributeValue id="135" name="Partial" />
         </attributeValue>
       </attribute>
       <attribute id="11" name="Product Line" type="account" seqNo="3">
         <attributeValue id="34" name="A" />
         <attributeValue id="35" name="B" />
       </attribute>
       <attribute id="9" name="Corporate Discount" type="level" seqNo="11">
         <attributeValue id="56" name="Available" />
         <attributeValue id="54" name="Not Applicable" />
         <attributeValue id="57" name="Not Available" />
         <attributeValue id="55" name="TBD" />
       </attribute>
       <attribute id="10" name="Tax Code" type="level" seqNo="33">
         <attributeValue id="146" name="TT-PYT" />
         <attributeValue id="145" name="TT-TRE" />
       </attribute>
       <attribute id="16" name="Industry" type="dimension" dimension-id="15" seqNo="43">
         <attributeValue id="335" name="Apparel">
            <attributeValue id="354" name="Mens Apparel" />
            <attributeValue id="355" name="Shoes" />
            <attributeValue id="356" name="Womens Apparel" />
         </attributeValue>
       </attribute>
     </attributes>
   </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
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un seul élément attributs obligatoires. 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 attributs
Nom du marqueur		attributs
Description		Conteneur pour zéro ou plusieurs éléments d'attribut. Les attributs seront triés de manière à ce que les attributs soient dans l'ordre suivant selon le type : 'compte', 'périmètre' et 'dimension'. Les attributs de même type seront classés par nom.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
Zéro ou plusieurs éléments d'attribut.

élément d'attribut
Nom du marqueur		attribut
Description		Représente un attribut unique renvoyé en réponse à un appel d'API exportAttributes.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Numéro d'identifiant système interne de l'attribut.	16
nom	O	Le nom de l'attribut tel qu'il apparaît sur la page d'administration des attributs.	Secteur d'activité
displayNameType Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.		Représentation interne du format du nom d'affichage sélectionné pour les valeurs sur les pages Administration des attributs. NOM CODE NAME_CODE CODE_NAME	NOM
type	O	Type de l'attribut. Ce sera 'compte' si l'attribut est pour un compte, 'périmètre' si l'attribut est utilisé pour un périmètre, ou 'dimension' si l'attribut est utilisé pour une dimension.	dimension
autoCreate Prise en charge dans API v20 et supérieure	O	1 si le champ " L'importation de périmètres/comptes/dimensions crée automatiquement des valeurs d'attribut" est défini pour l'attribut sélectionné, 0 sinon	0
keepSorted Prise en charge dans API v20 et supérieure	O	"1" indique que les valeurs de cet attribut sont toujours triées par ordre alphabétique. "0" (ou non spécifié) signifie que les valeurs d'attribut sont triées en fonction de leur position dans les données utiles de la demande. Si XML contient à la fois le parent et au moins un frère d'une valeur d'attribut hiérarchique non répertoriée, la valeur non répertoriée est déplacée à la fin des frères/sœurs répertoriés pendant la mise à jour (dans le réordre des enfants du parent, tous les frères/sœurs répertoriés apparaissent en premier, dans L'ordre dans lequel ils sont indiqués dans le fichier XML. Tous les frères/sœurs non répertoriés apparaissent en dernier, dans l'ordre qu'ils ont déjà dans le système). ainsi que les valeurs d'attributs prédéfinies s'appliquent aux enfants de chaque valeur d'attribut parent.	1
dimension-id	N	L'identifiant de la dimension si l'attribut est de type 'dimension'.	15
seqNo Ajouté dans l'API v17, mais réservé pour une utilisation future.
Contenu de l'élément
Aucun ou plusieurs éléments attributeValue facultatifs. Chaque élément attributeValue inclus représente une "valeur d'attribut racine" dans l'attribut, une valeur qui n'a pas de valeur parent.

élément attributeValue
Nom du marqueur		attributeValue
Description		Représente la valeur d'un membre unique d'un attribut renvoyé en réponse à un appel d'API exportAttributes.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Le numéro d'identifiant système interne associé à cette valeur de membre de l'attribut.	34
code Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.	N	Le code de la valeur de membre de l'attribut.	Disponible
nom	O	Libellé de la valeur de membre de l'attribut tel qu'il s'affiche sur la page d'administration des attributs.	Disponible
displayName Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.	N	Le displayName de la valeur du membre de l'attribut dérivé du displayNameType de l'attribut.	Disponible
description Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.	N	Description de la valeur de membre de l'attribut telle qu'elle apparaît sur la page d'administration des attributs.
Contenu de l'élément
Aucun ou plusieurs éléments attributeValue facultatifs. Chaque élément attributeValue inclus représente une "valeur d'attribut enfant" de cette valeur d'attribut, dont les membres s'agrègent implicitement à cette valeur.

exportActiveCurrencies

exportCalendar

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