exportData
Catégorie
| Récupération des données |
Description
| Renvoie un ensemble de données de la version demandée dans l'instance de demande. |
Autorisations requises pour appeler
| Aucun (doit être des identifiants valides pour l'instance) |
Paramètres obligatoires à la demande
| Identifiants, 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 spécifiée et les valeurs de renvoi 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 depuis Adaptive Planning et elle peut être utilisée pour extraire des valeurs de n'importe quel compte, y compris des comptes standard, des comptes GL, des comptes modèles, des comptes cubes, des comptes personnalisés, des comptes métriques, des hypothèses et des taux de change.
Si vous exportez une version de plan, votre export inclura les données de montants réels pour toutes les périodes de superposition des montants réels. Vous verrez les données de montants réels ou de plan de la même manière que dans l'interface utilisateur des feuilles.
Les valeurs de chaque subdivision sont agrégées lorsqu'elles sont exportées par
exportData.
Pour API v16 et supérieure :
exportData
exporte également les données pour les versions virtuelles.Voir customReportValuespour une approche plus ciblée de la récupération des données.
Voir Référence : performance de exportData pour savoir comment garantir que vos demandes tirent parti des améliorations en matière de performance et d'évolutivité publiées dans la version 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 :
- appel
- identifiants
- version
- format
Une demande peut également contenir l'un des éléments suivants :
- filtres
- comptes > compte
- périmètres > périmètre
- dimensionValues > dimensionValue
- timeSpan
- dimensions > dimension
- règles > devise
élément d'appel
| |||
Nom du marqueur
| appel | ||
Description
| Indique quelle méthode API 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 | O | La méthode appelée. | exportData |
callerName | O | Chaîne qui identifie votre application client. | "exemple d'application client Adaptive Planning" |
flux
Disponible dans API v39 et supérieure | N | Permet à exportData de commencer à transmettre en continu les données au client dès qu'elles sont traitées. Cette valeur est définie par défaut sur false (faux). Notez que l'activation de la transmission en continu dans exportData nécessite de modifier le format de réponse. | vrai |
Contenu de l'élément
| |||
Totale un élément de chacun des types suivants :
| |||
é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 des actions dans le système montre que cet utilisateur a effectué l'action) et donc que l'utilisateur doit avoir les autorisations requises pour effectuer l'action pour que l'appel d'API réussisse ...
L'autorisation Fonctionnalités d'exportation de l'interface utilisateur Planning n'affecte pas exportData. | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
login | 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 |
locale | 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 indiqué dans les identifiants a accès à plusieurs instances d'Adaptive Planning, cet attribut peut être utilisé pour indiquer qu'il a l'intention d'accéder à une instance différente de 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 de version
| |||
Nom du marqueur
| version | ||
Description
| Indique quelle version doit être utilisée pour extraire les données demandées. Une version doit être indiquée pour chaque appel. | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
nom | N | Nom de la version à utiliser pour recevoir les données. Une seule version peut être accessible dans un même appel d'API. Si un nom n'est pas fourni, l'indicateur isDefault doit être défini sur true (vrai) sur 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 sur true (vrai), auquel cas l'attribut de nom du marqueur (s'il est présent) est ignoré. Sinon, si cette valeur est "faux" 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 fonctionne. | false |
Contenu de l'élément
| |||
(aucun) | |||
élément de format
| |||
Nom du marqueur
| format | ||
Description
| Indique le type de formatage qui doit être utilisé dans chaque champ des données à renvoyer. | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
useInternalCodes | O | Définissez sur "vrai" pour que les codes de compte et de périmètre soient émis en utilisant les codes de chacun des éléments saisis dans les administrateurs de comptes et de périmètres. Définissez sur "faux" pour que les codes soient mappés dans les données de sortie à l'aide de l'option Exporter les mappages de comptes ou Exporter les mappages de périmètres dans l'onglet Exportation. | vrai |
useIds | N | Définis sur "vrai" pour que les comptes, les périmètres et les dimensions soient exprimés dans leurs réponses, au lieu de leurs codes. De plus, les comptes, périmètres et dimensions de la section ` ` doivent être indiqués dans leurs identifiants. Par défaut, est "faux" si il n'est pas présent dans la demande. | vrai |
includeUnmappedItems | N | Cet attribut s'applique uniquement si useInternalCodes a la valeur false (faux) et que des mappages d'export sont utilisés. Si aucune autre option n'est spécifiée, les éléments pour lesquels aucun mappage d'exportation est activé dans l'onglet Exportation ne seront pas émis dans la sortie. Si includeUnmappedItems est défini sur "true", alors les comptes ou périmètres qui n'ont pas de mappage d'export seront émis, en utilisant leurs codes internes (ceux définis dans Administration de comptes ou de périmètres) comme codes, ce qui donnera un résultat d'éléments mappés et non mappés dans le données, mais un ensemble complet de données. Si cet indicateur est paramétré sur "faux", certains articles demandés peuvent ne pas être émis, si ces articles ne sont associés à aucun mappage d'exportation. | false |
includeCodes | N | Cette option n'a de sens que lorsque le paramètre Activer le nom d'affichage en vigueur est activé. Définissez sur "vrai" pour inclure la colonne de code du périmètre dans la réponse de l'API. Définissez sur "faux" pour exclure la colonne de code du périmètre dans la réponse de l'API. La valeur par défaut est false (faux). | false |
includeNames
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage. | N | Cette option n'a de sens que lorsque le paramètre Activer le nom d'affichage en vigueur est activé. Définissez "vrai" pour inclure la colonne de nom du périmètre dans la réponse de l'API. Sélectionnez "faux" pour exclure la colonne de nom du périmètre dans la réponse de l'API. La valeur par défaut est false (faux). | false |
includeDisplayNames
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage. | N | Cette option n'a de sens que lorsque le paramètre Activer le nom d'affichage en vigueur est activé. Définissez "vrai" pour inclure la colonne du nom d'affichage du périmètre dans la réponse de l'API. Indiquez "faux" pour exclure la colonne du nom d'affichage pour le périmètre dans la réponse de l'API. La valeur par défaut est false (faux). | false |
displayNameEnabled
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage. | N | displayNameEnabled=true indique que l'API exportData requiert l'attribut code dans la demande pour spécifier les entités de périmètre et de dimension lorsque l'option Activer le nom d'affichage est activée pour l'instance. displayNameEnabled=false indique que l'API exportData continue de suivre le contrat API pré-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 périmètre et dimension, les valeurs d'attribut de nom et de code doivent correspondre. La valeur par défaut pour displayNameEnabled est "faux". | false |
Contenu de l'élément
| |||
(aucun) | |||
éléments de filtre
| |
Nom du marqueur
| filtres |
Description
| Contient la spécification des filtres qui déterminent quelles données de la version demandée sont extraites par l'API. Cet élément indique les comptes, périmètres, mois et valeurs de dimension qui seront extraits. |
Attributs de l'élément
| |
(aucun) | |
Contenu de l'élément
| |
Un seul élément account obligatoire, un seul élément périmètre facultatif, un seul élément timeSpan obligatoire et un seul élément dimensionValues facultatif. | |
élément 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
| account | ||
Description
| Indique un compte dont les données doivent être exportées dans l'appel d'API exportData. Si plusieurs éléments de compte sont placés dans l'élément comptes, tous les comptes qui correspondent à l'un de ces éléments seront exportés. Si un élément de compte donné ne renvoie aucun compte qui lui correspond, cet élément est ignoré et les autres éléments s'appliquent toujours. | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
code | O | Le code du compte à exporter. Ce code est tel qu'il est indiqué dans Administration des comptes. | Current_Assets |
isAssumption | O | Indique si le code spécifie un compte d'hypothèse ou un compte autre que d'hypothèse. Vous pouvez utiliser un seul code pour une hypothèse et un compte. Utilisez cet indicateur pour indiquer le type de compte. | false |
includeDescendants | O | Indique si l'export doit inclure ou non tous les descendants du compte spécifié. Si la valeur est activée, tous les enfants de ce compte seront exportés, de même que leurs enfants, etc., etc. Si la valeur est false (faux), ce compte sera exporté en tant que valeur de compte d'agrégat unique. | vrai |
Contenu de l'élément
| |||
(aucun) | |||
élément périmètres
| |
Nom du marqueur
| périmètre(s) |
Description
| Conteneur pour un ou plusieurs éléments de périmètre. |
Attributs de l'élément
| |
(aucun) | |
Contenu de l'élément
| |
Un ou plusieurs éléments de périmètre. Si la demande inclut des périmètres inaccessibles, il n'y aura qu'un seul élément de périmètre qui représente le niveau supérieur de l'organisation. | |
élément de périmètre
| |||
Nom du marqueur
| level | ||
Description
| Indique un périmètre d'organisation dont les données doivent être exportées dans l'appel d'API exportData. Si plusieurs éléments de périmètre sont placés dans l'élément de périmètres, tous les périmètres indiqués seront exportés. Si un élément de périmètre donné n'a aucun périmètre correspondant dans l'instance, cet élément est ignoré et les autres éléments s'appliquent toujours.
Vous devez filtrer par code plutôt que par nom lorsque toutes les conditions suivantes sont remplies :
| ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
code
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage. | O Le code s'exclut toujours mutuellement avec le nom. Lorsque les deux conditions suivantes s'appliquent, vous devez utiliser uniquement le code :
| Le code du périmètre à exporter. Ce code est indiqué dans l'administration de l'organisation.
Le code est pris en charge uniquement lorsque le paramètre du nom d'affichage pour l'activation du nom d'affichage est activé. | Développement |
nom | O Le nom s'exclut toujours mutuellement avec le code. Lorsque displayNameEnabled="faux" dans l'élément format, vous ne devez utiliser que name. Il s'agit de la valeur par défaut si aucune valeur n'est indiquée. | Le nom du périmètre à exporter. Ce nom est indiqué dans l'administration de l'organisation.
Le nom est pris en charge uniquement pour les demandes API pré-v30 lorsque les paramètres du nom d'affichage effectifs sont désactivés. Lorsque l'API récupère des périmètres en faisant correspondre leur attribut de code à la chaîne de nom incluse dans la demande, l'attribut de nom est traité de manière fonctionnelle comme attribut de code. Pour récupérer les périmètres par nom, les attributs de nom et de code doivent correspondre. | Développement |
isRollup | O | Si ce périmètre a des enfants, isRollup="true" présentera la valeur d'agrégat pour le périmètre (y compris les valeurs de tous ses enfants) et isRollup="faux" présentera uniquement la valeur non catégorisée pour le périmètre (valeurs saisies dans la modification Les données de ce périmètre). Si ce périmètre n'a pas d'enfants, la valeur isRollup doit être définie sur false (faux) (ou être entièrement absente du marqueur). | false |
includeDescendants | O | Indique si l'export doit inclure ou non tous les descendants du périmètre spécifié. Si la valeur est true, tous les enfants de ce périmètre seront également exportés, de même que leurs enfants, etc., etc. Si la valeur est false (faux), ce périmètre sera exporté seul. Notez que ceci est différent de isRollup : isRollup affecte quelle valeur sera sortie pour ce périmètre, tandis que include Descendants indiquera si des descendants doivent également être inclus dans l'export. Si isRollup et includeDescendants sont définis sur true (vrai) et que le périmètre est un périmètre parent, la sortie contient les valeurs des périmètres d'agrégat et de non-agrégat (sans catégorie) pour ce périmètre et chacun de ses descendants. | vrai |
Contenu de l'élément
| |||
(aucun) | |||
élément timeSpan
| |||
Nom du marqueur
| timeSpan | ||
Description
| Indique les périodes à renvoyer dans la réponse. Les périodes comprises entre la plage indiquée (incluse) sont incluses dans la sortie sous forme de colonnes de données distinctes ; elles ne sont ni agrégées, ni agrégées. | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
début | O | Le code de la première période de la plage de périodes dont les données doivent être exportées. La période de début doit être une période feuille. | 01/2015 |
fin | O | Le code de la dernière période de la plage de périodes dont les données doivent être exportées. La période de fin doit être une période feuille. | 03/2015 |
stratum | N | Code de la strate de temps pour les données exportées. Si elles sont indiquées, les périodes de début et de fin doivent appartenir à la strate de temps. La strate de temps doit être égale ou supérieure à celle du compte avec la strate de temps la plus élevée dans la demande. Voir :
Par exemple, pour indiquer une strate de trimestre, tous les comptes doivent avoir la strate de trimestre, d'année ou plus. | month |
Contenu de l'élément
| |||
(aucun) | |||
élément dimensionValues
| |
Nom du marqueur
| dimensionValues |
Description
| Conteneur pour un ou plusieurs éléments dimensionValue. Cet élément est facultatif et ne doit pas apparaître si aucun filtre de valeur 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 ne doivent contenir que des valeurs correspondant à la dimensionValue spécifiée. Plusieurs valeurs de dimensions différentes dans l'élément dimensionValues fonctionnent comme si elles étaient regroupées par leurs dimensions. Les données renvoient si au moins une des valeurs dimensionValues correspond à 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 indique les valeurs de dimension Région=Est, Région=Ouest et Produit=Produit_A, les données doivent correspondre à Région Est ou à Ouest, mais aussi à Produit_A pour pouvoir être exportées.
Vous devez filtrer par code plutôt que par nom lorsque toutes les conditions suivantes sont remplies :
| ||
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
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage. | N | Le code de la valeur de dimension à exporter. L'attribut de code n'a de sens que lorsque le paramètre du nom d'affichage 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 pré-v30 lorsque les paramètres du nom d'affichage effectifs sont désactivés. | US West |
directChildren | N | Si la valeur est true (vrai), l'API exportera les données d'agrégat pour chacun des enfants directs de cette valeur de dimension, mais pas un agrégat pour la valeur en elle-même. En d'autres mots, exportData exportera les valeurs "un niveau inférieur" dans l'arborescence des dimensions à partir de la valeur spécifiée. Si aucune valeur n'est indiquée, la valeur par défaut est false (faux). | false |
sans catégorie | N | Si la valeur est true (vrai), correspond à la valeur "sans catégorie" de la valeur de dimension et non aux valeurs d'aucune de ses valeurs descendantes (le cas échéant). N'a aucun effet sur les valeurs de dimension sans enfants. Si aucune valeur n'est indiquée, la valeur par défaut est false (faux). | vrai |
uncategorizedOfDimension | N | Indiquez uncategorizedOfDimension à la place des attributs dimName/name.
| 15 |
directChildrenOfDimension | N | Indiquez directChilderOfDimension à la place des attributs dimName/name.
| 12 |
id | N | Indiquez id à la place des attributs dimName/name.
| 14 |
Contenu de l'élément
| |||
(aucun) | |||
élément de dimension
| |
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 décomposées, en fonction de la dimension spécifiée. Notez que ce marqueur ne fait pas partie du marqueur de filtre et ne contrôle pas le filtrage : il contrôle combien de lignes sont exportées pour chaque combinaison compte/périmètre. Pour chaque dimension indiquée dans le marqueur de dimension, chaque combinaison de valeurs existante sera exportée sur une ligne de données distincte. Chaque dimension présente dans l'élément dimensions entraîne l'affichage d'une colonne supplémentaire dans la sortie, marquée de ce nom de dimension. | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
nom | O | Nom de la dimension selon laquelle l'export doit être décomposé. Les lignes de données de l'export qui ne peuvent pas être décomposées par dimension ne s'afficheront qu'une seule fois et montreront le nom de la dimension lui-même dans la colonne où apparaîtrait le nom de la valeur de dimension pour cette dimension. | Customer |
Contenu de l'élément
| |||
(aucun) | |||
élément de règles
| |||
Nom du marqueur
| règles | ||
Description
| Indique des règles de sortie supplémentaires qui contrôlent les types de ligne émiss et le mode de rendu des valeurs de champ. | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
includeZeroRows | N | Définissez sur "vrai" pour émettre des lignes même si elles ne contiennent que des zéros ou des espaces vides. Sélectionnez "faux" pour omettre les lignes sans données de la sortie. La valeur par défaut est false (faux). Cette option n'est pas disponible dans l'interface utilisateur de l'application pour les exports qui incluent des dimensions. Pour les appels d'API, Vrai est ignoré lors de l'export de données par dimension. Il n'émettre que des données pour les valeurs de dimension qui contiennent des données. | vrai |
includeRollups Disponible dans API v24 et antérieures. Non disponible dans API v25 et supérieure. | N | Si la valeur est true, les valeurs d'agrégat de tous les comptes et périmètres figurant dans le marqueur de filtres seront incluses en plus des valeurs de leurs descendants. Cet attribut n'affecte pas le comportement des dimensions personnalisées indiquées dans les filtres dimensionValue ou dans le marqueur de dimension. La valeur par défaut est false (faux). L'indicateur includeRollups s'applique uniquement lorsqu'aucun filtre explicite n'est appliqué aux comptes ou aux périmètres. Si des comptes individuels sont inclus dans un filtre, vous devez spécifier les comptes d'agrégat individuels si vous voulez qu'ils soient inclus. | false |
includeRollupAccounts Disponible dans API v25 et supérieure. | N | Si la valeur est true (vrai), les valeurs d'agrégat de tous les comptes dans le marqueur de filtres seront incluses en plus des valeurs de leurs descendants. Cet attribut n'affecte pas le comportement des dimensions personnalisées indiquées dans les filtres dimensionValue ou dans le marqueur de dimension. La valeur par défaut est false (faux). | false |
includeRollupLevels Disponible dans API v25 et supérieure. | N | Si la valeur est true (vrai), les valeurs d'agrégat de tous les périmètres dans le marqueur de filtres seront incluses en plus des valeurs de leurs descendants. Cet attribut n'affecte pas le comportement des dimensions personnalisées indiquées dans les filtres dimensionValue ou dans le marqueur de dimension. La valeur par défaut est false (faux). | false |
markInvalidValues | N | Si la valeur est true (vrai), l'export ajoutera la lettre "I" aux valeurs non valides. Sinon, ajoute "=NA()" aux valeurs non valides pour qu'elles soient compatibles avec Excel. La valeur par défaut est false (faux). | false |
markBlanks Mis à jour dans API v24. | N | Si la valeur est true (vrai), les valeurs vides seront affichées avec la mention "B". Sinon, les valeurs vides seront affichées sous la forme de zéros. La valeur par défaut est false (faux). Lorsque includeZeroRows=faux, les lignes associant uniquement des espaces vides et des zéros ne seront pas affichées dans la réponse, même si MarkBlank=true. | false |
timeRollups | N | Comprend trois valeurs possibles : vrai, faux et unique. Si la valeur est true (vrai), les agrégats de trimestres et d'années apparaîtront à leur place dans le cadre des mois exportés. Les agrégats de trimestres apparaissent immédiatement après l'agrégat de trimestres et les agrégats d'exercices apparaissent immédiatement après l'agrégat de trimestres de leur dernier trimestre. Si la valeur est définie sur unique, aucun mois, trimestre ou année particulier n'est renvoyé, et seul un agrégat de temps de tous les mois couverts dans l'élément d'intervalle de temps est renvoyé. Si la valeur est false (faux), seuls les mois individuels sont renvoyés, sans colonnes d'agrégat de temps. La valeur par défaut est false (faux). | false |
Contenu de l'élément
| |||
Un élément de devise facultatif pour indiquer la devise à utiliser dans l'export. | |||
élément de devise
| |||
Nom du marqueur
| devise | ||
Description
| Indique quelle devise doit être utilisée dans la sortie lors de l'émission des valeurs de comptes de devise. | ||
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 useCode est défini sur true (vrai), cela indique que la "devise de l'entreprise" (la devise figurant en haut de l'arborescence de l'organisation) doit être utilisée. La valeur par défaut est false (faux). | false |
useLocal | N | Un seul des trois attributs peut être défini pour un élément de devise. Si use Local est défini sur true (vrai), cela indique que les valeurs de devise doivent être émises dans la devise du périmètre de l'organisation où elles résident. Chaque ligne de la sortie indique un niveau de l'organisation et les valeurs de devise de cette ligne sont indiquées dans la devise de ce niveau. La valeur par défaut est false (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, alors le code de devise à trois lettres de l'une des devises configurées pour l'instance doit être indiqué. Le cas échéant, tous les montants en devise de l'export seront convertis dans cette devise. | AUDIA |
Contenu de l'élément
| |||
(aucun) | |||
Les éléments ci-dessous permettent aux utilisateurs (avec les autorisations appropriées) de demander des exports pour des agrégats de temps arbitraires. Ces éléments nécessitent des demandes utilisant un API v40 ou supérieure.
tempsélément
| |||
Nom du marqueur
| time | ||
Description
| Contient le calendrier XML qui doit être utilisé pour mapper les périodes lors de l'export des données. Elle doit être au format simplifié du XML de temps produit dans le fichier exportTime API. Les périodes incluses dans cette section doivent correspondre à l'élément d'intervalle de temps du filtre. Cet élément est UNIQUEMENT requis lorsque l'utilisation du calendrier d'agrégat arbitraire est utilisée.
Uniquement disponible dans API v40 et supérieure | ||
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.
Uniquement disponible dans API v40 et supérieure | ||
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 |
id | O | Identifiant 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 civile.
Uniquement disponible dans API v40 et supérieure | ||
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 |
stratumId | O | Identifiant de la strate à laquelle appartient la période. | 2 |
timeslot | O | Le créneau horaire de la période. | 16 |
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-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 la réponse
Format de réponse (non continu)
<?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 la transmission
<?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 en continu et autres demandes en continu. Par exemple, l'élément de message et le statut apparaissent 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 | 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 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 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 |
Description
| Contient les données résultant de l'exportation dans un bloc CDATA joint. |
Attributs de l'élément
| |
(aucun) | |
Contenu de l'élément
| |
Un bloc CDATA contenant les données de l'export au format CSV. Les lignes sont séparées par des caractères de nouvelle ligne. La première ligne des données renvoyées est l'ensemble des "en-têtes de colonne" décrivant le format de chacune des lignes suivantes. Les dimensions et éléments de filtrage sont répertoriés en premier, suivis de la série de valeurs de période demandée. Les codes de période et les libellés générés par le système, tels que le suffixe "(Agrégat)" dans les périmètres d'agrégat, sont traduits dans la mesure du possible. Les valeurs sont émises dans un format normalisé, sans virgule, en utilisant le point 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 lignes (uniquement pour les demandes en continu) | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
réussite | O | "vrai" ou "faux". Il indique si la demande s'est terminé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 UNIQUEMENT dans les demandes en continu. | "true" |
rowCountSent | O | r"\d+". Représente la valeur numérique du nombre de lignes dans la réponse. | "10" |