exportTime

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

exportTime

Cette API prend uniquement en charge l'utilisateur Concept : règles d'accès dans API v21 et supérieure.

Catégorie	Metadata retrieval
Description	Renvoie les métadonnées de temps pour une version spécifique ou pour toutes les versions si aucune n'est spécifiée.
Autorisations requises pour appeler	Aucun (doit être des identifiants valides pour l'instance)
Paramètres obligatoires à la demande	Identifiants

La demande de cette méthode contient un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant, et un marqueur de version facultatif pour indiquer la version pour laquelle les informations doivent être extraites. Si aucune version n'est spécifiée, la méthode renvoie des informations sur la plage de temps en incluant 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 de temps de la version sous la forme d'une arborescence 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 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)

Élément d'options
Nom du marqueur		Options
Description		Indique les options à utiliser lors de l'exportation des temps.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
includeAllLocales	N	Vous pouvez également exporter toutes les conversions pour chaque strate/période. Si aucune option n'est indiquée, seuls les paramètres régionaux indiqués dans le bloc d'identifiant sont exportés.	"1"
includeLegacyInformation	N	Vous pouvez également créer des attributs supplémentaires contenant des informations de temps existantes. Ces attributs supplémentaires ne seront pas inclus si isCustom = 1	"1"
leafStratumId Prise en charge dans API v16 et supérieure	N	Vous pouvez également indiquer 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, et les périodes appartenant à des strates de temps plus précises que la strate de temps donnée ne seront pas incluses.	"5"
calendarId Prise en charge dans API v33 et supérieure	N	Vous pouvez également indiquer l'identifiant du calendrier/de la hiérarchie à récupérer. Si elle n'est pas précisée, l'API renverra 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 quelle version doit être utilisée pour extraire les données demandées. L'utilisateur doit pouvoir 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 la plage de temps à exporter. Peut être défini sur "tous", "uniquement", ou omis. La valeur par défaut est "unique". Si c'est unique, l'utilisateur doit également indiquer "nom" ou "identifiant". Renvoie la plage de temps de la version unique indiquée et le solde initial de cette version. Si à la fois le nom et l'identifiant sont indiqués, ils doivent faire référence à la même version. Si toutes, renvoyez la plage de temps du minimum au maximum de toutes les versions, y compris la période de solde initiale pour la première strate de la plage de temps du minimum-max. Si tous, alors ne devez pas indiquer le "nom" ou l'identifiant de la version. En cas d'omission, renvoie tous les temps définis. Si vous spécifiez une version unique, l'appel ne passera que si l'utilisateur a accès à la version.	unique
nom	N	Nom de la version à utiliser pour extraire les données. Une seule version peut être accessible dans un même appel d'API. Si aucun nom n'est fourni, un identifiant doit l'être. Si les deux sont données, elles doivent correspondre à la même version.	Budget 2014
id	N	Identifiant de la version à utiliser pour extraire les données. Une seule version peut être accessible dans un même appel d'API. Si l'option est "unique" et qu'aucun identifiant n'est fourni, alors un nom doit être indiqué. Si les deux sont données, elles doivent correspondre à la même version.	3
Contenu de l'élément
(aucun)

Format de la réponse (avec includeAll Locales="0" ou non spécifié)


<?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 includeAll Locales="1")

Normalement, il existe un bloc de paramètres régionaux pour chaque période et strate. Au-dessous, seule la section Strates est affichée. Les tranches de paramètres régionaux des périodes sont de format 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	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 messages
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 que le système renvoie à l'appelant. Les messages sont utilisés pour les messages d'erreur lorsque les demandes n'ont pas abouti, pour les messages d'avertissement lorsque les demandes ont abouti et pour les messages de confirmation lorsque les demandes ont abouti.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
clé	N	Lorsqu'elle est fournie, une clé permet d'identifier un message ou un type de message particulier, utile pour l'enregistrement et la récupération automatisés des erreurs 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 peu probable que les clés changent à l'avenir en raison d'ajustements du libellé ou de la terminologie.	invalid-attributvalueid
Contenu de l'élément
Texte du message. Ce texte est exprimé dans la langue des paramètres régionaux indiqués dans la demande (en supposant que les paramètres régionaux soient pris en charge). Le texte peut également contenir des informations variables telles que le nombre de lignes qui ont été traitées ou la colonne ou la valeur particulière qui a généré 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 obligatoire. 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 temps
Nom du marqueur		time
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	O	1 ou 0, indiquant si le calendrier de cette instance a été personnalisé ou non.	1
q1FirstMonth	N	Le mois à partir duquel débute l'exercice (commence par 0). Cet attribut apparaît uniquement si includeLegacyInformation était 1 dans la demande et si isCustom est 0.	8
lastMonthIsFY	N	Indique si l'exercice correspond à l'année civile dans laquelle se termine l'exercice. Cet attribut apparaît uniquement si includeLegacyInformation était égal à 1 dans la demande et si isCustom est égal à 0.	0
seqNo Ajouté dans l'API v17, mais réservé pour une utilisation future.
Contenu de l'élément
Totalement un élément 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ée par l'appel d'API exportTime.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Identifiant unique défini par l'utilisateur pour la strate de temps.	Année
label	O	Un identifiant de texte non unique défini par l'utilisateur pour la strate de temps.	Exercice :
shortName	O	Identifiant de texte non unique, défini par l'utilisateur, utilisé lorsqu'un nom plus court est souhaité. Si aucun nom abrégé n'est défini, le libellé sera affiché ici.	Année
id	O	Identifiant entier unique généré par le système pour la strate de temps.	7
inUse Prise en charge dans API v16 et supérieure	N	Indicateur indiquant si une feuille cube ou modèle est associée à la strate de temps, ou s'il s'agit de la strate de temps par défaut.	1
isDefault Prise en charge dans API v16 et supérieure	N	Indicateur indiquant si la strate de temps est la strate par défaut ou non.	1
Contenu de l'élément
0 ou un élément paramètres régionaux. Ceci n'est inclus que si l'option includeAllBaseaux 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 de 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 la feuille avant le début de la version renvoyée en réponse à un appel d'API exportTime. Cette option n'est incluse que si une seule version est demandée.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Identifiant unique défini par l'utilisateur pour la période de solde initial.	12/2003
label	O	Identifiant de texte non unique défini par l'utilisateur pour la période de solde initial.	Dec-2003
nom abrégé	O	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, le libellé s'affiche.	Déc.
stratumId	O	Identifiant de la strate à laquelle appartient le solde initial.	1
timeslot	O	Le créneau horaire de la période à laquelle appartient le solde initial.	47
encodedTimePeriod	O	Les données encodées pour la période, au format structureId::timeslot.	1::47
id	O	Identifiant de nombre entier unique généré par le système pour la période de solde initial.	47001
début	O	Date de début (incluse) du solde initial, au format AAAA-MM-JJ.	2003-12-01
fin	O	Date de fin (exclue) du solde initial, au format AAAA-MM-JJ.	2004-01-01
legacyReportTimeId	N	Identifiant du rapport qui aurait été affiché pour cette période dans les anciennes versions de cette API. Cet attribut apparaît uniquement si includeLegacyInformation était égal à 1 dans la demande et si isCustom est égal à 0.	200312
legacySheetTimeId	N	Identifiant de temps de la feuille qui aurait été utilisé pour cette période dans les anciennes versions de cette API. Cet attribut apparaît uniquement si includeLegacyInformation était égal à 1 dans la demande et si isCustom est égal à 0.	48, T63 ou Y72
Contenu de l'élément
0 ou un élément `paramètres régionaux` .

Élément Période
Nom du marqueur		période
Description		Représente une seule période de calendrier renvoyée par l'appel d'API exportTime.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Un identifiant unique défini par l'utilisateur pour la période.	Q1-2004
label	O	Un identifiant de texte non unique défini par l'utilisateur pour la période.	Q1-FY04
shortName	O	Identifiant de texte non unique, défini par l'utilisateur, utilisé lorsqu'un nom plus court est souhaité. Si aucun nom abrégé n'est défini, le libellé sera affiché ici.	T1
stratumId	O	Identifiant de la strate à laquelle appartient la période.	2
id	O	Identifiant entier unique généré par le système pour la période.	16002
début	O	La date de début (incluse) de la période, au format AAAA-MM-JJ.	2004-01-01
fin	O	La date de fin (exclue) de la période, au format AAAA-MM-JJ.	2004-04-01
legacyReportTimeId	N	Identifiant du rapport qui aurait été affiché pour cette période dans les anciennes versions de cette API. Cet attribut apparaît uniquement si includeLegacyInformation était égal à 1 dans la demande et si isCustom est égal à 0.	200491
legacySheetTimeId	N	Identifiant de temps de la feuille qui aurait été utilisé pour cette période dans les anciennes versions de cette API. Cet attribut apparaît uniquement si includeLegacyInformation était égal à 1 dans la demande et si isCustom est égal à 0.	48, T63 ou Y72
Contenu de l'élément
0 ou 1 élément de paramètres régionaux.

Élément de 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 de paramètres régionaux
Nom du marqueur		paramètres régionaux
Description		Description des paramètres régionaux. Notez que le texte respectera les règles de reprise locales.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
paramètres régionaux	O	Le code des paramètres régionaux.	fr
label	O	Libellé localisé pour la période/la strate de temps.	FY2016
shortName	O	Nom abrégé localisé pour la période ou la strate de temps.	2016
Contenu de l'élément
(aucun)

exportSheets

exportTransactionDefinition

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