exportVersions

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 : 2024-09-20

exportVersions

Mis à jour dans l'API v40. (21 septembre 2024).

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	Une fois vérifiée, la méthode renvoie un document XML décrivant l’ensemble de toutes les versions définies dans l’instance qui ne sont pas masquées à l’utilisateur demandeur.
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 de toutes les versions définies dans l’instance qui ne sont pas masquées à l’utilisateur demandeur.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportVersions" 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). Par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action afin que l’appel d’API puisse être exécuté 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 sur la version doivent être inclus ou exclus de la réponse. Cet élément est facultatif : s’il est absent, l’API renverra toutes les informations de version.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
rootActuals Non pris en charge dans aucune version de l'API en date de 2019.3	N	Indique si la version racine des chiffres réels doit être incluse lorsque les chiffres réels sont masqués dans le sélecteur de version.	faux
scénarios	N	Indique si des scénarios hypothétiques privés doivent être inclus dans la réponse.	faux
currencyVersions Disponible dans l'API v40+	N	Indique si les versions de devises pour les chiffres réels convertis doivent être incluses dans la réponse. Vous devez communiquer avec votre contact désigné pour le soutien afin de voir si votre instance est admissible à cette fonction.	faux
Contenu de l'élément
(aucun)

Format de réponse


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<versions seqNo="32">
  <version id="1" name="Actuals" shortName="" type="ACTUALS" isVirtual="false" description="Total Actuals" isDefaultVersion="false"
           isLocked="false" hasAuditTrail="false" isImportable="0"
           startVer="2012" completedValuesThru="03/2012"
           startScroll="01/2012" endVer="2016" lockLeading="" >
    <version id="5" name="Adjusted Actuals" shortName="SV-13" type="ACTUALS" isVirtual="false" description="Actuals SubVersion" isDefaultVersion="false"
             isLocked="false" hasAuditTrail="false" isImportable="0" >
      <version id="6" name="Original Import" shortName="SSV-13" type="ACTUALS" isVirtual="false" description="Values Imported from the GL" isDefaultVersion="false"
               isLocked="false" hasAuditTrail="false" isImportable="1" />
      <version id="8" name="Manual Adjustments" shortName="SSV-14" type="ACTUALS" isVirtual="false" description="Actuals Sub-Version for Manual Adjustments" isDefaultVersion="false"
               isLocked="false" hasAuditTrail="true" isImportable="1" />
    </version>
    <version id="9" name="Eliminations" shortName="ELIM" type="ACTUALS" isVirtual="false" description="Eliminating entries" isDefaultVersion="false"
             isLocked="false" hasAuditTrail="false" isImportable="0" />
  </version>
  <version id="2" name="Budget 2013" shortName="" type="PLANNING" isVirtual="false" description="This is the budget for 2013 with a five-year span." isDefaultVersion="true"
           isLocked="false" hasAuditTrail="true" isImportable="1"
           leftScroll="2013" startPlan="01/2013" endPlan="2017" lockLeading="05/2013" />
    <version id="10" name="Worst Case" shortName="S13-A-WC" type="SCENARIO" isVirtual="false" description="Worst Case for Budget 2013" isDefaultVersion="false" isLocked="false"
             hasAuditTrail="false" isImportable="0" isPredictive="false" />
  </version>
 <version id="3" name="Budget 2014" shortName="B-14" type="PLANNING" isVirtual="false" description="This is the budget for 2014 with a five-year span." isDefaultVersion="false"
           isLocked="false" hasAuditTrail="false" isImportable="1"
           leftScroll="2014" startPlan="01/2014" endPlan="2018" lockLeading="" />
</versions>
</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 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 versions
Nom du marqueur		versions
Description		Conteneur pour un ou plusieurs éléments de version.
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 version.

élément de version
Nom du marqueur		version
Description		Représente une version unique retournée en réponse à un appel d’API exportVersions.
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 version ou le dossier. Tous les identifiants sont uniques parmi toutes les versions, sous-versions et dossiers.	2
nom	Y	Nom de la version ou du dossier, tel qu’il apparaît dans l’administration des versions.	Budget 2015
shortName	N	Un nom abrégé de la version, le cas échéant, tel qu’il est entré dans l’administration des versions	B2015
type Mis à jour dans l'API v37.	Y	Une des valeurs suivantes : HEURES RÉELLES = Version ou sous-version de chiffres réels standard Journalal_entry = sous-version de chiffres réels des écritures Planning = version du plan VERSION_FOLDER = Folder Scénario = un scénario personnel de type simulation	ACTUALS
isVirtual Disponible dans l'API v16+	Y	vrai ou faux pour indiquer s'il s'agit d'une version virtuelle	faux
description	Y	Description de la version ou du dossier, telle qu’elle apparaît dans l’administration des versions.	Voici le budget de 2015 avec un horizon temporel de cinq ans.
isDefaultVersion	Y	Indique si la version est la version par défaut. Vrai si la version est la version par défaut, sinon faux.	vrai
isVerrouillé	N	Indique si la version a été « verrouillée globale » (la case Version verrouillée est cochée). Si elle n’est pas présente, la version n’est pas considérée comme verrouillée. Sert toujours à 'faux' pour les versions des chiffres réels ou pour les dossiers.	vrai
hasAuditTrail	Y	Indique si la piste d’audit est activée pour la version.	vrai
enabledForWorkflow Disponible dans l'API v17+	N	Indique si la version est activée pour le flux des travaux.	1
isImportable	N	Indique si l’utilisateur qui demande cette API est autorisé à importer des données dans la version. La valeur 0 signifie que la version ne peut pas accepter l’importation, et la valeur 1 signifie qu’elle le peut. Une version peut être importée si au moins un créneau horaire dans la version indiquée est importé pour cet utilisateur.	1
startVer	N	Le code de la période racine dans laquelle la version commence. Équivalent au début de la version dans la page d’administration de la version. Cet attribut est affiché uniquement pour la version des chiffres réels racine. Cet attribut est obligatoire pour la version des chiffres réels racine.	2015
endVer	N	Le code de la période racine dans laquelle la version se termine. Équivalent à la fin de la version dans la page d’administration de la version. Cet attribut est affiché uniquement pour la version des chiffres réels racine. Cet attribut est obligatoire pour la version des chiffres réels racine.	2015
startScroll	N	Le code de la période de feuille où commence la planification. Équivalent à l’emplacement du défilement de début sur la page d’administration de la version. Cet attribut est affiché uniquement pour la version des chiffres réels racine. Cet attribut est obligatoire pour la version des chiffres réels racine.	01/2015
completedValuesThru	N	Le code de la dernière période de feuille pour laquelle les chiffres réels racine sont entrés. Dans un calendrier standard, ce serait un mois. Équivalent aux valeurs terminées jusqu’à la page d’administration de la version. Cet attribut est affiché uniquement pour la version des chiffres réels racine. Cet attribut est facultatif pour la version des chiffres réels racine.	03/2015
leftScroll	N	Le code de la période racine dans laquelle la version commence. Équivalent à la limite de défilement à gauche dans la page d’administration de la version. Cet attribut est affiché uniquement pour les versions de planification. Cet attribut est obligatoire pour les versions de planification.	2015
startPlan	N	Le code de la période de feuille où commence la planification. Équivalent au début du plan dans la page d’administration de la version. Cet attribut s'affiche uniquement pour les versions de planification et est obligatoire pour les versions de planification.	02/2015
endPlan	N	Le code de la période racine dans laquelle la version se termine. Équivalent à la fin du plan dans la page d’administration de la version. Cet attribut est affiché uniquement pour les versions de planification. Cet attribut est obligatoire pour les versions de planification.	2015
LockLeading	N	Le code de la période de feuille jusqu’à laquelle les valeurs de version sont verrouillées. Équivalent pour verrouiller les mois principaux sur la page d’administration de la version. Cet attribut est affiché uniquement pour la version racine des chiffres réels et la version Planning. Cet attribut est facultatif pour la version des chiffres réels racine et la version de planification.	05/2015
prédictive Disponible dans API v28 +	Y	Indique si la version est une version prédictive.	faux
Contenu de l'élément
Un élément de version imbriqué pour chaque version enfant directe de cette version.

exportUsers

importDimensionMapping

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