Passer au contenu principal
Adaptive Planning
Dernière mise à jour : 2023-06-23
exportTime

exportTime

Cette API prend en charge uniquement l’utilisateur Concept : règles d’accès dans l’API v21 et plus.
Catégorie
Metadata retrieval
Description
Renvoie les métadonnées de temps pour une version précise ou pour toutes les versions si aucune n’est indiquée.
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 un marqueur d’identification pour désigner et autoriser l’utilisateur d’appel et un marqueur de version facultatif pour préciser la version pour laquelle récupérer des informations. Si aucune version n’est précisée, la méthode renvoie des informations sur les temps pour l’intervalle de temps enveloppant les heures de début et de fin de toutes les versions. Une fois l’appelant vérifié, la méthode renvoie un document XML décrivant l’ensemble des informations sur les temps pour la version de manière imbriquée.

Format de demande

<?xml version='1.0' encoding='UTF-8'?> <call method="exportTime" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd" locale="fr_FR" instanceCode="INSTANCE1"/> <options includeAllLocales="1" includeLegacyInformation="1" /> </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)
Élément Options
Nom du marqueur
Options
Description
Indique les options à utiliser lors de l'exportation des heures.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
includeAllLocales
N
Vous pouvez également faire de l’exportation du temps pour exporter toutes les conversions pour chaque strate/période. Si cette option n’est pas précisée, seule la région indiquée dans le bloc de données d’identification est exportée.
"1"
includeLegacyInformation
N
Si vous voulez, vous pouvez faire de l’exportation d’un temps des attributs supplémentaires contenant des informations sur les heures existantes. Ces attributs supplémentaires ne seront pas inclus si isCustom = 1
"1"
leafStratumId
Pris en charge dans l'API v16 +
N
Si vous le souhaitez, indiquez l’identifiant d’une strate de temps à traiter comme la feuille. Les strates de temps plus précises que la strate de temps donnée ne seront pas incluses dans la réponse, pas plus que les périodes liées à des strates de temps plus précises que la strate de temps donnée.
"5"
calendarId
Pris en charge dans l'API v33 +
N
Si vous le souhaitez, fournissez l’identifiant du calendrier/de la hiérarchie à récupérer. Si elle n’est pas précisée, l’API retournera uniquement les valeurs de temps dans la hiérarchie par défaut.
"1"
Contenu de l'élément
(aucun)
élément de version
Nom du marqueur
version
Description
Indique la version à utiliser pour récupérer les données demandées. L'utilisateur doit être en mesure d'accéder à la version indiquée et il ne peut pas s'agir d'un dossier. Un élément de version n'est pas obligatoire, mais s'il est inclus, la version indiquée doit être valide.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
option
mis à jour dans l’API v18
N
Définit l’intervalle de temps à exporter. Peuvent être définis à « tout », « seul » ou omis. La valeur par défaut est "single". S’il est célibataire, l’utilisateur doit également préciser soit « name » soit « id ». Renvoie l’intervalle de temps de la version unique spécifiée et du solde initial pour cette version. Si le nom et l’identifiant sont précisés, ils doivent faire référence à la même version. Le cas échéant, renvoyez l’intervalle de temps du minimum au maximum de toutes les versions, y compris la période de solde initiale pour la première strate de l’intervalle de temps mini-maxi. Le cas échéant, ne doit pas préciser la version "name" ou "id". En cas d’omission, renvoie tous les temps définis.
Quand l’utilisateur précise une seule version, l’appel aboutit uniquement si l’utilisateur a accès à la version.
célibataire
nom
N
Le nom de la version à utiliser pour extraire les données. Une seule version est accessible dans un seul appel d'API. Si aucun nom n’est fourni, un identifiant doit être fourni. Si les deux sont donnés, ils doivent correspondre à la même version.
Budget 2014
identifiant
N
L'identifiant de la version à utiliser pour récupérer les données. Une seule version est accessible dans un seul appel d'API. Si l'option est "single" et qu'aucun identifiant n'est fourni, un nom doit être fourni. Si les deux sont donnés, ils doivent correspondre à la même version.
3
Contenu de l'élément
(aucun)

Format de réponse (avecinclutAllLocales="0" ou non précisé)

<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <time isCustom="1" seqNo="24"> <stratum code="year" label="Year" shortName="Yr" id="3" inUse="1"> <stratum code="qtr" label="Quarter" shortName="Qtr" id="2" inUse="1"> <stratum code="month" label="Month" shortName="Mon" id="1" inUse="1" isDefault="1" /> </stratum> </stratum> <period code="2015" label="FY2015" shortName="FY2015" stratumId="3" timeslot="15" encodedTimePeriod="3::15" id="15003" end="2016-01-01"> <period code="Q1-2015" label="Q1-FY15" shortName="Q1-FY15" stratumId="2" timeslot="60" encodedTimePeriod="2::60" id="60002" end="2015-04-01"> <period code="01/2015" label="Jan-2015" shortName="Jan-2015" stratumId="1"timeslot="180" encodedTimePeriod="1::180" id="180001" end="2015-02-01" /> <period code="02/2015" label="Feb-2015" shortName="Feb-2015" stratumId="1" timeslot="181" encodedTimePeriod="1::181" id="181001" end="2015-03-01" /> <period code="03/2015" label="Mar-2015" shortName="Mar-2015" stratumId="1" timeslot="182" encodedTimePeriod="1::182" id="182001" end="2015-04-01" /> </period> <period code="Q2-2015" label="Q2-FY15" shortName="Q2-FY15" stratumId="2" timeslot="61" encodedTimePeriod="2::61" id="61002" end="2015-07-01"> <period code="04/2015" label="Apr-2015" shortName="Apr-2015" stratumId="1" timeslot="183" encodedTimePeriod="1::183" id="183001" end="2015-05-01" /> <period code="05/2015" label="May-2015" shortName="May-2015" stratumId="1" timeslot="184" encodedTimePeriod="1::184" id="184001" end="2015-06-01" /> <period code="06/2015" label="Jun-2015" shortName="Jun-2015" stratumId="1" timeslot="185" encodedTimePeriod="1::185" id="185001" end="2015-07-01" /> </period> <period code="Q3-2015" label="Q3-FY15" shortName="Q3-FY15" stratumId="2" timeslot="62" encodedTimePeriod="2::62" id="62002" end="2015-10-01"> <period code="07/2015" label="Jul-2015" shortName="Jul-2015" stratumId="1" timeslot="186" encodedTimePeriod="1::186" id="186001" end="2015-08-01" /> <period code="08/2015" label="Aug-2015" shortName="Aug-2015" stratumId="1" timeslot="187" encodedTimePeriod="1::187" id="187001" end="2015-09-01" /> <period code="09/2015" label="Sep-2015" shortName="Sep-2015" stratumId="1" timeslot="188" encodedTimePeriod=""1::188" id="188001" end="2015-10-01" /> </period> <period code="Q4-2015" label="Q4-FY15" shortName="Q4-FY15" stratumId="2" timeslot="63" encodedTimePeriod="2::63" id="63002" end="2016-01-01"> <period code="10/2015" label="Oct-2015" shortName="Oct-2015" stratumId="1" timeslot="189" encodedTimePeriod="1::189" id="189001" end="2015-11-01" /> <period code="11/2015" label="Nov-2015" shortName="Nov-2015" stratumId="1" timeslot="190" encodedTimePeriod="1::190" id="190001" end="2015-12-01" /> <period code="12/2015" label="Dec-2015" shortName="Dec-2015" stratumId="1" timeslot="191" encodedTimePeriod="1::191" id="191001" end="2016-01-01" /> </period> </period> <period code="2016" label="FY2016" shortName="FY2016" stratumId="3" timeslot="16" encodedTimePeriod="3::16" id="16003" end="2017-01-01"> <period code="Q1-2016" label="Q1-FY16" shortName="Q1-FY16" stratumId="2" timeslot="64" encodedTimePeriod="2::64" id="64002" end="2016-04-01"> <period code="01/2016" label="Jan-2016" shortName="Jan-2016" stratumId="1" timeslot="192" encodedTimePeriod="1::192" id="192001" end="2016-02-01" /> <period code="02/2016" label="Feb-2016" shortName="Feb-2016" stratumId="1" timeslot="193" encodedTimePeriod="1::193" id="193001" end="2016-03-01" /> <period code="03/2016" label="Mar-2016" shortName="Mar-2016" stratumId="1" timeslot="194" encodedTimePeriod="1::194" id="194001" end="2016-04-01" /> </period> <period code="Q2-2016" label="Q2-FY16" shortName="Q2-FY16" stratumId="2" timeslot="65" encodedTimePeriod="2::65" id="65002" end="2016-07-01"> <period code="04/2016" label="Apr-2016" shortName="Apr-2016" stratumId="1" timeslot="195" encodedTimePeriod="1::195" id="195001" end="2016-05-01" /> <period code="05/2016" label="May-2016" shortName="May-2016" stratumId="1" timeslot="196" encodedTimePeriod="1::196" id="196001" end="2016-06-01" /> <period code="06/2016" label="Jun-2016" shortName="Jun-2016" stratumId="1" timeslot="197" encodedTimePeriod="1::197" id="197001" end="2016-07-01" /> </period> <period code="Q3-2016" label="Q3-FY16" shortName="Q3-FY16" stratumId="2" timeslot="66" encodedTimePeriod="2::66" id="66002" end="2016-10-01"> <period code="07/2016" label="Jul-2016" shortName="Jul-2016" stratumId="1" timeslot="198" encodedTimePeriod="1::198" id="198001" end="2016-08-01" /> <period code="08/2016" label="Aug-2016" shortName="Aug-2016" stratumId="1" timeslot="199" encodedTimePeriod="1::199" id="199001" end="2016-09-01" /> <period code="09/2016" label="Sep-2016" shortName="Sep-2016" stratumId="1" timeslot="200" encodedTimePeriod="1::200" id="200001" end="2016-10-01" /> </period> <period code="Q4-2016" label="Q4-FY16" shortName="Q4-FY16" stratumId="2" timeslot="67" encodedTimePeriod="2::67" id="67002" end="2017-01-01"> <period code="10/2016" label="Oct-2016" shortName="Oct-2016" stratumId="1" timeslot="201" encodedTimePeriod="1::201" id="201001" end="2016-11-01" /> <period code="11/2016" label="Nov-2016" shortName="Nov-2016" stratumId="1" timeslot="202" encodedTimePeriod="1::202" id="202001" end="2016-12-01" /> <period code="12/2016" label="Dec-2016" shortName="Dec-2016" stratumId="1" timeslot="203" encodedTimePeriod="2::203" id="203001" end="2017-01-01" /> </period> </period> </time> </output> </response>

Format de réponse partielle (avec IncludeAllLocales="1")

Normalement, il existe un bloc de paramètres régionaux pour chaque période et chaque strate. En dessous, seule la section des strates est affichée. Le format du bloc de paramètres régionaux/régionaux pour les périodes temporelles est identique.
<stratum code="year" label="Year" shortName="Year" id="3"> <locales> <locale locale="en" label="Year" shortName="Year" /> <locale locale="de" label="Jahr" shortName="Jahr" /> <locale locale="fr" label="Anne" shortName="Anne" /> <locale locale="es" label="Ao" shortName="Ao" /> <locale locale="pt" label="Ano" shortName="Ano" /> <locale locale="nl" label="Jaar" shortName="Jaar" /> <locale locale="ja" label="年" shortName="年" /> </locales> <stratum code="qtr" label="Quarter" shortName="Quarter" id="2"> <locales> <locale locale="en" label="Quarter" shortName="Quarter" /> <locale locale="de" label="Quartal" shortName="Quartal" /> <locale locale="fr" label="Trimestre" shortName="Trimestre" /> <locale locale="es" label="Trimestre" shortName="Trimestre" /> <locale locale="pt" label="Trimestre" shortName="Trimestre" /> <locale locale="nl" label="Kwartaal" shortName="Kwartaal" /> <locale locale="ja" label="四半期" shortName="四半期" /> </locales> <stratum code="month" label="Month" shortName="Month" id="1" isDefault="1"> <locales> <locale locale="en" label="Month" shortName="Month" /> <locale locale="de" label="Monat" shortName="Monat" /> <locale locale="fr" label="Mois" shortName="Mois" /> <locale locale="es" label="Mes" shortName="Mes" /> <locale locale="pt" label="Ms" shortName="Ms" /> <locale locale="nl" label="Maand" shortName="Maand" /> <locale locale="ja" label="月" shortName="月" /> </locales> </stratum> </stratum> </stratum>
é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 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 message
Nom du marqueur
messages
Description
Conteneur pour un ou plusieurs éléments de message.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de message.
élément de message
Nom du marqueur
message
Description
Représente un message renvoyé par le système à l’appelant. Les messages sont utilisés pour envoyer des messages d’erreur lorsque les demandes échouent, pour envoyer des messages d’avertissement lorsque les demandes réussissent et pour les messages de confirmation lorsque les demandes réussissent.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
clé
N
Lorsqu’elle est fournie, une clé est un moyen de repérer un message ou un type de message particulier, ce qui est utile à des fins d’enregistrement automatique d’erreurs et de récupération dans les programmes clients. Les clés ne changent pas selon les paramètres régionaux des demandes, même lorsque la langue du message change. Il est également improbable que les clés changent à l’avenir en raison d’ajustements de formulation ou de changements de terminologie.
invalid-attributevalueid
Contenu de l'élément
Le texte du message. Ce texte est dans la langue des paramètres régionaux indiqués dans la demande (en supposant que les paramètres régionaux sont pris en charge). Le texte peut également contenir des renseignements variables, tels que le nombre de rangées traitées, ou la colonne ou la valeur particulière qui a causé une erreur.
élément de sortie
Nom du marqueur
sortie
Attributs de l'élément
(aucun)
Contenu de l'élément
Un seul élément de temps requis. 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 de temps
Nom du marqueur
temps
Description
Conteneur pour un élément de strate racine, zéro ou un élément de solde initial et un ou plusieurs éléments de période de strate racine.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
isCustom
Y
1 ou 0, indiquant si le calendrier de cette instance a été personnalisé ou non.
1
q1FirstMonth
N
Mois de début de l’exercice (en partant de 0). Cet attribut ne s’affiche que si la valeur de IncludeLegacyInformation était de 1 dans la demande et si la valeur de isCustom est de 0.
8
lastMonthIsFY
N
Indique si l’exercice est équivalent à l’année civile dans laquelle l’exercice se termine. Cet attribut apparaît uniquement lorsque la valeur de IncludeLegacyInformation était de 1 dans la demande et si la valeur de isCustom est de 0.
0
seqNo
Ajouté dans l'API v17, mais réservé pour une utilisation future.
Contenu de l'élément
Un ou plusieurs éléments de strate, zéro ou un élément de solde initial et un ou plusieurs éléments de période de strate racine.
élément de strate
Nom du marqueur
stratum
Description
Représente une strate du calendrier renvoyé par l'appel d'API exportTime.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
code
Y
Identifiant unique défini par l’utilisateur pour la strate de temps.
An
label
Y
Un identifiant de texte défini par l’utilisateur non unique pour la strate de temps.
Exercice
shortName
Y
Identifiant de texte défini par l’utilisateur non unique utilisé lorsqu’un nom plus court est souhaité. Si un nom abrégé n'est pas défini, l'étiquette sera affichée ici.
Année
identifiant
Y
Identifiant de nombre entier unique généré par le système pour la strate de temps.
7
inUse
Pris en charge dans l'API v16 +
N
Indicateur indiquant si une feuille cube ou une feuille modélisée est associée à la strate de temps, ou s’il s’agit de la strate de temps par défaut.
1
isDefault
Pris en charge dans l'API v16 +
N
Indicateur indiquant si la strate de temps est la strate par défaut ou non.
1
Contenu de l'élément
Zéro ou un élément de paramètres régionaux. Ceci n’est inclus que si l’option IncludeAll Locales est définie.
Zéro ou un élément de strate. Chaque strate, à l’exception de la feuille, a exactement un élément de strate. L'élément de strate feuille ne contient aucun élément de strate.
élément du solde initial
Nom du marqueur
solde initial
Description
Représente la dernière période de feuille avant le début de la version renvoyée en réponse à un appel d'API exportTime. Ceci n’est inclus que si une et une seule version est demandée.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
code
Y
L’identifiant unique défini par l’utilisateur pour la période de solde initiale.
12/2003
label
Y
L’identifiant de texte non unique défini par l’utilisateur pour la période de solde initiale.
Dec-2003
nom abrégé
Y
L’identifiant de texte court non unique défini par l’utilisateur pour la période de solde initiale. Si aucun nom abrégé n’a été défini, l’étiquette est affichée.
Déc.
stratumId
Y
Identifiant de la strate à laquelle appartient le solde initial.
1
timeslot
Y
Le créneau horaire de la période à laquelle appartient le solde initial.
47
encodedTimePeriod
Y
Données encodées pour la période temporelle, au format structId::timeslot.
1::47
identifiant
Y
L’identifiant entier unique généré par le système pour la période de solde initiale.
47001
début
Y
Date de début (incluse) du solde initial, sous la forme AAAA-MM-JJ.
2003-12-01
fin
Y
Date de fin (exclusive) du solde initial, sous la forme AAAA-MM-JJ.
2004-01-01
legacyReportTimeId
N
Identifiant de rapport qui aurait été affiché pour cette période dans des versions antérieures de cette API. Cet attribut apparaît uniquement lorsque la valeur de IncludeLegacyInformation était de 1 dans la demande et si la valeur de isCustom est de 0.
200312
legacySheetTimeId
N
L'identifiant de la feuille de temps qui aurait été utilisé pour cette période dans des versions antérieures de cette API. Cet attribut apparaît uniquement lorsque la valeur de IncludeLegacyInformation était de 1 dans la demande et si la valeur de isCustom est de 0.
48, Q63 ou Y72
Contenu de l'élément
Zéro ou un élément de
paramètres régionaux
.
Élément de la période
Nom du marqueur
période
Description
Représente une seule période temporelle civile renvoyée par l'appel d'API exportTime.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
code
Y
Un identifiant unique défini par l’utilisateur pour la période temporelle.
Q1-2004
label
Y
Un identifiant de texte défini par l’utilisateur non unique pour la période.
Q1-FY04
shortName
Y
Identifiant de texte défini par l’utilisateur non unique utilisé lorsqu’un nom plus court est souhaité. Si un nom abrégé n'est pas défini, l'étiquette sera affichée ici.
T1
stratumId
Y
Identifiant de la strate à laquelle appartient la période.
2
identifiant
Y
L'identifiant entier unique généré par le système pour la période temporelle.
16002
début
Y
Date de début (incluant) de la période temporelle, sous la forme AAAA-MM-JJ.
2004-01-01
fin
Y
Date de fin (exclusive) de la période temporelle, sous la forme AAAA-MM-JJ.
2004-04-01
legacyReportTimeId
N
Identifiant de rapport qui aurait été affiché pour cette période dans des versions antérieures de cette API. Cet attribut apparaît uniquement lorsque la valeur de IncludeLegacyInformation était de 1 dans la demande et si la valeur de isCustom est de 0.
200491
legacySheetTimeId
N
L'identifiant de la feuille de temps qui aurait été utilisé pour cette période dans des versions antérieures de cette API. Cet attribut apparaît uniquement lorsque la valeur de IncludeLegacyInformation était de 1 dans la demande et si la valeur de isCustom est de 0.
48, Q63 ou Y72
Contenu de l'élément
Zéro ou un élément de paramètres régionaux.
Élément des paramètres régionaux
Nom du marqueur
paramètres régionaux
Description
Conteneur pour un ou plusieurs éléments
régionaux
.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments régionaux.
élément régional
Nom du marqueur
paramètres régionaux
Description
Description des paramètres régionaux. Notez que le texte suivra les règles de remplacement des paramètres régionaux.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
paramètres régionaux
Y
Le code des paramètres régionaux.
fr
label
Y
L’étiquette localisée de la période ou de la strate de temps
FY2016
shortName
Y
Le nom abrégé localisé de la période ou de la strate de temps.
2016
Contenu de l'élément
(aucun)