recalculateSheet

Pris en charge dans l'API v16 +

Catégorie	Soumission de données
Description	Recalculez les feuilles avec la propriété Recalculer sur demande.
Autorisations obligatoires pour pouvoir être appelées	Autorisation de modification de feuille
Paramètres requis sur demande	Identifiants

La demande de cette méthode contient un marqueur d’identifiants pour désigner et autoriser l’utilisateur auteur de l’appel. L'utilisateur doit avoir l'autorisation de modification de feuille pour recalculer.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="recalculateSheet" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_password"/>
   <version name="Default Structure"/>
   <sheet name="Expense Cube"/>
   <level name="Corporate Plan"/>
</call>

élément de version - Renvoie une erreur si la version n'est pas indiquée.

élément de feuille - si aucun élément de feuille n’est précisé, toutes les feuilles avec des options de recalcul sur demande sont recalculées au niveau supérieur dans la version donnée. Dans ce cas, le niveau est ignoré.

élément de niveau

Si aucun niveau n’est précisé, la feuille est recalculée au niveau supérieur dans la version donnée.

Si l’utilisateur n’a pas accès au niveau précisé, une erreur est renvoyée.

La feuille est recalculée pour le niveau et ses descendants dans la version donnée.

élément de données d'identification
Nom du marqueur		données d'identification
Description		Tous les appels d'API doivent contenir un seul un élément d’identification pour désigner 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
paramètres régionaux	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 période 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 préciser 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 recevoir 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.	Structure par défaut
identifiant	N	Identifiant de la version. L'identifiant n'est pris en compte que si le nom est absent.	4
Contenu de l'élément
(aucun)

élément de feuille
Nom du marqueur		feuille
Description		Feuille définie par nom ou identifiant
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	N	Nom de la feuille	Cube de frais
identifiant	N	Identifiant de la feuille. L'identifiant n'est pris en compte que si le nom est absent.	1
Contenu de l'élément
(aucun)

élément de niveau
Nom du marqueur		niveau
Description		Niveau défini par nom ou par identifiant
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	N	Le nom du niveau	Plan d'entreprise
identifiant	N	Identifiant du niveau. Le niveau n'est pris en compte que si le nom est absent.	1
Contenu de l'élément
(aucun)

Format de réponse


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
</response>

élément de réponse
Nom du marqueur		réponse
Description		Niveau défini par nom ou par identifiant
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
réussite	Y	"true" ou "false", 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.

élément de message
Nom du marqueur		messages
Description		Conteneur pour une ou plusieurs valeurs éléments de message.
Attributs de l'élément
(aucun)
Contenu de l'élément
Une 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. Un élément de contexte facultatif.