exportVersions
Aktualisiert in API v40. (21. September 2024).
Diese API unterstützt nur Benutzer Konzept: Zugriffsregeln in API v22 und höher.
Kategorie
| Abrufen von Metadaten |
Beschreibung
| Nach der Verifizierung gibt die Methode ein XML-Dokument zurück, das den Satz aller in der Instanz definierten Versionen beschreibt, die für den anfordernden Benutzer nicht ausgeblendet werden. |
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 nur ein Credentials-Tag zur Identifizierung und Autorisierung des aufrufenden Benutzers. Nach der Verifizierung gibt die Methode ein XML-Dokument zurück, das den Satz aller in der Instanz definierten Versionen beschreibt, die für den anfordernden Benutzer nicht ausgeblendet werden.
Anforderungsformat
<?xml version='1.0' encoding='UTF-8'?> <call method="exportVersions" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> </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 |
Gebietsschema | N | Geben Sie das Gebietsschema an, das verwendet werden soll, um eingehende Zahlen und Datumsangaben zu interpretieren und ausgehende Zahlen und Datumsangaben zu formatieren (mit dem entsprechenden Tausendertrennzeichen, den Monatsnamen und der Datumsformatierung). Das Gebietsschema wird auch verwendet, um die Sprache anzugeben, in der Systemmeldungen in der Antwort angezeigt werden sollen. Wenn nicht angegeben, wird en_US (amerikanisches Englisch) verwendet. | fr_FR |
instanceCode | N | Wenn der in den Zugangsdaten angegebene Benutzer Zugriff auf mehr als eine Instanz von hat, Adaptive Planning : Dieses Attribut kann 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) | |||
Element einschließen
| |||
Tag-Name
| einschließen | ||
Beschreibung
| Stellt einen Satz von Kennzeichen dar, die angeben, welche Aspekte der Versionsinformationen in die Antwort aufgenommen oder daraus ausgeschlossen werden sollen. Dieses Element ist optional: Wenn es nicht vorhanden ist, gibt die API alle Versionsinformationen zurück. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
rootActuals Wird ab 2019.3 in keiner API-Version unterstützt | N | Gibt an, ob die Root-Istzahlen-Version einbezogen werden soll, wenn Istzahlen in der Versionsauswahl ausgeblendet werden. | false |
Szenarien | N | Gibt an, ob private What-if-Szenarien in der Antwort enthalten sein sollen. | false |
Währungsversionen
Verfügbar in API v40 und höher | N | Gibt an, ob Währungsversionen für umgerechnete Istzahlen in der Antwort enthalten sein sollen.
Sie müssen sich an Ihren benannten Support-Ansprechpartner wenden, um zu erfahren, ob Ihre Instanz für dieses Feature auswählbar ist. | false |
Inhalt des Elements
| |||
(Keine) | |||
Antwortformat
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <versions seqNo="32"> <version id="1" name="Actuals" shortName="" type="ACTUALS" isVirtual="false" description="Total Actuals" isDefaultVersion="false" isLocked="false" hasAuditTrail="false" isImportable="0" startVer="2012" completedValuesThru="03/2012" startScroll="01/2012" endVer="2016" lockLeading="" > <version id="5" name="Adjusted Actuals" shortName="SV-13" type="ACTUALS" isVirtual="false" description="Actuals SubVersion" isDefaultVersion="false" isLocked="false" hasAuditTrail="false" isImportable="0" > <version id="6" name="Original Import" shortName="SSV-13" type="ACTUALS" isVirtual="false" description="Values Imported from the GL" isDefaultVersion="false" isLocked="false" hasAuditTrail="false" isImportable="1" /> <version id="8" name="Manual Adjustments" shortName="SSV-14" type="ACTUALS" isVirtual="false" description="Actuals Sub-Version for Manual Adjustments" isDefaultVersion="false" isLocked="false" hasAuditTrail="true" isImportable="1" /> </version> <version id="9" name="Eliminations" shortName="ELIM" type="ACTUALS" isVirtual="false" description="Eliminating entries" isDefaultVersion="false" isLocked="false" hasAuditTrail="false" isImportable="0" /> </version> <version id="2" name="Budget 2013" shortName="" type="PLANNING" isVirtual="false" description="This is the budget for 2013 with a five-year span." isDefaultVersion="true" isLocked="false" hasAuditTrail="true" isImportable="1" leftScroll="2013" startPlan="01/2013" endPlan="2017" lockLeading="05/2013" /> <version id="10" name="Worst Case" shortName="S13-A-WC" type="SCENARIO" isVirtual="false" description="Worst Case for Budget 2013" isDefaultVersion="false" isLocked="false" hasAuditTrail="false" isImportable="0" isPredictive="false" /> </version> <version id="3" name="Budget 2014" shortName="B-14" type="PLANNING" isVirtual="false" description="This is the budget for 2014 with a five-year span." isDefaultVersion="false" isLocked="false" hasAuditTrail="false" isImportable="1" leftScroll="2014" startPlan="01/2014" endPlan="2018" lockLeading="" /> </versions> </output> </response>
Antwortelement
| |||
Tag-Name
| -Antwort | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Erfolg haben | J | Entweder wahr oder falsch, was angibt, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten. | wahr |
veraltet | N | Wenn dieses Attribut im Antwort-Tag vorhanden ist und auf „true“ gesetzt ist, zeigt es an, dass die Version der Methode oder API, die aufgerufen wird, veraltet ist und als „Veraltet“ gilt. Auch wenn es zu diesem Zeitpunkt noch funktioniert, kann es sein, dass Sie in Kürze nicht mehr funktionieren. In der Regel ist dieses Attribut nicht vorhanden. | false |
Inhalt des Elements
| |||
Ein einzelnes optionales Nachrichtenelement und genau ein erforderliches Ausgabeelement. | |||
Ausgabeelement
| |
Tag-Name
| Ausgabe |
Attribute des Elements
| |
(Keine) | |
Inhalt des Elements
| |
Ein einzelnes Kontenelement Dieser Ausgabe-Wraper ist ein Standard für alle API-Antworten und schließt die gültige Ausgabe jedes erfolgreichen API-Aufrufs ein. | |
Element „Versionen“.
| |||
Tag-Name
| -Versionen | ||
Beschreibung
| Container für ein oder mehrere Versionselemente. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Sequenznr Hinzugefügt in API v17, aber für zukünftige Verwendung reserviert. | |||
Inhalt des Elements
| |||
Ein oder mehrere Versionselemente. | |||
-Versionselement
| |||
Tag-Name
| Version | ||
Beschreibung
| Stellt eine einzelne Version dar, die in der Antwort auf einen exportVersions-API-Aufruf zurückgegeben wird. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
id | J | Die interne System-ID für die Version oder den Ordner. Alle IDs sind in allen Versionen, Unterversionen und Ordnern eindeutig. | 2 |
Name | J | Der Name der Version oder des Ordners, wie er in der Versionsverwaltung angezeigt wird. | Budget 2015 |
shortName | N | Ein Kurzname für die Version, falls vorhanden, wie in der Versionsverwaltung eingegeben | B2015 |
type
Aktualisiert in API v37. | J | Einen der folgenden Werte:
| ACTUALS |
isVirtual Verfügbar in API v16 und höher | J | „true“ oder „false“, um anzugeben, ob es sich um eine virtuelle Version handelt | false |
Beschreibung | J | Die Beschreibung der Version oder des Ordners, wie sie in der Versionsverwaltung angezeigt wird. | Dies ist das Budget für 2015 mit einer Zeitspanne von 5 Jahren. |
isDefaultVersion | J | Gibt an, ob die Version die Standardversion ist. „Wahr“, wenn die Version die Standardversion ist, andernfalls „false“. | wahr |
isGesperrt | N | Gibt an, ob die Version „Global gesperrt“ ist (das Kontrollkästchen Gesperrte Version ist aktiviert). Wenn nicht vorhanden, wird die Version nicht als gesperrt betrachtet. Ist für Istzahlen-Versionen oder Ordner immer "falsch". | wahr |
hasAuditTrail | J | Gibt an, ob Audit-Trail für die Version aktiviert ist. | wahr |
enabledForWorkflow Verfügbar in API v17 und höher | N | Gibt an, ob die Version für den Workflow aktiviert ist. | 1 |
isImportable | N | Gibt an, ob der Benutzer, der diese API anfordert, Daten in die Version importieren darf. 0 bedeutet, dass die Version keine Importe akzeptieren kann, und 1 bedeutet, dass dies möglich ist. Eine Version ist importierbar, wenn mindestens ein Zeitfenster in der angegebenen Version für diesen Benutzer importierbar ist. | 1 |
startVer | N | Der Code der Root-Zeitperiode, in der die Version beginnt. Entspricht dem Versionsstart auf der Seite „Versionsverwaltung“. Dieses Attribut wird nur für die Root-Istzahlen-Version angezeigt. Dieses Attribut ist für die Root-Istzahlen-Version erforderlich. | 2015 |
endVer | N | Der Code der Root-Zeitperiode, in der die Version endet. Entspricht dem Versionsende auf der Seite der Versionsverwaltung. Dieses Attribut wird nur für die Root-Istzahlen-Version angezeigt. Dieses Attribut ist für die Root-Istzahlen-Version erforderlich. | 2015 |
startScroll | N | Der Code der Leaf-Zeitperiode, in der die Planung beginnt. Entspricht der Bildlaufanfangsposition auf der Seite „Versionsverwaltung“. Dieses Attribut wird nur für die Root-Istzahlen-Version angezeigt. Dieses Attribut ist für die Root-Istzahlen-Version erforderlich. | 01/2015 |
completedValuesThru | N | Der Code der letzten Leaf-Zeitperiode, für die in den Root-Istzahlen Daten ausgefüllt wurden. In einem Standardkalender wäre dies ein Monat. Entspricht den abgeschlossenen Werten bis auf der Seite „Versionsverwaltung“. Dieses Attribut wird nur für die Root-Istzahlen-Version angezeigt. Dieses Attribut ist für die Root-Istzahlen-Version optional. | 03/2015 |
leftScroll | N | Der Code der Root-Zeitperiode, in der die Version beginnt. Entspricht der linken Bildlaufbegrenzung auf der Seite für die Versionsverwaltung. Dieses Attribut wird nur für Planversionen angezeigt. Dieses Attribut ist für Planversionen erforderlich. | 2015 |
startPlan | N | Der Code der Leaf-Zeitperiode, in der die Planung beginnt. Entspricht dem Planstart auf der Seite für die Versionsverwaltung. Dieses Attribut wird nur für Planversionen angezeigt und ist für Planversionen erforderlich. | 02/2015 |
endPlan | N | Der Code der Root-Zeitperiode, in der die Version endet. Entspricht dem Planende auf der Seite „Versionsverwaltung“. Dieses Attribut wird nur für Planversionen angezeigt. Dieses Attribut ist für Planversionen erforderlich. | 2015 |
lockLeading | N | Der Code der Leaf-Zeitperiode, bis zu der Versionswerte gesperrt sind. Entspricht der Sperre vorausgehender Monate auf der Seite für die Versionsverwaltung. Dieses Attribut wird nur für die Root-Istzahlen-Version und die Planversionen angezeigt. Dieses Attribut ist für die Root-Istzahlen-Version und die Planversionen optional. | 05/2015 |
isPredictive Verfügbar in API v28 + | J | Gibt an, ob die Version eine prädiktive Version ist. | false |
Inhalt des Elements
| |||
Ein verschachteltes Versionselement für jede direkt untergeordnete Version dieser Version. | |||