exportData

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 : 2025-01-10

exportData

Catégorie	Extraction de données
Description	Renvoie un ensemble de données de la version demandée dans l’instance de la demande.
Autorisations obligatoires pour pouvoir être appelées	Aucun (doit être un identifiant valide pour l’instance)
Paramètres requis sur demande	Données d’identification, version, format, filtres

La demande de cette méthode contient les paramètres qui seront utilisés pour rechercher les données dans la version indiquée et renvoyer les valeurs qui correspondent aux filtres et au format demandés. Il s’agit de la méthode de base utilisée pour extraire des données de Adaptive Planning et peut être utilisée pour extraire des valeurs de n’importe quel compte, y compris des comptes standard, des comptes GL, des comptes modélisés, des comptes cubes, des comptes personnalisés, des comptes d’indicateurs, des hypothèses et des taux de change.

Si vous exportez une version de plan, votre exportation inclura les données des chiffres réels pour toutes les périodes de superposition des chiffres réels. Vous verrez les chiffres réels ou les données du plan comme vous le feriez dans l’interface utilisateur des feuilles.

Les valeurs de fractionnements individuels sont agrégées lorsqu'elles sont exportées par

exportData.

Pour l’API v16 et au-delà,

exportData

Exporte également des données pour les versions virtuelles.

Voir : customReportValuespour cibler une approche plus ciblée de la récupération des données.

Voir : Référence : exportDataPerformance pour savoir comment vous assurer que vos demandes tirent parti des améliorations de performance et d’extensibilité publiées dans 2024R1 pour l’API v39.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportData" callerName="a string that identifies your client application" stream="true">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
<version name="Budget 2014" isDefault="false"/>
<format useInternalCodes="true" includeUnmappedItems="false" />
<filters>
<accounts>
<account code="A100" isAssumption="true" includeDescendants="false"/>
<account code="L100" isAssumption="false" includeDescendants="true"/>
</accounts>
<levels>
<level name="Development" isRollup="true" includeDescendants="true"/>
<level name="QA" isRollup="false" includeDescendants="false"/>
</levels>
<dimensionValues>
<dimensionValue dimName="Customer" name="A Corp" directChildren="true"/>
<dimensionValue dimName="Region" name="" uncategorized="true" directChildren="false"/>
</dimensionValues>
<timeSpan start="11/2013" end="12/2014"/>
</filters>
<dimensions>
<dimension name="Product"/>
<dimension name="CountryRegion"/>
</dimensions>
<rules includeZeroRows="false" includeRollups="false" markInvalidValues="false" markBlanks="false" timeRollups="single">
<currency useCorporate="false" useLocal="false" override="AUD"/>
</rules>
</call>

Chaque invocation de cet appel d’API doit contenir exactement un élément de chacun des types répertoriés :

téléphoner

données d'identification

version

format

Une demande peut également contenir l’un des éléments suivants :

filtres

comptes > compte

niveaux > niveau

dimensionValues > dimensionValue

timeSpan

dimensions > dimension

règles > devise

élément d'appel
Nom du marqueur		téléphoner
Description		Indique la méthode API qui est appelée à l'aide de son attribut de méthode.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
méthode	Y	La méthode appelée.	exportData
callerName	Y	Une chaîne qui désigne votre application client.	"exemple d’application client Adaptive Planning"
flux Disponible dans l'API v39+	N	Permet à exportData de commencer à renvoyer les données au client dès qu’elles sont traitées. Par défaut, cette valeur est définie à Faux. Notez que l’activation de la diffusion dans exportData nécessite des modifications du format de la réponse.	true
Contenu de l'élément
Un élément de chacun des types suivants : données d'identification version format

é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 réussisse. .. L'autorisation Fonctionnalités d'exportation dans l'interface utilisateur Planning n'affecte pas exportData.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
login	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
locale	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 indiquer 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 de version
Nom du marqueur		version
Description		Indique la version à utiliser pour récupérer les données demandées. Une version doit être fournie pour chaque appel.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	N	Le nom de la version à utiliser pour recevoir les données. Une seule version est accessible dans un seul appel d'API. Si aucun nom n'est fourni, l'indicateur isDefault doit être défini à Vrai pour cet élément.	Budget 2014
isDefault	N	Si l’appelant souhaite accéder à la version par défaut actuelle de l’instance, quel que soit son nom, cet attribut peut être défini à Vrai; auquel cas l’attribut de nom du marqueur (s’il est présent) est ignoré. Sinon, si cette valeur est fausse ou si cet attribut n’est pas présent, une version avec le nom fourni doit exister et être accessible à l’utilisateur pour que cet appel réussisse.	false
Contenu de l'élément
(aucun)

élément de format
Nom du marqueur		format
Description		Indique le type de mise en forme à utiliser dans chacun des champs des données à retourner.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
useInternalCodes	Y	Réglez à Vrai pour que les codes de compte et les codes de niveau soient émis en utilisant les codes pour chacun des éléments entrés dans les administrateurs de compte et de niveau. Définissez la valeur à « faux » pour que les codes soient mappés dans les données de sortie à l’aide des mappages de comptes d’exportation ou des mappages de niveaux d’exportation qui se trouvent dans l’onglet Exporter.	true
useIds	N	Réglez à « Vrai » pour que les comptes, les niveaux et les dimensions des réponses soient exprimés sous forme d’identifiants, plutôt que de codes. En outre, il faudra que les comptes, les niveaux et les dimensions de la section `` soient exprimés dans leurs identifiants. Par défaut, la valeur est « Faux » si elle n’est pas présente dans la demande.	true
includeUnmappedItems	N	Cet attribut s'applique uniquement si la valeur de UseInternalCodes est fausse et si des mappages d'exportation sont utilisés. Si aucune valeur n'est précisée, les éléments qui n'ont pas de mappage d'exportation dans l'onglet Exporter ne seront pas émis dans la sortie. Si la valeur de IncludeUnmappedItems est « true », les comptes ou les niveaux qui n’ont pas de mappage d’exportation seront émis en utilisant leurs codes internes (ceux définis dans l’administration du compte ou du niveau) comme codes, ce qui créera un mélange d’éléments mappés et non mappés dans le des données, mais un ensemble complet de données. Si cet indicateur est défini à « false », certains éléments demandés peuvent ne pas être transmis, si ces éléments n’ont pas de mappage d’exportation.	false
includeCodes	N	Cette option n’a de sens que lorsque le paramètre d’activation du nom d’affichage en vigueur est ACTIVÉ. Définissez la valeur à "true" pour inclure la colonne de code pour le niveau dans la réponse d'API. Défini à "false" pour exclure la colonne de code pour le niveau dans la réponse d'API. La valeur par défaut est Faux.	false
includeNames Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	Cette option n’a de sens que lorsque le paramètre d’activation du nom d’affichage en vigueur est ACTIVÉ. Définissez "true" pour inclure la colonne de nom pour le niveau dans la réponse de l'API. Définissez "false" pour exclure la colonne de nom pour le niveau dans la réponse de l'API. La valeur par défaut est Faux.	false
includeDisplayNames Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	Cette option n’a de sens que lorsque le paramètre d’activation du nom d’affichage en vigueur est ACTIVÉ. Réglez à "true" pour inclure la colonne de nom d'affichage pour le niveau dans la réponse de l'API. Définissez "false" pour exclure la colonne du nom d'affichage pour le niveau dans la réponse de l'API. La valeur par défaut est Faux.	false
displayNameEnabled Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	DisplayNameEnabled=true indique que l’API exportData nécessite l’attribut code dans la demande pour préciser les entités de niveau et de dimension lorsque l’option Activer le nom d’affichage est ACTIVÉE pour l’instance. L’attribut DisplayNameEnabled=false indique que l’API exportData continue de suivre le contrat de l’API précédente à la version v30, même lorsque le paramètre Activer le nom d’affichage est ACTIVÉ pour l’instance. L'attribut de nom est utilisé à la place de l'attribut de code. Pour chaque niveau et dimension, les valeurs d’attributs de nom et de code doivent correspondre. La valeur par défaut pour displayNameEnabled est « false ».	false
Contenu de l'élément
(aucun)

Filtres d'élément
Nom du marqueur	filtres
Description	Contient la spécification des filtres qui déterminent quelles données de la version demandée sont récupérées par l’API. Cet élément spécifie les comptes, les niveaux, les mois et les valeurs de dimension qui seront récupérés.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un seul élément Accounts obligatoire, un seul élément Niveaux facultatifs, un seul élément timeSpan obligatoire et un seul élément dimensionValeurs facultatif.

élément des comptes
Nom du marqueur	comptes
Description	Conteneur pour un ou plusieurs éléments de compte.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de compte.

élément de compte
Nom du marqueur		compte
Description		Indique un compte dont les données sont exportées dans l'appel d'API exportData. Si plusieurs éléments de compte sont placés dans l’élément de comptes, tous les comptes qui correspondent à l’un des éléments de compte seront exportés. Si un élément de compte donné ne donne aucun compte correspondant à celui-ci, cet élément est ignoré tant que les autres éléments s’appliquent.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
code	Y	Le code du compte à exporter. Ce code est tel qu'il est indiqué dans la section Administration du compte.	Current_Assets
isAssumption	Y	Indique si le code spécifie un compte d’hypothèse ou un compte non d’hypothèse. Vous pouvez utiliser un code unique à la fois pour une hypothèse et un compte. Utilisez cet indicateur pour indiquer le type de compte.	false
includeDescendants	Y	Indique si l'exportation doit inclure ou non tous les descendants du compte précisé. Si la valeur est Vrai, tous les enfants de ce compte seront exportés, tout comme leurs enfants, etc. Si la valeur est fausse, ce compte sera exporté en tant que valeur de compte d'agrégat unique.	true
Contenu de l'élément
(aucun)

élément niveaux
Nom du marqueur	niveaux
Description	Conteneur pour un ou plusieurs éléments de niveau.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de niveau. Si la demande comprend des niveaux inaccessibles, il n’y aura qu’un élément de niveau, qui représentera le niveau supérieur de l’organisation.

élément de niveau
Nom du marqueur		niveau
Description		Indique un niveau d’organisation dont les données doivent être exportées dans l’appel d’API exportData. Si plusieurs éléments de niveau sont placés dans l'élément de niveaux, tous les niveaux indiqués seront exportés. Si aucun élément de niveau donné n’a de niveaux correspondants dans l’instance, cet élément est ignoré alors que les autres éléments s’appliquent. Vous devez filtrer par code plutôt que par nom lorsque vous remplissez toutes les conditions suivantes : L’instance active les métadonnées en double en activant le Nom d’affichage. Nom de l’API v30 ou version ultérieure. La propriété afficherNameEnabled de l’élément de format est vraie.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
code Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	Y Le code est toujours mutuellement exclusif avec le nom. Lorsque ces deux conditions s’appliquent, vous devez utiliser uniquement le code : Le paramètre Activer le nom d'affichage est ACTIVÉ displayNameEnabled="true" dans l'élément de format Sinon, n’incluez pas de code.	Le code du niveau à exporter. Ce code est précisé dans la section Administration de l'organisation. Le code est pris en charge uniquement lorsque le paramètre d'activation du nom d'affichage en vigueur est ACTIVÉ.	Développement
nom	Y Le nom s’exclut toujours mutuellement avec le code. Lorsque DisplayNameEnabled="false" dans l’élément de format, vous devez uniquement utiliser le nom. Il s'agit de la valeur par défaut si elle n'est pas précisée.	Le nom du niveau à exporter. Ce nom est tel qu'il est indiqué dans la section Administration de l'organisation. Le nom est pris en charge uniquement pour les demandes API antérieures à la version 30 lorsque les paramètres d’activation du nom d’affichage sont désactivés. Au fur et à mesure que l’API récupère les niveaux en faisant correspondre son attribut de code à la chaîne de nom incluse dans la demande, l’attribut de nom est fonctionnellement traité comme l’attribut de code. Pour extraire les niveaux par nom, leur nom et leurs attributs de code doivent correspondre.	Développement
isRollup	Y	Si ce niveau a des enfants, isRollup="true" générera la valeur d’agrégat pour le niveau (y compris les valeurs de tous ses enfants) et isRollup="false" générera uniquement la valeur sans catégorie pour le niveau (les valeurs entrées dans Modifier Les données pour ce niveau). Si ce niveau n’a pas d’enfants, isRollup doit être défini à Faux (ou être omis du marqueur).	false
includeDescendants	Y	Indique si l'exportation doit inclure ou non tous les descendants du niveau précisé. Si la valeur est Vrai, tous les enfants de ce niveau seront également exportés, tout comme leurs enfants, etc. S'il est défini à Faux, ce niveau sera exporté seul. Notez que cette valeur est différente de isRollup : isRollup détermine la valeur qui sera la sortie pour ce niveau, tandis qu’inclure les descendants indique si les descendants doivent également être inclus dans l’exportation. Si isRollup et IncludeDescendants sont définis à Vrai et que le niveau est un niveau parent, la sortie contiendra des valeurs pour les niveaux avec agrégat et sans agrégat (sans catégorie) pour ce niveau et chacun de ses descendants.	true
Contenu de l'élément
(aucun)

élément timeSpan
Nom du marqueur		timeSpan
Description		Indique les périodes qui doivent être retournées dans la réponse. Les périodes comprises dans la plage précisée, inclusivement, sont incluses dans la sortie sous forme de colonnes de données distinctes. elles ne sont ni agrégées ni regroupées.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
début	Y	Le code de la première période de la plage de périodes pour exporter les données. La période de début doit être une période de feuille.	01/2015
fin	Y	Le code de la dernière période dans l’intervalle de périodes pour exporter les données. La période de fin doit être une période de feuille.	03/2015
stratum	N	Le code de la strate de temps pour les données exportées. Lorsqu’elles sont précisées, les périodes de début et de fin doivent être comprises dans la strate de temps. La strate de temps doit être supérieure ou égale au compte avec la strate de temps la plus élevée de la demande. Voir : Modifier la strate de temps par défaut. Changer les strates de temps par défaut dans les feuilles cubes et modélisées contenant des données. Par exemple, si vous indiquez une strate de trimestre, tous les comptes doivent avoir la strate de trimestre, d’année ou plus.	mois
Contenu de l'élément
(aucun)

Élément dimensionValeurs
Nom du marqueur	dimensionValues
Description	Conteneur pour un ou plusieurs éléments dimensionValue. Cet élément est facultatif et ne doit pas s'afficher si aucun filtrage de valeurs de dimension n'est souhaité.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un ou plusieurs éléments dimensionValue.

Élément dimensionValue
Nom du marqueur		dimensionValue
Description		Indique que les données exportées doivent uniquement contenir des valeurs correspondant à la dimensionValue indiquée. Plusieurs valeurs de différentes dimensions dans l’élément dimensionValeurs fonctionnent comme si elles étaient regroupées par leurs dimensions. Les données sont retournées si au moins une des valeurs dimensionValeurs correspond dans chaque dimension. Pour dimensionValues au sein de la même dimension, les données peuvent correspondre à n’importe quelle valeur de dimension. Par exemple, si une demande précise les valeurs de dimension Region= East, Region= West et Product= Product_A, les données doivent correspondre à la région East ou West, mais doivent également correspondre au produit Product_A afin de pouvoir être exportées. Vous devez filtrer par code plutôt que par nom lorsque vous remplissez toutes les conditions suivantes : L’instance active les métadonnées en double en activant le Nom d’affichage. Nom de l’API v30 ou version ultérieure. La propriété DisplayNameEnabled de l'élément de format est vraie.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
dimName	N	Le nom de la dimension à laquelle appartient la valeur de dimension (voir l’attribut de nom ci-dessous).	Région
code Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	Code de la valeur de dimension à exporter. L’attribut code n’a de sens que lorsque le paramètre d’activation du nom d’affichage est ACTIVÉ pour l’instance.
nom	N	Nom de la valeur de dimension à exporter. Le nom est pris en charge uniquement pour les demandes API antérieures à la version 30 lorsque les paramètres d’activation du nom d’affichage sont désactivés.	ouest des États-Unis
directChildren	N	Si cette option est définie à Vrai, cette option entraînera l’exportation par l’API de données d’agrégat pour chacun des enfants directs de cette valeur de dimension, mais pas d’un agrégat pour la valeur elle-même. En d'autres termes, cela entraînera l'exportation par exportData des valeurs "un niveau en dessous" dans l'arborescence de la dimension à partir de la valeur indiquée. Si elle n’est pas précisée, la valeur par défaut est Faux.	false
sans catégorie	N	Si la valeur est Vrai, correspond à la valeur "sans catégorie" de la valeur de dimension et non aux valeurs d’une de ses valeurs descendantes (le cas échéant). N’a aucun effet sur les valeurs de dimension sans enfant. Si elle n’est pas précisée, la valeur par défaut est Faux.	true
uncategorizedOfDimension	N	Précisez l’attribut uncategorizedOfDimension au lieu des attributs dimName/name. Si elle est précisée, la valeur de l’attribut doit être un numéro d’identifiant de système interne d’une dimension (et non une valeur de dimension) et le filtre précise que les données doivent être sans catégorie dans cette dimension pour correspondre au filtre. Les attributs directChildren et sans catégorie seront ignorés et supposeront qu'ils sont faux et vrai respectivement. Ignoré si dimName est indiqué.	15
directChildrenOfDimension	N	Précisez directChildrenOfDimension au lieu des attributs dimName. Si elle est précisée, la valeur de l’attribut doit être un numéro d’identifiant de système interne d’une dimension (et non une valeur de dimension) et le filtre spécifie toutes les valeurs de dimension de premier niveau de la dimension. Les attributs directChildren et sans catégorie seront ignorés et supposeront qu'ils sont vrai et faux respectivement. Ignoré si dimName ou uncategorizedOfDimension est indiqué.	12
identifiant	N	Indiquez l’identifiant à la place des attributs dimName/name. Le numéro d'identifiant de système interne de la valeur de dimension à exporter. Doit être indiqué à la place des attributs dimName/name pour indiquer la valeur de la dimension. Pour déterminer les identifiants internes, consultez l’API exportDimensions. Ignoré si dimName, uncategorizedOfDimension ou directChildrenOfDimension est indiqué.	14
Contenu de l'élément
(aucun)

élément de dimensions
Nom du marqueur	dimensions
Description	Conteneur pour un ou plusieurs éléments de dimension.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de dimension.

élément de dimension
Nom du marqueur		dimension
Description		Indique que les données exportées doivent être décomposées, ou tranchees, selon la dimension indiquée. Notez que ce marqueur ne fait pas partie du marqueur des filtres et ne contrôle pas le filtrage : il contrôle plutôt le nombre de rangées exportées pour chaque combinaison compte/niveau. Pour chaque dimension indiquée dans le marqueur de dimensions, chaque combinaison de valeurs existante sera exportée sous forme de ligne de données distincte. Chaque dimension présente dans l’élément dimensions fait également afficher une colonne supplémentaire dans la sortie, étiquetée avec le nom de cette dimension.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	Nom de la dimension selon laquelle l'exportation doit être tranchee. Les lignes de données de l'exportation qui ne peuvent pas être tranchees par la dimension s'afficheront une seule fois et afficheront le nom de la dimension lui-même dans la colonne où figurerait le nom de la valeur de dimension pour cette dimension.	Client
Contenu de l'élément
(aucun)

élément de règles
Nom du marqueur		règles
Description		Indique certaines règles de sortie supplémentaires qui contrôlent les types de rangées émises et la façon dont certaines valeurs de champs seront rendus.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
includeZeroRows	N	Réglez à Vrai pour émettre des rangées même si elles contiennent uniquement des zéros ou des blancs. Défini à "false" pour omettre les rangées sans données de la sortie. La valeur par défaut est Faux. Cette option n’est pas disponible dans l’interface utilisateur de l’application pour les importations qui incluent des dimensions. Pour les appels d'API, la valeur True est ignorée lors de l'exportation des données par dimension. Elle émettrait uniquement des données pour les valeurs de dimension qui contiennent des données.	true
includeRollups Disponible dans l’API v24 et les versions antérieures. Non disponible dans l'API v25+.	N	Si elles sont définies à Vrai, les valeurs d’agrégat pour tous les comptes et niveaux dans le marqueur des filtres seront incluses en plus des valeurs de leurs descendants. Cet attribut n'affecte pas le comportement des dimensions personnalisées spécifiées dans les filtres de dimensionValue ou dans le marqueur de dimensions. La valeur par défaut est Faux. L’indicateur IncludeRollups s’applique uniquement lorsqu’aucun filtrage explicite n’est appliqué pour les comptes ou pour les niveaux. Si des comptes individuels sont inclus dans un filtre, vous devez préciser les comptes d’agrégat individuels si vous voulez qu’ils soient inclus.	false
includeRollupAccounts Disponible dans API v25+.	N	Si elles sont définies à Vrai, les valeurs d'agrégat pour tous les comptes dans le marqueur des filtres seront incluses en plus des valeurs de leurs descendants. Cet attribut n'affecte pas le comportement des dimensions personnalisées spécifiées dans les filtres de dimensionValue ou dans le marqueur de dimensions. La valeur par défaut est Faux.	false
includeRollupLevels Disponible dans API v25+.	N	Si elles sont définies à Vrai, les valeurs d’agrégat pour tous les niveaux dans le marqueur des filtres seront incluses en plus des valeurs de leurs descendants. Cet attribut n'affecte pas le comportement des dimensions personnalisées spécifiées dans les filtres de dimensionValue ou dans le marqueur de dimensions. La valeur par défaut est Faux.	false
markInvalidValues	N	Si la valeur est Vrai, l’exportation ajoutera la lettre « I » aux valeurs non valides. Ajoute Sinon « =NA() » aux valeurs non valides pour les rendre compatibles avec Excel. La valeur par défaut est Faux.	false
markBlanks Mis à jour dans l'API v24.	N	Si la valeur est Vrai, les valeurs en blanc seront générées en tant que « B ». Sinon, les valeurs en blanc seront générées sous forme de zéros. La valeur par défaut est Faux. Lorsque IncludeZeroRows=false, les rangées combinant uniquement des blancs et des zéros ne seront pas générées dans la réponse, même si MarkBlanks=true.	false
timeRollups	N	Trois valeurs possibles : vrai, faux et unique. Si cette option est définie à Vrai, les agrégats de trimestres et d’années s’afficheront à leur place dans l’intervalle de mois exporté. Les agrégats de trimestres apparaissent immédiatement après le dernier mois de leur trimestre et les agrégats d’exercices apparaissent immédiatement après l’agrégat de trimestres pour leur dernier trimestre. Si la valeur est unique, aucun mois, trimestre ou année individuel n’est retourné et un seul agrégat de temps de tous les mois couverts dans l’élément d’intervalle de temps est retourné. Si la valeur est fausse, seuls les mois individuels sont retournés, sans colonne d’agrégat de temps. La valeur par défaut est Faux.	false
Contenu de l'élément
Un élément de devise facultatif pour préciser la devise à utiliser dans l’exportation.

élément de devise
Nom du marqueur		devise
Description		Indique la devise à utiliser dans la sortie lors de l’émission des valeurs des comptes de devises.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
useCorporate	N	Un seul des trois attributs peut être défini pour un élément de devise. Si la valeur de UseCorportate est TRUE, elle indique que la « devise de la société » (la devise en haut de l’arborescence de l’organisation) doit être utilisée. La valeur par défaut est Faux.	false
useLocal	N	Un seul des trois attributs peut être défini pour un élément de devise. Si la valeur de UseLocal est TRUE, cela indique que les valeurs de devises doivent être émises dans la devise du niveau d’organisation où elles se trouvent. Chaque rangée de la sortie indique un niveau d’organisation, et les valeurs de devise de cette rangée seront exprimées dans la devise de ce niveau. La valeur par défaut est Faux.	false
remplacer	N	Un seul des trois attributs peut être défini pour un élément de devise. Si la valeur de remplacement est présente, elle doit spécifier le code de devise à trois lettres de l’une des devises configurées pour l’instance. Si ce champ est précisé, tous les montants en devise de l’exportation seront convertis dans cette devise.	DOLLARS AUSTRALIENS
Contenu de l'élément
(aucun)

Les éléments ci-dessous permettent aux utilisateurs (avec les autorisations appropriées) de demander des exportation pour des agrégats de temps arbitraires. Ces éléments nécessitent des demandes utilisant API v40 et plus.

tempsélément
Nom du marqueur		temps
Description		Contient le calendrier XML à utiliser pour mapper des périodes lors de l’exportation des données. Cela doit être dans un format simplifié du XML de temps produit dans le exportTime API. Les périodes temporelles incluses dans cette section doivent correspondre à l’élément lié à l’intervalle de temps dans le filtre. Cet élément est SEULEMENT obligatoire lorsque vous utilisez le calendrier d'agrégat arbitraire. Disponible uniquement dans API v40 et au-delà
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple

Contenu de l'élément
(aucun)

strateélément
Nom du marqueur		stratum
Description		Représente une strate du calendrier. Disponible uniquement dans API v40 et au-delà
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
identifiant	Y	Identifiant de nombre entier unique généré par le système pour la strate de temps.	7
Contenu de l'élément
(aucun)

périodeélément
Nom du marqueur		période
Description		Représente une seule période temporelle civile. Disponible uniquement dans API v40 et au-delà
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
stratumId	Y	Identifiant de la strate à laquelle la période appartient.	2
timeslot	Y	Le créneau de la période.	16
identifiant	Y	Identifiant de nombre 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-01-01
Contenu de l'élément
(aucun)

Exemple de demande d’agrégat de temps arbitraire
:


<call method="exportData" callerName="test caller api name">
<credentials login="admin@example.com" password="password" locale="en_US" instanceCode="EXAMPLEINST" />
<version name="Budget 2004" isDefault="true" />
<format useInternalCodes="true" includeUnmappedItems="false" useIds="false" />
<rules includeZeroRows="false" includeRollupAccounts="true" includeRollupLevels="false" markInvalidValues="false" markBlanks="false" timeRollups="false">
   <currency useCorporate="false" useLocal="true" />
</rules>
<filters>
   <accounts>
       <account code="70310" isAssumption="false" includeDescendants="true" />
   </accounts>
   <timeSpan start="01/1999" end="06/1999" />
</filters>
<time isCustom="1">
   <stratum code="month" label="Month" shortName="Month" id="1" />
   <period code="01/1999" label="Jan-1999" shortName="Jan" stratumId="1" id="-12001" start="1999-01-01" end="1999-02-01" />
 <period code="02/1999" label="Feb-1999" shortName="Feb" stratumId="1" id="-11001" start="1999-02-01" end="1999-03-01" />
 <period code="03/1999" label="Mar-1999" shortName="Mar" stratumId="1" id="-10001" start="1999-03-01" end="1999-04-01" />
 <period code="04/1999" label="Apr-1999" shortName="Apr" stratumId="1" id="-9001" start="1999-04-01" end="1999-05-01" />
 <period code="05/1999" label="May-1999" shortName="May" stratumId="1" id="-8001" start="1999-05-01" end="1999-06-02" />
 <period code="06/1999" label="Jun-1999" shortName="Jun" stratumId="1" id="-7001" start="1999-06-01" end="1999-07-01" />
</time>
</call>

Format de réponse

Format de réponse pour les absences


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
<message key="warning-invalid-timespan-start">Ignoring start of timespan, which precedes start of version; timsepan start: Nov-2009, version start date: Jan-2014</message>
</messages>
<output><![CDATA[
Account Name,Account Code,Level Name,[01/2014,02/2014,03/2014,04/2014,05/2014,06/2014,07/2014,08/2014,09/2014,10/2014,11/2014,12/2014]
"Benefits",30120,"Engineering (Rollup)",10653.75,10653.75,10653.75,11506.05,11506.05,11506.05,11506.05,11506.05,11506.05,10462.05,10426.05,10426.05
"Furniture",70310,"Engineering (Rollup)",1740.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0
...
]]>
</output>
</response>

Format de réponse pour flux


<?xml version="1.0" encoding="UTF-8"?>
<response>
<output>
<![CDATA[Account Name,Account Code,Level Name,Q1-2004,Q2-2004,Q3-2004,Q4-2004,Q1-2005,Q2-2005
"Current Assets","Current_Assets","Engineering",33.0,33.0,33.0,33.0,33.0,33.0
"Other Assets","Other_Assets","Engineering",41.0,41.0,41.0,41.0,41.0,41.0]]>
</output>
<messages>
<message>Exporting data failed. Retry the export. Contact Support if the export continues to fail. </message>
</messages>
<status success="false" rowCountSent="2"/>
</response>

Notez qu’il y a un changement dans la structure de la réponse pour les demandes avec flux ou sans flux. Par exemple, l’élément de message et le statut surviennent après la sortie.

é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.	true
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.	false
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
(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
Description	Contient les données résultantes de l’exportation dans un bloc CDATA fermé.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un bloc CDATA contenant les données au format CSV de l’exportation. Les rangées sont séparées par des caractères de nouvelle ligne. La première rangée de données retournées est l'ensemble d'un « en-tête de colonne » décrivant le format de chacune des rangées suivantes. Les dimensions et les éléments de filtrage sont présentés en premier, suivis de la série de valeurs de la période temporelle demandée. Les codes de période temporelle et les étiquettes générées par le système, telles que le suffixe « (Rollup) » dans les niveaux d’agrégat, sont traduits dans les paramètres régionaux de la demande, lorsque cela est possible. Les valeurs sont émises sous forme normalisée, sans virgule, en utilisant une période comme séparateur décimal.

élément de statut
Nom du marqueur		status
Description		Contient des informations sur le statut de la demande et du nombre de rangées (SEULEMENT pour les demandes de flux)
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
réussite	Y	"true" ou "false". Il indique si la demande a été traitée avec succès ou non. Même les demandes réussies peuvent contenir des messages d’avertissement. Cela remplace l’attribut dans la réponse SEULEMENT dans les demandes de flux.	"true"
rowCountSent	Y	r"\d+". Représente la valeur numérique du nombre de rangées dans la réponse.	« 10 »

exportCustomerLogo

exportDimensionFamilies

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