recalculateSheet

Prise en charge dans API v16 et supérieure

Catégorie	Soumission de données
Description	Recalculez les feuilles avec la propriété Relancer le calcul à la demande.
Autorisations requises pour appeler	Autorisation de modification de la feuille
Paramètres obligatoires à la demande	Identifiants

La demande de ce mode contient un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. L'utilisateur doit avoir l'autorisation "Autorisation de modification de la 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 : lance une erreur si la version n'est pas indiquée.

élément de feuille : si aucun élément de feuille n'est spécifié, toutes les feuilles avec des options de recalcul à la demande sont recalculées au périmètre supérieur dans la version donnée. Dans ce cas, le périmètre est ignoré.

élément de périmètre

Si aucun périmètre n'est spécifié, la feuille est recalculée au périmètre supérieur dans la version donnée.

Si l'utilisateur n'a pas accès au périmètre spécifié, une erreur est générée.

La feuille est recalculée pour le périmètre et ses descendants dans la version donnée.

élément identifiants
Nom du marqueur		identifiants
Description		Tous les appels d'API doivent contenir un seul l'é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 d'actions dans le système indique que cet utilisateur a effectué l'action) et, par conséquent, l'utilisateur doit avoir les autorisations requises pour effectuer l'action afin que l'appel d'API s'appelle réussir.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
se connecter	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
paramètres régionaux	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 période 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 spécifié dans les identifiants 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 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 recevoir 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.	Structure par défaut
id	N	Identifiant de la version. L'identifiant est pris en compte uniquement si le nom n'est pas présent.	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	Le nom de la feuille	Cube de frais
id	N	Identifiant de la feuille. L'identifiant est pris en compte uniquement si le nom n'est pas présent.	1
Contenu de l'élément
(aucun)

élément de périmètre
Nom du marqueur		level
Description		Périmètre défini par nom ou identifiant
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	N	Le nom du périmètre	Plan d'entreprise
id	N	Identifiant du périmètre. Le périmètre est pris en compte uniquement si le nom n'est pas présent.	1
Contenu de l'élément
(aucun)

Format de la réponse


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

élément de réponse
Nom du marqueur		réponse
Description		Périmètre défini par nom ou identifiant
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
Contenu de l'élément
Un seul élément de messages facultatifs.

élément de messages
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-attributevalueid
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 à l'origine de l'erreur. Un élément de contexte facultatif.