exportAttributes

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

exportAttributes

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 pour la liste complète de tous les attributs 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 uniquement un marqueur d’identification pour désigner et autoriser l’utilisateur qui est auteur de l’appel. 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 de système de partenaire commercial pour les instances de consolidation), y compris toutes les valeurs de leurs membres. Les valeurs de membres d’un attribut sont retournées sous forme d’arborescence, 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 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 Pris en charge dans l'API v17 +
Nom du marqueur		inclure
Description		Représente un ensemble d'indicateurs indiquant quels aspects de l'information sur les 'valeurs d'attribut' doivent être inclus ou exclus de la réponse. Cet élément est facultatif : s’il n’est pas présent, tous les attributs seront affichés dans la réponse.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
attributeIDs Pris en charge dans l'API v17 +	N	Une liste d'identifiants qui s'afficheront dans la réponse de l'API. Il agit comme un filtre.	"1,2,3,14"
inaccessibleValues Pris en charge dans l'API v18 +	N	Indique si la réponse doit inclure des valeurs inaccessibles à l’utilisateur actuel. La valeur par défaut est Faux. Seuls les utilisateurs disposant des autorisations "Modélisation" ou "Importer à tous les niveaux" peuvent définir cette option à Vrai.	faux
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 si la réponse doit inclure les nœuds fantômes dans la réponse pour chaque attribut. La valeur par défaut est Faux. Les nœuds 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 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 de l’API antérieure à la version 30, 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 « false ».	vrai
Contenu de l'élément
(aucun)

Format de 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	Y	"true" ou "false", 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
Nom de l’attribut	Obligatoire?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un seul élément d'attributs obligatoires. 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 d'attributs
Nom du marqueur		attributs
Description		Conteneur pour zéro ou plusieurs éléments d'attribut. Les attributs seront classés de façon à ce qu'ils soient dans l'ordre suivant selon le type : 'account', 'level' et 'dimension'. Les attributs du même type seront trié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 retourné en réponse à un appel d'API exportAttributes.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Le numéro d’identifiant de système interne pour l’attribut.	16
nom	Y	Le nom de l’attribut tel qu’il apparaît sur la page d’administration des attributs.	Secteur d'activité
displayNameType Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.		La représentation interne du format de nom d’affichage sélectionné pour les valeurs dans les pages d’administration des attributs. NOM CODE NAME_CODE CODE_NAME	NOM
type	Y	Le type de l'attribut. Ce sera 'compte' si l'attribut est pour un compte, 'niveau' si l'attribut est pour un niveau, ou 'dimension' si l'attribut est pour une dimension.	dimension
autoCreate Pris en charge dans l'API v20+	Y	1 si l’attribut sélectionné a un champ « Importation de niveaux/comptes/dimensions crée automatiquement des valeurs d’attributs »; 0 dans le cas contraire.	0
keepSorted Pris en charge dans l'API v20+	Y	"1" indique que les valeurs de cet attribut sont toujours triées par ordre alphabétique. « 0 » (ou non précisé) signifie que les valeurs d’attribut sont triées en fonction de leur position dans la charge utile de la demande. Si le XML contient à la fois le parent et au moins un apparenté d’une valeur d’attribut hiérarchique non répertoriée, la valeur non répertoriée est déplacée à la fin des semblables répertoriés pendant la mise à jour (en réorganisant les enfants du parent, tous les enfants de mêmes parents inscrits sur la liste viennent en premier, dans l’ordre dans lequel ils sont précisés dans le XML. Tous les congés non répertoriés viennent en dernier, dans l’ordre qu’ils ont déjà dans le système). garderSorted s’applique 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
Zéro 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 une valeur de membre unique d'un attribut retourné en réponse à un appel d'API exportAttributes.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Le numéro d'identifiant de système interne pour cette valeur de membre de l'attribut.	34
code Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	Le code de la valeur membre de l'attribut.	Disponible
nom	Y	Étiquette de la valeur membre de l'attribut telle qu'elle est affichée sur la page d'administration de l'attribut.	Disponible
displayName Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	Le type de champ DisplayName de la valeur membre de l'attribut, dérivé de DisplayNameType de l'attribut.	Disponible
description Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	Description de la valeur membre de l’attribut telle qu’elle est affichée sur la page d’administration de l’attribut.
Contenu de l'élément
Zéro 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 sont implicitement regroupés dans cette valeur.

exportActiveCurrencies

exportCalendar

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