exportConfigurableModelData

Dernière mise à jour
Enregistrer en tant que PDF

Pris en charge dans API v19 +

Catégorie	Récupération des données
Description	Retourne un ensemble de lignes à partir de la feuille modélisée demandée dans la version et l’instance demandées.
Autorisations requises pour invoquer	Accès en lecture à la feuille, à la version et à l’instance demandée.
Paramètres requis sur demande	Informations d’identification, feuille modélisée, version, job

Cette requête de méthode contient les paramètres qui seront utilisés pour déterminer les lignes modélisées renvoyées. L’utilisateur doit disposer d’un accès en lecture à la feuille, à la version et à l’instance contenant la feuille modélisée.

Bonne pratique : Invoquez exportSheets pour récupérer le nom de la feuille modélisée et l’ID nécessaire pour votre requête exportConfigurableModelData .

Format de demande

<?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" pageSize="200"/>    <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 d’identification
Nom de balise		informations d’identification
Description		Tous les appels API doivent contenir un élément d’identification unique pour identifier l’utilisateur invoquant l’API. L’appel API est alors exécuté comme cet utilisateur (toute piste d’audit ou historique des actions dans le système montrera que cet utilisateur a effectué l’action), et par conséquent l’utilisateur doit disposer des autorisations requises pour exécuter l’action afin que l’appel API réussisse.
Attributs de l’élément
Nom d’attribut	Obligatoire ?	Valeur	Exemple
login	Y	Le nom de connexion de l’utilisateur invoquant la méthode API. Cet utilisateur doit avoir un rôle contenant les autorisations requises pour la méthode invoquée.	sampleuser@company.com
mot de passe	Y	Le mot de passe de l’utilisateur invoquant la méthode API.	my_password
Contenu de l’élément
(aucun)

élément de version
Nom de balise		version
Description		Spécifie la version à partir de laquelle récupérer les lignes modélisées.
Attributs de l’élément
Nom d’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 de balise		feuille-modélisée
Description		Spécifie la feuille modélisée pour récupérer les lignes modélisées. Utilise l’ID ou le nom de la feuille modèle comme identifiant.
Attributs de l’élément
Nom d’attribut	Obligatoire ?	Valeur	Exemple
Nom	Y	Nom de la feuille modélisée.	Budget de travail
isGlobal	N	Indique si la feuille est une feuille affectée à un utilisateur ou une feuille affectée à un niveau. Si vrai (true), la feuille est une feuille affectée à un utilisateur. Si faux (false), la feuille est une affectée à un niveau.	false
includeAllColumns Pris en charge dans API v22+	N	Spécifie si toutes les colonnes de la réponse sont incluses. Toute valeur autre que vrai (true) résultera comme faux (false).	false
utiliserIDnumériques Pris en charge dans API v22+	N	Indique si les ID internes de la réponse doivent être au format numérique. Par exemple, « `100` » et « `S100` ». Si elle est absente ou définie sur autre chose que « `true` » (insensible à la casse), elle entraîne `la valeur false`. Exemple d’ID de fractionnement si `true` : `271` Exemple d’ID de fractionnement si `false` : `S271`	true
Contenu de l’élément
(aucun)

élément tâche
Nom de balise		job
Description		Spécifie le numéro de série du gestionnaire API pour la tâche d’appel d'API.
Attributs de l’élément
Nom d’attribut	Obligatoire ?	Valeur	Exemple
jobNumber	Y	0 pour l’appel initial. Un numéro de job revient dans la réponse. Utilisez ce numéro de job pour chaque demande ultérieure. Le gestionnaire API créera ensuite un modèle de feuille qui chargera la feuille en mémoire. La feuille reste en mémoire jusqu’à ce que la demande expire et que les déchets soient collectés. L’API renvoie alors la première page ainsi que les autres paramètres répertoriés ci-dessus.	2
pageSize	N	Écrase la page par défaut pour laisser l’utilisateur API spécifier le nombre de lignes par page récupérées pour chaque appel. Cela prend effet uniquement lors du premier appel, lorsque JobNumber="0". Si la valeur pageSize (taille de page) donnée est plus grande que le nombre de lignes dans la feuille, la valeur pageSize est ignorée.	200
pageNumber	Y	Spécifie le numéro de page demandé si plusieurs pages existent. L’index de numéros de page commence par « 1 ». Le gestionnaire API est pour le même utilisateur que celui qui effectue l’appel suivant en utilisant la requête demande API et l’authentification. La requête suivante doit être dans les 3 minutes suivant le dernier temps de réponse.	1
Contenu de l’élément
(aucun)

élément filtres
Nom de balise		filtres
Description		Conteneur pour tous les éléments liés aux filtres.
Attributs de l’élément
Nom d’attribut	Obligatoire ?	Valeur	Exemple
Contenu de l’élément
L’élément niveaux.

élément niveaux
Nom de balise		niveaux
Description		Conteneur pour un élément de niveau Spécifie le niveau pour récupérer des lignes.
Attributs de l’élément
Nom d’attribut	Obligatoire ?	Valeur	Exemple
Contenu de l’élément
Éléments de niveau unique.

élément niveau
Nom de balise		niveau
Description		Spécifie un niveau par lequel filtrer la requête.
Attributs de l’élément
Nom d’attribut	Obligatoire ?	Valeur	Exemple
nom	Y	Le nom du niveau demandé.	Siège
includeDescendants	N	Indique si l’exportation doit inclure tous les descendants du niveau spécifié ou non. Si défini sur vrai, tous les enfants de ce niveau seront exportés, ainsi que leurs enfants, etc. Si cette valeur est définie sur Faux, ce niveau sera exporté seul. Indiquer "faux" permet l’exportation des niveaux indiqués comme niveau (uniquement) dans l’IU Web Adaptive Planning Web.	true
Contenu de l’élément
Le nom du niveau

élément horizon temporel
Nom de balise		timeSpan
Description		Si la feuille modèle a un élément timeSpan (horizon temporel), le début et la fin spécifient la période de données à exporter dans la feuille. Si horizon temporel n’est pas inclus, les données de l’exportation de la plage de dates complète de la version sont incluses. Utilisez un code de période interne (dans l’IU Administration du temps) ou une étiquette temporelle localisée dans la vue feuille pour indiquer un début ou une fin de timeSpan . TimeSpan duplique la fonctionnalité des options d’affichage > Paramètres de temps pour les sélections de temps de feuille dans Début et Fin pour une feuille modélisée dans l’IU Adaptive Planning.
Attributs de l’élément
Nom d’attribut	Obligatoire ?	Valeur	Exemple
début	N	Le code temporel ou l’étiquette temporelle localisée visible dans la feuille de la première période dans la plage à exporter. La période de début doit être une période de feuille. Si le début n’est pas indiqué, le début de la version est utilisé.	Jan-2016 01/2016
fin	N	Le code temporel ou l’étiquette temporelle localisée de la dernière période dans 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 de timeSpan

Début janvier 2016 et fin avril 2016. Jan-2016 est le code de période interne indiqué par l’interface utilisateur de l’administration du temps. 04/2016 est une étiquette temporelle de feuille.

<Début timeSpan="Jan-2016" fin="04/2016"/>

Début février 2016 et fin à la date de fin de la version. 02/2016 est une étiquette temporelle de feuille.

<Début timeSpan="02/2016"/>

Commencer par la date de début de la version et de fin en novembre 2016. Nov-2016 est le code de période interne indiqué par l’interface utilisateur de l’administration du temps.

<Début timeSpan="" fin="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 réponse
Nom de balise		réponse
Attributs de l’élément
Nom d’attribut	Obligatoire ?	Valeur	Exemple
réussite	Y	Vrai ou faux (true ou false), indiquant si l’appel API a réussi ou non. Même les appels réussis peuvent contenir des messages d’avertissement dans leur réponse.	true
Contenu de l’élément
Un seul élément de messages facultatif, et exactement un élément de sortie requis.

élément messages
Nom de balise	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 message
Nom de balise		message
Description		Représente un message renvoyé du système à l’appelant. Des messages sont utilisés pour les messages d’erreur lorsque les requêtes ne réussissent pas, pour les messages d’avertissement lorsque les requêtes réussissent, et pour les messages de confirmation lors de la réussite.
Attributs de l’élément
Nom d’attribut	Obligatoire ?	Valeur	Exemple
clé	N	Lorsque donnée, une clé est une façon d’identifier un message ou un type de message particulier, utile aux fins d’enregistrement automatique des erreurs et de récupération dans les programmes clients. Les clés ne changent pas sous différents paramètres régionaux, même lorsque la langue du message change. Les clés sont également peu susceptibles de changer à l’avenir en raison de modifications de la formulation ou de changements de terminologie.	invalid-attributevalueid
Contenu de l’élément
Le texte du message. Ce texte est dans la langue de la zone spécifiée sur la requête (en supposant que les paramètres régionaux sont pris en charge). Le texte peut également contenir des informations variables, telles que le nombre de lignes traitées, ou la colonne ou la valeur particulière qui a provoqué une erreur.

élément tâche
Nom de balise		job
Description		Spécifie le job et les informations d’échange de données pour les données retournées pour que l’utilisateur puisse effectuer 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 d’attribut	Obligatoire ?	Valeur	Exemple
jobNumber	N	Numéro de série du gestionnaire API dédié attribué par le serveur pour la tâche d’appel d'API. Utilisé dans toutes les requêtes ultérieures.	2
pageCount	N	Nombre total de pages de données disponibles pour le jeu de filtres.	3
pageNumber	N	Numéro de page du jeu de données actuel renvoyé.	1
Contenu de l’élément
Un ou plusieurs éléments de niveau. Si la demande inclut des niveaux inaccessibles, il n’y aura qu’un seul élément, ce qui représente le niveau supérieur de l’organisation.

élément sortie
Nom de balise		sortie
Description		La réponse renvoie un bloc CDATA contenant un vidage de données au format CSV des lignes modélisées en cours d’exportation. La première ligne du bloc CDATA est la "ligne d’en-tête" du CSV, et toutes les lignes suivantes sont des lignes de données. Si aucune ligne ne correspond à la requête de filtrage, seule la ligne d’en-tête est sortie. Les colonnes du CSV commencent par jusqu'à cinq colonnes axées interne codées en dur. Ces colonnes peuvent identifier la ligne et certaines de ses propriétés immuables. Les colonnes présentes sur la feuille suivent, indépendamment du fait que : L’utilisateur individuel peut les masquer dans ses options d’affichage Les colonnes sont en lecture seule ou non. Toutes les colonnes de la réponse API sont les colonnes visibles/définies pour la feuille, avec leur en-tête de colonne déclarée étant leur étiquette dans la ligne d’en-tête. Cela inclut toutes les colonnes d’attributs placées sur la feuille. Pour le compte d’horizon temporel, les en-têtes de colonne sont les mois de la version actuelle au même format que l’API exportData.
Attributs de l’élément
Nom d’attribut	Obligatoire ?	Valeur	Exemple
Niveau	N	Nom du niveau où se trouve cette ligne ou fraction/ligne. Cela apparaît, que le niveau demandé soit un niveau de cumul ou non.	Ingénierie
Contenu de l’élément
Un bloc CDATA contenant : Lignes formatées comme CSV valide. Les chaînes sont entre des guillemets doubles. Les nombres sont émis dans une forme canonique (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 aucune valeur, ils émettent une chaîne vide. Lors de l’émission de lignes parent, toutes les colonnes fractionnables sont affichées comme vides dans le CSV (elles ne tentent pas d’afficher les valeurs de cumul ou de valeurs « divers »). Lorsque vous émettez des lignes enfant/fraction, les colonnes non-fractionnables sont affichées comme contenant la valeur de leur ligne parent. Ceci est identique à la manière dont la feuille se comporte dans l’IU Web Adaptive Planning.