exportCalendar

Cette API est prise en charge dans l’API v33+.

Mis à jour dans l’API v40 (21 septembre 2024).

Catégorie	Metadata retrieval
Description	Renvoie les métadonnées du calendrier.
Autorisations obligatoires pour pouvoir être appelées	Aucun (doit être un identifiant valide pour l’instance)
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. Une fois l’appelant vérifié, la méthode renvoie un document XML décrivant la liste complète des informations de calendrier.

Format de demande

<?xml version='1.0' encoding='UTF-8'?>
<call method="exportCalendar" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
</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
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 indiquer 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)

Format de réponse


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<output>
<calendars>
  <calendar id="1" isDefault="true" name="DefaultTimeHierarchy" />
</calendars>
</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	"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 sortie est requis.

élément de sortie
Nom du marqueur	sortie
Attributs de l'élément
(aucun)
Contenu de l'élément
Un seul élément de calendriers obligatoire. Ce filtre de sortie est standard sur toutes les réponses d’API et enveloppe la sortie valide de tout appel d’API réussi.

élément de calendriers
Nom du marqueur		calendriers
Description		Conteneur pour un ou plusieurs éléments de calendriers.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de calendrier.

élément de calendrier
Nom du marqueur		calendrier
Description		Représente un calendrier.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Contient l’identifiant entier spécifique du calendrier spécifique.	1
isDefault	Y	Soit "true" ou "false", indiquant si ce calendrier spécifique est le calendrier par défaut.	vrai
nom	Y	Contient le nom du calendrier.	DefaultTimeHierarchy
code Disponible dans l'API v40+	N	Contient le code de calendrier lorsque des codes de calendrier sont présents.	DefaultTimeHierarchy
Contenu de l'élément
(aucun)