exportCalendar

Diese API wird in API v33 und höher unterstützt.

Aktualisiert in API v40 (21. September 2024).

Kategorie	Abrufen von Metadaten
Beschreibung	Gibt Kalendermetadaten zurück.
Zum Aufrufen sind Berechtigungen erforderlich	Keine (es müssen gültige Zugangsdaten für die Instanz sein)
Auf Anforderung erforderliche Parameter	Zugangsdaten

Die Anforderung dieser Methode enthält ein Credentials-Tag, um den aufrufenden Benutzer zu identifizieren und zu autorisieren. Sobald der Aufrufer verifiziert ist, gibt die Methode ein XML-Dokument zurück, das die vollständige Liste der Kalenderinformationen beschreibt.

Anforderungsformat

<?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>

Element „Zugangsdaten“.
Tag-Name		-Zugangsdaten
Beschreibung		Alle API-Aufrufe müssen ein einzelnes Element mit den Zugangsdaten enthalten, um den Benutzer zu identifizieren, der die API aufruft. Der API-Aufruf wird dann als dieser Benutzer ausgeführt (jeder Audit-Trail oder jede Aktionshistorie im System zeigt, dass dieser Benutzer die Aktion ausgeführt hat). Daher muss der Benutzer über die erforderlichen Berechtigungen zum Ausführen der Aktion verfügen, damit der API-Aufruf ausgeführt werden kann erfolgreich ist.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
anmelden	J	Der Anmeldename des Benutzers, der die API-Methode aufruft. Dieser Benutzer muss über die erforderlichen Berechtigungen zum Aufrufen der Methode verfügen.	sampleuser@company.com
Kennwort	J	Das Kennwort des Benutzers, der die API-Methode aufruft.	my_password
instanceCode	N	Wenn der in den Zugangsdaten angegebene Benutzer Zugriff auf mehr als eine Instanz von Adaptive Planning hat, kann dieses Attribut verwendet werden, um anzugeben, dass der Benutzer auf eine andere Instanz als seine Standardinstanz zugreifen möchte. Wenn nicht angegeben, wird die Standardinstanz des Benutzers verwendet. Verwenden Sie die exportInstances-API, um die verfügbaren Instanzcodes zu ermitteln.	MYINSTANCE1
Inhalt des Elements
(Keine)

Antwortformat


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<output>
<calendars>
  <calendar id="1" isDefault="true" name="DefaultTimeHierarchy" />
</calendars>
</output>
</response>

Antwortelement
Tag-Name		-Antwort
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Erfolg haben	J	Entweder „true“ oder „false“, was angibt, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten.	wahr
Inhalt des Elements
Genau ein erforderliches Ausgabeelement.

Ausgabeelement
Tag-Name	Ausgabe
Attribute des Elements
(Keine)
Inhalt des Elements
Ein erforderliches Kalenderelement. Dieser Ausgabe-Wraper ist ein Standard für alle API-Antworten und schließt die gültige Ausgabe jedes erfolgreichen API-Aufrufs ein.

Element „Kalender“.
Tag-Name		-Kalender
Beschreibung		Container für ein oder mehrere Kalenderelemente.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Ein oder mehrere Kalenderelemente.

Kalenderelement
Tag-Name		Kalender
Beschreibung		Stellt einen Kalender dar.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Enthält die spezifische Ganzzahl-ID des spezifischen Kalenders.	1
isDefault	J	Entweder „true“ oder „false“, was angibt, ob dieser bestimmte Kalender der Standardkalender ist.	wahr
Name	J	Enthält den Kalendernamen.	DefaultTimeHierarchy
-Code Verfügbar in API v40 und höher	N	Enthält den Kalendercode, wenn Kalendercodes vorhanden sind.	DefaultTimeHierarchy
Inhalt des Elements
(Keine)