exportVersions
Mis à jour dans API v40. (21 septembre 2024).
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 | 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 pour l'utilisateur demandeur. |
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 de toutes les versions définies dans l'instance qui ne sont pas masquées pour 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 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 ( n'importe quelle piste d'audit ou historique d'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 afin que l'appel d'API s'appelle 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 quels aspects de l'information de 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 sur la version. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
rootActuals Non pris en charge dans aucune version de l'API à partir de 2019.3 | N | Indique si la version de montants réels racine doit être incluse lorsque les montants réels sont masqués dans l'outil de sélection de version. | false |
scénarios | N | Indique si des scénarios possibles et privé doivent être inclus dans la réponse. | false |
currencyVersions
Disponible dans API v40 et supérieure | N | Indique si les versions de devise des montants réels convertis doivent être incluses dans la réponse.
Vous devez demander à votre contact support désigné de savoir si votre instance est éligible à cette fonctionnalité. | false |
Contenu de l'élément | |||
(aucun) | |||
Format de la 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 | 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 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 de 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 seule version renvoyée en réponse à un appel d'API exportVersions. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
id | O | Numéro d'identifiant du système interne pour la version ou le dossier. Tous les identifiants sont uniques pour toutes les versions, sous-versions et dossiers. | 2 |
nom | O | Nom de la version ou du dossier, tel qu'il apparaît dans Administration des versions. | Budget 2015 |
shortName | N | Un nom abrégé de version, le cas échéant, tel que saisi dans Administration des versions | B2015 |
type
Mis à jour dans API v37. | O | L'une des valeurs suivantes :
| ACTUALS |
isVirtual Disponible dans API v16 et supérieure | O | vrai ou faux pour indiquer s'il s'agit d'une version virtuelle | false |
description | O | Description de la version ou du dossier, telle qu'elle apparaît dans Administration des versions. | Il s'agit du budget 2015 sur un intervalle de cinq ans. |
isDefaultVersion | O | Indique si la version est la version par défaut. Vrai si la version est la version par défaut, sinon Faux. | vrai |
is Locked | N | Indique si la version a été "verrouillée de manière globale" (la case Version verrouillée est cochée). Si elle n'existe pas, la version n'est pas considérée comme verrouillée. Sera toujours 'faux' pour les versions de montants réels ou les dossiers. | vrai |
hasAuditTrail | O | Indique si le paramètre Piste d'audit est activé pour la version. | vrai |
enabledForWorkflow Disponible dans API v17 et supérieure | N | Indique si la version est activée pour le workflow. | 1 |
isImportable | N | Indique si l'utilisateur qui demande cette API est autorisé à importer des données dans la version. 0 signifie que la version ne peut pas accepter les imports, et 1 signifie qu'elle peut les importer. Une version est importable si au moins un créneau horaire dans la version indiquée l'est pour cet utilisateur. | 1 |
startVer | N | Le code de la période racine à laquelle commence la version. Équivaut au début de la version sur la page d'administration des versions. Cet attribut s'affiche uniquement pour la version de montants réels racine. Cet attribut est obligatoire pour la version des montants réels racine. | 2015 |
endVer | N | Le code de la période racine à laquelle se termine la version. Équivaut à la fin de la version sur la page d'administration des versions. Cet attribut s'affiche uniquement pour la version de montants réels racine. Cet attribut est obligatoire pour la version des montants réels racine. | 2015 |
startScroll | N | Le code de la période feuille où la planification commence. Équivaut à l'emplacement de départ du défilement sur la page d'administration de la version. Cet attribut s'affiche uniquement pour la version de montants réels racine. Cet attribut est obligatoire pour la version des montants réels racine. | 01/2015 |
completedValuesThru | N | Le code de la dernière période feuille pour laquelle les montants réels racine contiennent des données renseignées. Dans un calendrier standard, ce serait un mois. Équivaut aux valeurs saisies jusqu'à sur la page d'administration des versions. Cet attribut s'affiche uniquement pour la version de montants réels racine. Cet attribut est facultatif pour la version des montants réels racine. | 03/2015 |
leftScroll | N | Le code de la période racine à laquelle commence la version. Équivaut à la limite de défilement à gauche sur la page d'administration des versions. Cet attribut est affiché uniquement pour les versions Planning. Cet attribut est obligatoire pour les versions Planning. | 2015 |
startPlan | N | Le code de la période feuille où la planification commence. Équivaut au début du plan sur la page d'administration de la version. Cet attribut apparaît 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 à laquelle se termine la version. Équivaut à la fin du plan sur la page d'administration des versions. Cet attribut est affiché uniquement pour les versions Planning. Cet attribut est obligatoire pour les versions Planning. | 2015 |
lockLeading | N | Le code de la période feuille jusqu'à laquelle les valeurs de version sont verrouillées. Équivaut au verrouillage des mois précédents sur la page d'administration des versions. Cet attribut s'affiche uniquement pour la version des montants réels racine et les versions Planning. Cet attribut est facultatif pour la version des montants réels racine et les versions Planning. | 05/2015 |
isPredictive Disponible dans API v28 et supérieure | O | Indique si la version est une version prédictive. | false |
Contenu de l'élément | |||
Un élément de version imbriqué pour chaque version enfant directe de cette version. | |||