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

exportConfigurableModelData

Pris en charge dans l'API v19 +
Mis à jour dans l’API v35 (18 novembre 2022).
Catégorie
Extraction de données
Description
Renvoie un ensemble de rangées de la feuille modélisée demandée dans la version et l’instance demandées.
Autorisations obligatoires pour pouvoir être appelées
Accès en lecture à la feuille, à la version et à l’instance demandée.
Paramètres requis sur demande
Données d’identification, feuille modélisée, version, tâche
Vous pouvez flux des données à partir de exportConfigurableModelData pour obtenir de meilleures performances et réduire le nombre de cellules et de rangées que vous pouvez exporter. Pour transmettre des données en flux, vous devez :
  • Utilisez l'API v32 ou une version plus récente.
  • Set isGetAllRows=true.
La demande de cette méthode contient les paramètres qui seront utilisés pour déterminer les rangées modélisées qui seront retournées. L’utilisateur doit avoir un accès en lecture à la feuille, à la version et à l’instance contenant la feuille modélisée.
Bonne pratique : utilisez exportSheets pour récupérer le nom de la feuille modélisée et l’identifiant requis pour votre demande exportConfigurableModelData.

Format de demande

Appel en flux pour récupérer toutes les rangées d’une feuille modélisée :
<?xml version='1.0' encoding='UTF-8'?> <call method="exportConfigurableModelData" callerName="me"> <credentials login="user@example.com" password="password"/> <version name="Budget 2017"/> <modeled-sheet name="Capital Model" isGlobal="false" includeAllColumns="false" isGetAllRows="true" useNumericIDs="false"/> <filters> <timeSpan start="Mar-2016" end="Dec-2017"/> <levels> <level name="Hosting" includeDescendants="true"/> </levels> </filters> </call>
Appel paginé et sans flux :
<?xml version='1.0' encoding='UTF-8'?> <call method="exportConfigurableModelData" callerName="me"> <credentials login="user@example.com" password="password"/> <version name="Budget 2017"/> <job jobNumber="0" pageNumber="1"/> <modeled-sheet name="Capital Model" isGlobal="false" includeAllColumns="false" useNumericIDs="false"/> <filters> <timeSpan start="Mar-2016" end="Dec-2017"/> <levels> <level name="Hosting" includeDescendants="true"/> </levels> </filters> </call>
élément de données d'identification
Nom du marqueur
données d'identification
Description
Tous les appels d’API doivent contenir un élément d’identification unique pour identifier l’utilisateur qui invoque l’API. L’appel d’API est alors effectué en tant que cet utilisateur (toute piste d’audit ou tout historique des actions dans le système indiquera que cet utilisateur a effectué l’action). Par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action afin que l’appel d’API puisse être exécuté réussir.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
ouvrir une session
Y
Le nom de connexion de l’utilisateur qui invoque la méthode API. Cet utilisateur doit disposer des autorisations requises pour invoquer la méthode.
sampleuser@company.com
mot de passe
Y
Le mot de passe de l’utilisateur qui invoque la méthode API.
my_password
Contenu de l'élément
(aucun)
élément de version
Nom du marqueur
version
Description
Indique à partir de quelle version extraire les rangées modélisées.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
Nom
Y
Le nom de la version.
Budget 2
Contenu de l'élément
Contient un ou plusieurs éléments de niveau.
élément de feuille modélisée
Nom du marqueur
modeled-sheet
Description
Indique la feuille modélisée à partir de laquelle extraire les rangées modélisées. Utilise l’identifiant ou le nom de la feuille modèle comme identifiant.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
Nom
Y
Le nom de la feuille modélisée.
Budget de fonctionnement
isGlobal
N
Indique si la feuille est une feuille affectée à un utilisateur ou une feuille affectée à un niveau. Si Vrai, la feuille est une feuille affectée à des utilisateurs. Si la valeur est fausse, la feuille est une feuille affectée à un niveau.
faux
isGetAllRows
Pris en charge dans l'API v32+
N
Indique si la réponse récupère toutes les rangées de la feuille. Si Vrai, toutes les rangées sont retournées sans pagination, et l’élément <Niveaux> devient facultatif, et l’élément <Job> n’est pas pris en charge dans la demande. Doit être vraie pour prendre en charge le flux de données.
vrai
includeAllColumns
Pris en charge dans l'API v22+
N
Indique s’il faut inclure toutes les colonnes dans la réponse. Toute valeur autre que Vrai aura un résultat faux.
faux
useNumericIDs
Pris en charge dans l'API v22+
N
Indique si les identifiants internes de la réponse doivent être au format numérique. Ex. « 
100
« par rapport à »
S100
". S’il est absent ou défini à autre chose que "
true
" (insensible à la casse), il donne
false
.
Exemple d’identifiant de subdivision quand
true
:
  • 271
Exemple d’identifiant de subdivision quand
false
:
  • S271
vrai
displayNameEnabled
Disponible uniquement dans l’API v31+ pour les instances qui activent le nom d’affichage.
N
displayNameEnabled=true indique que exportConfigurableModelData doit respecter les propriétés de nom d'affichage de
code
,
displayNameType
, et
description
lorsque l’option Activer le nom d’affichage est ACTIVÉE pour l’instance.
displayNameEnabled=false indique que l’API exportConfigurableModelData doit continuer à suivre le contrat de l’API antérieure à la version v30, même lorsque l’option Activer le nom d’affichage est ACTIVÉE pour l’instance. L'API exportConfigurableModelData ignore les propriétés
code
,
displayNameType
Et
description
.
La valeur par défaut pour displayNameEnabled est « false ».
faux
includeCodes
Disponible uniquement dans l’API v31+ pour les instances qui activent le nom d’affichage.
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 code pour le niveau et chaque dimension dans la réponse d'API.
Réglez à "false" pour exclure la colonne de code pour le niveau et chaque dimension dans la réponse de l'API.
La valeur par défaut est Faux.
faux
includeNames
Disponible uniquement dans l’API v31+ pour les instances qui activent le nom d’affichage.
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 pour le niveau et chaque dimension dans la réponse de l'API.
Réglez à "false" pour exclure la colonne de nom pour le niveau et chaque dimension dans la réponse de l'API.
La valeur par défaut est Faux.
faux
includeDisplayNames
Disponible uniquement dans l’API v31+ pour les instances qui activent le nom d’affichage.
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 et chaque dimension dans la réponse de l'API.
Réglez à "false" pour exclure la colonne de nom d'affichage pour le niveau et chaque dimension dans la réponse de l'API.
La valeur par défaut est Faux.
faux
useAccountPrecision
Disponible uniquement dans l'API v33+
N
Cette option n’a de sens que lorsque isGetAllRows="true"
Réglez à "true" pour générer des colonnes de nombre à la précision du compte.
Réglez à "false" pour générer des colonnes de nombre avec la précision par défaut quand isGetAllRows="true", ce qui est une précision de 9.
La valeur par défaut est Faux.
faux
useActualValue
Disponible uniquement dans l'API v35+
N
Cette option n’a de sens que lorsque isGetAllRows = "true".
  • Réglez à "true" pour générer des colonnes de nombre avec la valeur réelle.
    • Pour les colonnes numériques modifiables, ce seront les données brutes.
    • Pour les colonnes numériques calculées, il s’agira de la valeur calculée jusqu’à une précision de 9.
  • Réglez à "false" pour générer des colonnes de nombre avec la précision par défaut quand isGetAllRows="true", ce qui est une précision de 9.
La valeur par défaut est Faux.
vrai
Contenu de l'élément
(aucun)
élément d'emploi
Nom du marqueur
job
Description
Indique le numéro de série du gestionnaire d’API pour la tâche d’appel d’API. Cet élément n'est pas pris en charge lorsque la valeur de isGetAllRows est vraie.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
jobNumber
Y
0 pour l’appel initial. Un numéro d’emploi est retourné dans la réponse. Utilisez ce numéro d’emploi pour chaque demande ultérieure.
Le gestionnaire d’API créera ensuite un modèle de feuille qui chargera la feuille en mémoire. La feuille reste en mémoire jusqu’à l’expiration du délai de la demande et jusqu’à la collecte de la mémoire. L’API renvoie ensuite la première page avec les autres paramètres répertoriés ci-dessus.
2
pageSize
N
Remplace la valeur par défaut pagedimension pour permettre à l’utilisateur de l’API de préciser le nombre de rangées par page à récupérer pour chaque appel. Il ne prend effet qu’au premier appel, lorsque jobNumber="0".
L'attribut pagedimensions est ignoré et toutes les données sont retournées dans la première page dans les cas suivants :
  • Si la valeur pagePage indiquée est supérieure au nombre de rangées dans la feuille.
  • Si le nombre de cellules dans la feuille est inférieur ou égal à 20 000.
  • Si le nombre de rangées dans la feuille est inférieur ou égal à 500.
200
pageNumber
Y
Indique le numéro de page demandé s’il existe plus d’une page. L’index des numéros de page commence par « 1 ».
Le gestionnaire d’API est destiné au même utilisateur qui effectue l’appel suivant en utilisant la même API de demande et la même authentification.
La demande ultérieure doit se situer dans les 3 minutes suivant la dernière heure de réponse.
1
Contenu de l'élément
(aucun)
élément de filtre
Nom du marqueur
filtres
Description
Conteneur pour tous les éléments associés aux filtres.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
Contenu de l'élément
Les éléments de niveaux et de colonnes.
élément niveaux
Nom du marqueur
niveaux
Description
Conteneur pour un élément de niveau Indique le niveau à partir duquel extraire les rangées. Cet élément est facultatif lorsque la valeur de isGetAllRows est vraie.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
Contenu de l'élément
Éléments d’un niveau.
élément de niveau
Nom du marqueur
niveau
Description
Indique un niveau selon lequel filtrer la demande.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
nom
Y
Le nom du niveau demandé.
Le nom est pris en charge uniquement pour les demandes antérieures à la version 30 lorsque les paramètres d’activation du nom d’affichage sont désactivés.
Siège social
includeDescendants
N
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 exportés, tout comme leurs enfants, et ainsi de suite. S'il est défini à Faux, ce niveau sera exporté seul.
L'indication de « false » permet d’exporter les niveaux indiqués comme niveau (uniquement) dans la section
Adaptive Planning
interface utilisateur Web.
vrai
code
Disponible uniquement dans l’API v31+ pour les instances qui activent le nom d’affichage.
N
Le code du niveau à exporter. Ce code est tel qu'il est indiqué dans l'administration des niveaux. L'attribut code a été ajouté dans l'API v31.
Utilisez l’attribut de nom pour la demande API antérieure à la version V30 et lorsque le paramètre d’activation du nom d’affichage en vigueur est désactivé.
faux
Contenu de l'élément
Le nom du niveau
élément columns
Nom du marqueur
colonnes
Description
Conteneur pour deux éléments : modèle et système. Les marqueurs modèle et système ont chacun des éléments de colonne enfant qui spécifient le nom de la colonne.
Disponible uniquement dans l'API v33+
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
Contenu de l'élément
Un élément de modèle
élément de modèle
Nom du marqueur
modèle
Description
Indique un ensemble de colonnes de feuille modélisée. Il contient des éléments de colonne enfant.
Disponible uniquement dans l'API v33+
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
Contenu de l'élément
Contient des éléments "column" enfants. Pour les colonnes du modèle, lors de la précision de l’élément lié à l’intervalle de temps, nous utiliserons le nom Intervalle de temps.
élément de système
Nom du marqueur
système
Description
Indique un ensemble de noms de colonnes système. Les options autorisées sont "InternalID", "ParentID" et "IsParent".
Disponible uniquement dans l'API v33+
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
Contenu de l'élément
Contient des éléments "column" enfants.
élément de colonne
Nom du marqueur
column
Description
Indique un nom de colonne de feuille modélisée. Les valeurs spéciales incluent les noms de colonnes système répertoriés ci-dessus et, pour les colonnes modèles, il s’agit du nom de la colonne Intervalle de temps.
Disponible uniquement dans l'API v33+
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
Contenu de l'élément
Un élément de modèle
Exemple de colonnes
<columns> <model> <column>NumberCurrency</column> <column>Regional Code</column> <column>CountryRegion</column> <column>CalcAcctNum</column> <column>Level Currency</column> <column>Invalid Column Name</column> <column>InitialBalance</column> <column>Timespan</column> </model> <system> <column>InternalID</column> <column>Invalid System Column Name</column> <column>IsParent</column> <column>ParentID</column> </system> </columns
élément timeSpan
Nom du marqueur
timeSpan
Description
Si la feuille modèle comporte un élément timeSpan, les valeurs de début et de fin spécifient l’intervalle de temps des données à exporter à partir de la feuille. Si timeSpan n’est pas inclus, les données de l’exportation de l’intervalle de dates complet de la version. Utiliser un code de période interne (Voir Changer la structure du calendrier) ou une étiquette de temps localisée dans la vue de la feuille pour indiquer un début ou une fin timeSpan.
TimeSpan duplique la fonctionnalité des options d’affichage > Paramètres de temps pour les sélections de feuilles de début et de fin pour une feuille modélisée dans le
Adaptive Planning
Interface utilisateur.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
début
N
Le code d’entrée des heures ou l’étiquette d’heure localisée visible dans la feuille de la première période de la plage à exporter. La période de début doit être une période de feuille. Si start n’est pas indiqué, le début de la version est utilisé.
Jan-2016
01/2016
fin
N
Code d’entrée des heures ou étiquette d’heure localisée de la dernière période de la plage à exporter. La période de fin doit être une période de feuille. Si la fin n’est pas indiquée, la fin de la version est utilisée.
Nov-2016
11/2016

exemples d’intervalle de temps

Début janvier 2016 et fin avril 2016. Jan-2016 est le code de période interne indiqué par l’interface utilisateur d’administration des heures. 04/2016 est une étiquette de temps de feuille.
<timeSpan start="Jan-2016 end="04/2016"/>
Début février 2016 et fin à la date de fin de la version. 02/2016 est une étiquette de temps de feuille.
<timeSpan start="02/2016"/>
Commencez par les dates de début et de fin de la version en novembre 2016. Nov-2016 est le code de période interne indiqué par l’interface utilisateur d’administration des heures.
<timeSpan start="" end="Nov-2016"/>

Format de réponse

<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <output> <data jobNumber="3"> <![CDATA["InternalID","Plan","CapitalAssetClass","Label","Price","Currency","Mar-2016","Q1-FY16","Apr-2016","May-2016","Jun-2016","Q2-FY16","Jul-2016","Aug-2016","Sep-2016","Q3-FY16","Oct-2016","Nov-2016","Dec-2016","Q4-FY16","FY2016","Jan-2017","Feb-2017","Mar-2017","Q1-FY17","Apr-2017","May-2017","Jun-2017","Q2-FY17","Jul-2017","Aug-2017","Sep-2017","Q3-FY17","Oct-2017","Nov-2017","Dec-2017","Q4-FY17","FY2017" "S1325","Development","Furniture","Chairs","90","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1326","Development","Furniture","Desks","200","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1327","Development","Computers","EngineerWS","2500","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1328","Development","Computers","ManagerWS","1000","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1323","G & A","Facility","Garage","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1324","G & A","OtherEquipment","CD_Maker","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""]]> </data> </output> </response>
élément de réponse
Nom du marqueur
réponse
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
réussite
Y
Vrai ou faux, indiquant si l’appel d’API a réussi ou non. Même les appels réussis peuvent contenir des messages d’avertissement dans leur réponse.
vrai
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.
Pour la version de flux de l’API (isGetAllRows="true") : lorsque l’API échoue pendant le flux des rangées, nous fermez les marqueurs xml et ajoutons un message :
Exporting configurable model data failed. Retry the export. Contact Support if the export continues to fail.
élément d'emploi
Nom du marqueur
job
Description
Indique l’information sur la tâche et la pagination des données pour les données retournées afin que l’utilisateur puisse passer une série d’appels pour extraire toutes les données du jeu de données filtré à partir de la feuille modèle.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
jobNumber
N
Numéro de série du gestionnaire d’API dédié affecté par le serveur pour la tâche d’appel d’API. Utilisé dans toutes les demandes ultérieures.
2
numberOfPages
N
Nombre total de pages de données disponibles pour l’ensemble de filtres.
3
pageNumber
N
Le numéro de page du jeu de données actuel retourné.
1
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 sortie
Nom du marqueur
sortie
Description
Le marqueur de sortie a un élément enfant, le marqueur de données.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
Niveau
N
Nom du niveau où se trouve cette rangée ou cette subdivision/rangée. Cela s'affiche que le niveau demandé soit un niveau d'agrégat ou non.
Ingénierie
Contenu de l'élément
Un élément de données unique.
Nom du marqueur
Données
Description
La réponse renvoie un bloc CDATA contenant un vide de données au format CSV des rangées modélisées en cours d’exportation. La première rangée du bloc CDATA est la « rangée d’en-tête » du CSV, et toutes les rangées suivantes sont des rangées de données. Si aucune rangée ne correspond à la demande de filtrage, seule la rangée d’en-tête est sortie.
Les colonnes du CSV commencent par un maximum de cinq colonnes internes codées en dur. Ces colonnes peuvent désigner la rangée et certaines de ses propriétés immuables. Les colonnes présentes sur la feuille suivent, peu importe si :
  • L'utilisateur peut les avoir masquées dans ses options d'affichage
  • Les colonnes sont en lecture seule ou non.
Toutes les colonnes de la réponse de l’API sont des colonnes visibles/définies pour la feuille, leur en-tête de colonne déclaré étant leur étiquette dans la rangée d’en-tête. Cela inclut toutes les colonnes d’attributs placées sur la feuille. Pour le compte avec intervalle de temps, les en-têtes de colonnes sont les mois de la version actuelle dans le même format que l’API exportData .
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
totalRowCount
Disponible dans l’API v35+ quand isGetAllRows=true.
N
Cet attribut est ajouté à l'élément de données pour la version de flux de l'API. Indique le nombre total de rangées que la feuille modélisée s’attend à exporter.
"10"
Contenu de l'élément
Un bloc CDATA contenant :
  • Les rangées mises en forme en format CSV valide.
    • Les chaînes sont entre guillemets doubles (“ ”).
    • Les nombres sont émis sous
      forme automatiquement
      (n’est pas un format sensible aux paramètres régionaux). Les virgules sont supprimées
    • Les dimensions et les sélecteurs de texte émettent la valeur sélectionnée qu’ils ont. S’ils n’ont pas de valeur, ils émettent une chaîne vide.
  • Lors de l’émission des rangées parentes, toutes les colonnes fractionnables sont affichées en
    blanc
    dans le CSV (elles ne tentent pas d’afficher des valeurs d’agrégat ou de « divers »).
  • Lors de l’émission de rangées enfants/fractionnées, toutes les colonnes
    non fractionnées
    seront affichées comme contenant la valeur de leur rangée parent. Ce calcul est identique au comportement de la feuille dans l’interface utilisateur Web Adaptive Planning.
Un élément de statut.
Nom du marqueur
statut
Description
Disponible uniquement dans l’API v35+ lors du flux de données (isGetAllRows="true").
Le marqueur de statut est ajouté après le marqueur de sortie pour les cas de réussite et d’échec de la version de flux de l’API.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
réussite
Y
Si toutes les données ont été transmises par flux, il renverra Success= "true" et s’il y a eu une erreur (soit en raison de validations, soit en raison d’un échec avant que toutes les lignes ne soient transmises), il renvoie success ="false".
vrai
rowCountSent
N
Le nombre ou les rangées qui ont été envoyés. S’il s’agit d’une réponse d’échec, ce nombre ne correspond pas à la valeur totalRowCount définie dans l’élément de données.
1
Contenu de l'élément
(aucun)

Retrait du « S » de parentId lorsque UseNumériqueIds =  « true » pour la version de flux de l’API (isGetAllRows=true)

À partir de la version 35 de l’API, parentId ne contiendra plus le préfixe « S » dans sa valeur.

Échap pour les valeurs "in" pour la version de flux de l’API (isGetAllRows=true)

À partir de la version 35 de l’API, toute valeur de colonne contenant un « serera » au format CSV (la « heure » sera donc représentée par « »).

Traitement d’un scénario d’échec pendant la diffusion

En cas d’échec de l’API alors que le flux des rangées est en cours, le système ferme les marqueurs XML et envoie un message d’erreur.
Exporting configurable model data failed. Retry the export. Contact Support if the export continues to fail.
Exemple de réponse
:
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <output> <data> <![CDATA["InternalID","Level","Plan","CapitalAssetClass","Label","Price","Currency","Jan-2010","Feb-2010","Mar-2010","Q1-FY10","Apr-2010","May-2010","Jun-2010","Q2-FY10","Jul-2010","Aug-2010","Sep-2010","Q3-FY10","Oct-2010","Nov-2010","Dec-2010","Q4-FY10","FY2010","Jan-2011","Feb-2011","Mar-2011","Q1-FY11","Apr-2011","May-2011","Jun-2011","Q2-FY11","Jul-2011","Aug-2011","Sep-2011","Q3-FY11","Oct-2011","Nov-2011","Dec-2011","Q4-FY11","FY2011","Jan-2012","Feb-2012","Mar-2012","Q1-FY12","Apr-2012","May-2012","Jun-2012","Q2-FY12","Jul-2012","Aug-2012","Sep-2012","Q3-FY12","Oct-2012","Nov-2012","Dec-2012","Q4-FY12","FY2012","Jan-2013","Feb-2013","Mar-2013","Q1-FY13","Apr-2013","May-2013","Jun-2013","Q2-FY13","Jul-2013","Aug-2013","Sep-2013","Q3-FY13","Oct-2013","Nov-2013","Dec-2013","Q4-FY13","FY2013","Jan-2014","Feb-2014","Mar-2014","Q1-FY14","Apr-2014","May-2014","Jun-2014","Q2-FY14","Jul-2014","Aug-2014","Sep-2014","Q3-FY14","Oct-2014","Nov-2014","Dec-2014","Q4-FY14","FY2014" "S289","HQ","Development","Furniture","Chairs","90","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S290","HQ","Development","Furniture","Desks","200","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S291","HQ","Development","Computers","EngineerWS","2500","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S292","HQ","Development","Computers","ManagerWS","1000","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S287","HQ","G & A","Facility","Garage","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S288","HQ","G & A","OtherEquipment","CD_Maker","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""]]> </data> </output> <messages> <message>Exporting configurable model data failed. Retry the export. Contact Support if the export continues to fail.</message> </messages> </response>

Exemple de réponse avec Status API v35 avec flux (isGetAllRows="true")

<?xml version="1.0" encoding="UTF-8"?> <response> <output> <data totalRowCount="6"> <![CDATA["InternalID","CapitalAssetClass","Price" "S289","Furniture","90" "S290","Furniture","200" "S291","Computers","2500" "S292","Computers","1000" "S287","Facility","" "S288","OtherEquipment",""]]> </data> </output> <status success="true" rowCountSent="6"></status> <messages> <message>System Column names [Invalid System Column Name] specified in the request weren't found and will be ignored.</message> <message>Model Column names [timespan,invalid column name] specified in the request weren't found and will be ignored.</message> </messages> </response>

Message d'avertissement pour les noms de colonne non valides

Lorsqu’un nom de colonne non valide est indiqué dans la demande, nous envoyons des messages.
Exemple de réponse
:
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <output> <data> <![CDATA["InternalID","CapitalAssetClass","Price" "S289","Furniture","90" "S290","Furniture","200" "S291","Computers","2500" "S292","Computers","1000" "S287","Facility","" "S288","OtherEquipment",""]]> </data> </output> <messages> <message>System Column names [Invalid System Column Name] specified in the request weren't found and will be ignored.</message> <message>Model Column names [timespan,invalid column name] specified in the request weren't found and will be ignored.</message> </messages> </response>