exportCalendar

Cette API est prise en charge dans API v33 et supérieure.

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

Catégorie	Metadata retrieval
Description	Renvoie les métadonnées du calendrier.
Autorisations requises pour appeler	Aucun (doit être des identifiants valides pour l'instance)
Paramètres obligatoires à la demande	Identifiants

La demande de ce mode contient un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. Une fois l'appelant vérifié, la méthode renvoie un document XML décrivant la liste complète des informations du 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 identifiants
Nom du marqueur		identifiants
Description		Tous les appels d'API doivent contenir un seul é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
instanceCode	N	Si l'utilisateur indiqué dans les identifiants a accès à plusieurs instances Adaptive Planning, cet attribut peut être utilisé pour indiquer qu'il a l'intention d'accéder à une instance différente de 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)

Format de la 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	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
Uniquement un élément de sortie obligatoire.

élément de sortie
Nom du marqueur	sortie
Attributs de l'élément
(aucun)
Contenu de l'élément
Un seul élément des calendriers obligatoires. Ce filtre de sortie est standard sur toutes les réponses d'API et contient 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 calendrier.
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
id	O	Contient l'identifiant de nombre entier spécifique du calendrier spécifique.	1
isDefault	O	"vrai" ou "faux", indiquant si ce calendrier spécifique est le calendrier par défaut.	vrai
nom	O	Contient le nom du calendrier.	Hiérarchie des temps par défaut
code Disponible dans API v40 et supérieure	N	Contient le code du calendrier s'il existe des codes de calendrier existants.	Hiérarchie des temps par défaut
Contenu de l'élément
(aucun)