Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2023-06-23
Versionen

Versionen

URL-Endpunkt

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/versions
HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/cloneVersion
(Nur POST)
Version: v1
Kategorie
Übermittlung, Änderung und Abruf von Metadaten
Beschreibung
Metadatenänderung
Zum Aufrufen sind Berechtigungen erforderlich
Modellmanagementmodell
​
Auf Anforderung erforderliche Parameter
Variiert je nach Endpunkt:
PATCH, POST, DELETE: Versionsname.
Keine für GET

Unterstützte HTTP-VERB(s)

(Hinweis: Versionsordner werden für keinen der folgenden Endpunkte unterstützt.)
HTTP-Verb
Einzelressource
Einzugsressource
Beschreibung
GET
Nicht unterstützt
Unterstützt
Rufen Sie alle Versionen des Mandanten ab.
DELETE
Unterstützt
Nicht unterstützt
Vorhandene löschbare Version löschen
PATCH
Unterstützt
Nicht unterstützt
Istzahlen-Versionen erstellen/aktualisieren oder Planversionen aktualisieren.
POST
Unterstützt
Nicht unterstützt
Erstellen Sie eine neue Planversion.

GET

Anforderungs-URI
/api/rest/modeling/v1/{tenant}/versions:
Ruft alle Versionen des Mandanten ab
Ruft alle Versionen des Mandanten in einer Liste ab.
Eigenschaften, die für bestimmte Versionen nicht auf der Benutzeroberfläche angezeigt werden, sind nicht in den entsprechenden Versionsobjekten in der Antwort enthalten. Beispiel: startOfVersion für Unter-Istzahlen-Versionen.
Paginierung kann über die Parameter "limit" und "offset" verwendet werden.
Die folgenden Versionseigenschaften werden derzeit in GET nicht unterstützt/angezeigt:
Basisversion (für virtuelle Versionen), Konstantwährungsreporting aktivieren (für virtuelle Versionen),
Berechnung von Formelwerten, Administratorzugriff, Benutzerzugriff, Bearbeitungszugriff auf Tabellenblätter, Privilegierter Istzahlen-Zugriff, Gruppe, Gruppenzugriffsebene.
Beispiel für eine Anforderungs-URI:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?limit=25&offset=1
Beispielanforderungstext:
<Leer lassen>
Abfrageparameter:
Name
Beschreibung
Erforderlich
limit
Die maximale Anzahl von Objekten in einer einzelnen Antwort.
N
Offest
Der 0-basierte Index des ersten Objekts in einer Antwortauflistung. Der Standardwert ist 0.
Verwenden Sie Offset mit dem Grenzwert-Parameter, um das Paging einer Antworterfassung zu steuern.
N
Pfadparameter:
Name
Beschreibung
Erforderlich
Mandant
Der Mandant, auf dem gearbeitet werden soll, z. B. GREENCO
J
Beispielantwort
200 OK
Hinweis: Der Versionsstart für Istzahlen-Versionen und die linke Bildlaufbegrenzung für Planversionen werden beide unter der Eigenschaft startOfVersion (Zeiger A) angezeigt.
Ebenso werden das Versionsende für Istzahlen-Versionen und das Planende für Planversionen unter der Eigenschaft endOfVersion (Zeiger D) angezeigt.
Die Bildlaufanfangsposition für Istzahlen-Versionen und der Planstart für Planversionen werden beide unter der Eigenschaft „startScrollLocation“ (Zeiger C) angezeigt.
Erfolgreiche Antwort.
Beispielantwort
 
{
    "data": [
        {
            "name": "Test-Actuals-Version",
            "shortName": "Test-Actuals-Version-Shortname",
            "versionType": "ACTUALS",
            ...
            "lockLeadingCompletion": true
        },
        {
            "name": "JE Sub under Actuals",
            "shortName": "JE01",
            "parent": "Actuals",
            ...
            "journalEntryVersion": true,
            "journalEntryVersionProperties": {
                "journalEntryNumbering": "N",
                "startingNumber": 0
            },
            ...
        },
        ...
    ],
    "limit": 12,
    "offset": 4,
    "total": 12
}

DELETE

Anfordern
/api/rest/modeling/v1/{tenant}/versions:
Löschen Sie eine vorhandene Version
Löscht die Version mit dem angegebenen Versionsnamen.
Die Root-Istzahlen-Version und die Standardversion können nicht gelöscht werden.
Beispiel für eine Anforderungs-URI:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}
Beispielanforderungstext:
<Leer lassen>
Abfrageparameter
Name
Beschreibung
Erforderlich
versionName
Name der vorhandenen Version, die gelöscht werden soll.
J
instanceCode
instanceCode, aus dem Werte abgerufen werden sollen. Beispiel: GLOBO. Wenn kein instanceCode angegeben wird, wird die Standardinstanz des Benutzers verwendet.
N
Pfadparameter
Name
Beschreibung
Erforderlich
Mandant
Der Mandant, auf dem gearbeitet werden soll, z. B. GREENCO
J
Beispielantwort
204 NO_CONTENT
Erfolgreiche Antwort ist leer mit Statuscode 204.

PATCH

Anfrage:
/api/rest/modeling/v1/{tenant}/versions:
Istzahlen-Versionen oder Planversionen erstellen/aktualisieren.
Wenn die angegebene Versions-ID vorhanden ist, wird die vorhandene Istzahlen-/Planversion aktualisiert. Ist dies nicht der Fall, wird mit dieser ID eine neue Istzahlen-Version erstellt.
Derzeit werden zwei Gruppen von Versions-IDs, die über Abfrageparameter unterstützt werden:
-Versionsname
In der URL muss für jeden Aufruf nur einer der oben genannten Abfrageparameter angegeben werden.
Beispiel für eine Anforderungs-URI:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}
Anforderungstext
-JSON, die die Versionseigenschaften enthält, die für die vorhandene Version aktualisiert oder für die zu erstellende neue Version angegeben werden sollen.
Aktualisieren:
– Für Aktualisierungen ist keine bestimmte Eigenschaft im Anforderungstext erforderlich (außer versionType), aber ein Anforderungstext ist dennoch erforderlich. Der Anforderungstext von
POST
 enthält eine Liste der Eigenschaften für verschiedene Arten von Planversionen.
-Indikator-Eigenschaften (z. B. JournalEntryVersion) können nicht aktualisiert werden. sie können jedoch im Anforderungstext verbleiben, solange sie den korrekten unveränderten Wert haben.
– Die Aktualisierung von übergeordneten Elementen wird aktuell nicht unterstützt.
– Beim Aktualisieren von Nicht-Leaf-Versionen (Versionen mit untergeordneten Elementen), können die Benutzergruppen dieser Versionen nur die Zugriffsarten "FULL_ACCESS" oder "HIDDEN" haben. „FULL_ACCESS“ wird auf der Benutzeroberfläche als „Visite“ angezeigt und entspricht dieser.
– Details zum Gruppenzugriff (Gruppen-ID und Gruppenzugriffsebene) können durch die Angabe groupId = 0 im Anforderungstext eines Aktualisierungsaufrufs entfernt werden.
Erstellen Sie Folgendes:
– Für Erstellungen stehen die folgenden Eigenschaften zur Angabe im Anforderungstext zur Verfügung:
Eigenschaften
Beschreibung
Erforderlich (für Istzahlen)
Erforderlich (für Journaleingabe)
Name der Eigenschaft im Anforderungstext
Wertart
Standardwert
Kurzname
Kurzname der Version.
N
N
shortName
String
leere Zeichenfolge
Übergeordnet
Übergeordnete Version dieser Version.
N
N
Übergeordnetes Element
Zeichenfolge (Versionsname)
Root-Istzahlen-Version
Versionsart
Versionsart (IST oder PLANNING)
Y, IST
Y, IST
versionType
String
Beschreibung
Beschreibung
N
N
Beschreibung
String
leere Zeichenfolge
Administratorenzugriff
Versionszugriffsebene für Administratoren
N
N
administratorsAccess
VersionAccessControl
Von übergeordnetem Element geerbt
Benutzerzugriff
-Versionszugriffsebene für Benutzer.
N
N
userAccess
VersionAccessControl
Von übergeordnetem Element geerbt
Privilegierter Zugriff auf Istzahlen
Versionszugriffsebene für alle Personen mit der Berechtigung Privilegierter Istzahlen-Zugriff.
N
N
privilegedActualsAccess
VersionAccessControl
Von übergeordnetem Element geerbt
Gruppen-ID
Eine angegebene Benutzergruppen-ID
N
N
groupId
Ganzzahl
Von übergeordnetem Element geerbt
Gruppenzugriffsebene
Versionszugriffsebene der angegebenen Benutzergruppe.
Y, wenn Gruppen-ID angegeben ist.
Y, wenn Gruppen-ID angegeben ist.
groupAccessLevel
VersionAccessControl
Von übergeordnetem Element geerbt
Audit-Trail
Audit-Trail-Informationen beibehalten/löschen.
N
N
auditTrail
Boolesch
falsch (von übergeordnetem Element für Journaleingabeversionen geerbt)
Journaleingabeversion
Ob die zu erstellende Version eine Journaleingabe ist
N
Y, wahr
journalEntryVersion
Boolesch
returnId
Gibt eine Versions-ID zurück, wenn sie auf „true“ gesetzt ist. Neue Versions-ID, wenn der Vorgang eine neue Version erstellt hat. Andernfalls wird die ID der vorhandenen Version zurückgegeben, die aktualisiert wurde.
N
N
returnId
Boolesch
false (gibt 204 „Kein Inhalt“ als „false“ zurück, gibt 200 „OK“ mit der Version in der Antwort zurück, wenn auf „true“ gesetzt)
– Die Wertart „VersionAccessControl“ kann die folgenden Zeichenfolgenwerte annehmen: "HIDDEN", "Versperrt", "sperred_EXCEPT_NOtes", "IMport_AND_NOtes", "FULL_ACCESS"
-Gruppen-IDs sind über die öffentliche API exportGroups verfügbar.
– Die Journaleingabeversionen werden nicht für Unternehmen mit deaktivierter Konsolidierung unterstützt.
Eigenschaften der Journaleingabeversion:
Die folgenden Eigenschaften sind unter dem verschachtelten Objekt „journalEntryVersionProperties“ vorhanden (siehe Beispielanforderungstext) und werden nur für JE-Versionen verwendet:
Eigenschaften
Beschreibung
Erforderlich (für Istzahlen)
Erforderlich (für Journaleingaben)
Name der Eigenschaft im Anforderungstext
Wertart
Standardwert
Journaleingabenummerierung
Geben Sie an, wie Journaleingaben nummeriert werden sollen. Kann entweder automatisch (A), manuell (M) oder nicht (N) erfolgen.
Nicht verwendet
N
journalEntryNumbering
String
Keine (N)
Präfix
Präfix der Journaleingabenummerierung
Nicht verwendet
Y, wenn die Journaleingabenummerierung automatisch (A) oder manuell (M) erfolgt
prefix
String
Startnummer
Startnummer der Journaleingabenummerierung
Nicht verwendet
Y, wenn Journaleingabenummerierung (A)
Startnummer
Ganzzahl
Root-Istzahlen-spezifische Eigenschaften:
Die folgenden Eigenschaften werden nur beim Aktualisieren von Root-Istzahlen verwendet:
Eigenschaften
Beschreibung
Erforderlich
Name der Eigenschaft im Anforderungstext
Wertart
Versionsstart
Versionsstart
N
startOfVersion
Zeichenfolge (Zeitperiodencode)
Versionsende
Versionsende
N
endOfVersion
Zeichenfolge (Zeitperiodencode)
Bildlaufanfangsposition
Bildlaufanfangsposition der Version
N
startingScrollLocation
Zeichenfolge (Zeitperiodencode)
Abgeschlossene Werte bis
Wann die Istzahlen-Überlagerung in der Planversion endet
N
completedValuesThrough
Zeichenfolge (Zeitperiodencode)
Workflow aktivieren
Ermöglicht die Übermittlung von Istzahlen nach Ebene im Workflow.
N
endableWorkflow
Boolesch
Beispielanforderungstext:
Anforderungstext
 
{
        "parent": "Parent Version",
        "versionType": "ACTUALS",
        ...
        "administratorsAccess": "FULL_ACCESS",
        "usersAccess": "IMPORT_AND_NOTES",
        ...
        ...
        "auditTrail": true
}
Beispiel für Anforderungstext für Versionen mit verschachtelten Eigenschaften (Journaleingabe-Versionen und virtuelle Versionen):
Anforderungstext
 
{
        "parent": "Actuals",
        "versionType": "ACTUALS",
        "shortName": "test JE version",
        "journalEntryVersion": "true",
        "journalEntryVersionProperties": {
                "journalEntryNumbering": "A",
                "prefix": "JE-Prefix",
                "startingNumber": "25"
        },
        ...
        "auditTrail": true
}
Abfrageparameter:
Name
Beschreibung
Erforderlich
versionName
Name der neuen Version, die erstellt werden soll, oder der vorhandenen Version, die aktualisiert werden soll.
J
proceedWithWarnings
Ein optionaler Abfrageparameter, mit dem Warnmeldungen geschlossen werden. Ist diese Option nicht auf „true“ gesetzt, werden potenzielle Warnungen zurückgegeben, bevor der Aufruf ausgeführt wird. Verwerfen Sie sie, indem Sie diesen Parameter in der URL auf „true“ setzen.
N
instanceCode
instanceCode, aus dem Werte abgerufen werden sollen. Beispiel: GLOBO. Wenn kein instanceCode angegeben wird, wird die Standardinstanz des Benutzers verwendet.
N
Pfadparameter:
Name
Beschreibung
Erforderlich
Mandant
Der Mandant, auf dem gearbeitet werden soll, z. B. GREENCO
J
Eigenschaften für Veröffentlichungszugriff:
Die folgenden Eigenschaften für den Anforderungstext werden nur verwendet, wenn „WD“ aktiviert ist:
Beispielantwort
204 NO_CONTENT
Erfolgreiche Antwort ist leer mit Statuscode 204.

POST

Anfrage:
/api/rest/modeling/v1/{tenant}/ cloneVersion:
Erstellt eine neue Planversion
Erstellt eine neue Plan- oder Vorhersageversion durch Klonen einer Quell-/Standardversion oder erstellt eine virtuelle Version.
Derzeit werden zwei Gruppen von Versions-IDs, die über Abfrageparameter unterstützt werden:
Neuer Versionsname
In der URL muss für jeden Aufruf nur eine der oben genannten Optionen angegeben werden
Beispiel für eine Anforderungs-URI:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/cloneVersion?newVersionName=Budget 2012&
sourceVersionName=Budget 2011&
copyAllData=true&
copySharedFormulasAndRules=true&
copyAllOverrideFormulas=false
Anforderungstext:
JSON, die die Versionseigenschaften enthält, die für die zu erstellende neue Version anzugeben sind.
Name
Beschreibung
Erforderlich (für Plan)
Erforderlich (für Prädiktiv)
Erforderlich (für virtuell)
Name der Eigenschaft im Anforderungstext
Wertart
Standardwert
Kurzname
Kurzname der Version.
N
N
N
shortName
String
leere Zeichenfolge
Übergeordnet
Übergeordneter Ordner dieser Version.
N
N
N
Übergeordnetes Element
Zeichenfolge (Ordnername)
Versionsart
Versionsart (IST oder PLANNING)
Y, PLANNING
Y, PLANNING
Y, PLANNING
versionType
String
Beschreibung
Beschreibung.
N
N
N
Beschreibung
String
leere Zeichenfolge
Gesperrte Version
Sperrt die gesamte Version für alle Benutzer, einschließlich Hauptformeln und anderer Kontoformeln.
N
Nicht verwendet
Nicht verwendet
lockedVersion
Boolesch
Von Quellversion geerbt
Formelwerte berechnen
Verfügbar für Planversionen, bei denen Gesperrte Version aktiviert ist. Wird verwendet, um die berechneten Ergebnisse von Formeln und Referenzen in den meisten Konten beizubehalten und die Performance gesperrter Versionen zu verbessern.
N
Nicht verwendet
Nicht verwendet
calculateFormulaValues
Boolesch
false
Administratorenzugriff
Versionszugriffsebene für Administratoren
N
N
N
administratorsAccess
VersionAccessControl
von Quellversion (Plan) geerbt; Import_and_notes (prädiktiv); gesperrt (Virtuell)
Benutzerzugriff
Versionszugriffsebene für Benutzer.
N
N
N
BenutzerZugriff
VersionAccessControl
von Quellversion (Plan) geerbt; Import_and_notes (prädiktiv); gesperrt (Virtuell)
Bearbeitungszugriff auf Tabellenblätter
Versionszugriffsebene für alle Personen mit der Berechtigung Bearbeitungszugriff auf Tabellenblätter.
N
N
N
editableSheetAccess
VersionAccessControl
von Quellversion geerbt (Plan, Prädiktiv)
Gruppen-ID
ID einer bestimmten Benutzergruppe.
N
N
N
groupId
Ganzzahl
von Quellversion geerbt (Plan, Prädiktiv)
Zugriffsebene
Versionszugriffsebene der angegebenen Benutzergruppe.
N
N
N
groupAccessLevel
VersionAccessControl
von Quellversion geerbt (Plan, Prädiktiv)
Linke Bildlaufbegrenzung
Linke Bildlaufbegrenzung der Version.
N
N
Nicht verwendet
startOfVersion
Zeichenfolge (Zeitperiodencode)
Von Quellversion geerbt
Planende
Planende
N
N
Nicht verwendet
endOfPlan
Zeichenfolge (Zeitperiodencode)
Von Quellversion geerbt
Planstart
Planstart
N
N
Nicht verwendet
startOfPlan
Zeichenfolge (Zeitperiodencode)
Von Quellversion geerbt
Vorausgehende Zeitperiode sperren
Sorgt dafür, dass bestimmte Datenperioden in der Version nicht mehr bearbeitbar sind. Wird auf der Benutzeroberfläche angezeigt als „Vorausgehende {leaf Schicht} sperren bis“.
N
Nicht verwendet
Nicht verwendet
lockLeadingTimePeriod
Zeichenfolge (Zeitperiodencode)
Von Quellversion geerbt
Vorausgehenden Abschluss sperren
Die Option "Abschluss {leaf Stratum}" für die Eigenschaft oben. Diese Eigenschaft und "Vorausgehende Zeitperiode sperren" können nicht gleichzeitig im Anforderungstext angegeben werden.
N
Nicht verwendet
Nicht verwendet
lockLeadingCompletion
Boolesch
Von Quellversion geerbt
Standard
Macht die Version zur Standardversion für alle Benutzer.
N
Nicht verwendet
Nicht verwendet
Standard
Boolesch
false
Audit-Trail
Audit-Trail-Informationen beibehalten/löschen.
N
N
Nicht verwendet
auditTrail
Boolesch
Von Quellversion geerbt
Istzahlen-Überlagerung enthält nicht verfügbare Ebenen
Zeigt alle Ebenen, auch die nicht mehr verwendeten, in Istzahlen-Überlagerungen an.
N
N
Nicht verwendet
actualsOverlayIncludesUnavailableLevels
Boolesch
false
Istzahlen-Version für Überlagerung
Überlagert die Plandaten mit den Daten der angegebenen Istzahlen-Version.
N
N
Nicht verwendet
actualsVersionOverlay
Zeichenfolge (Versionsname)
Root-Istzahlen-Version
Führen Sie einen Drilldown in die Transaktions-ID durch
Ermöglicht einen Drill zu Transaktionen für die Version.
N
N
Nicht verwendet
drillIntoTransactionId
Ganzzahl
Standardbericht
Prädiktive Version
Ob die zu erstellende Version eine prädiktive Version ist
Nicht verwendet
Y, wahr
Nicht verwendet
predictiveVersion
Boolesch
Virtuelle Version
Ob die zu erstellende Version eine virtuelle Version ist
Nicht verwendet
Nicht verwendet
Y, wahr
virtualVersion
Boolesch
returnId
Es wird eine Versions-ID zurückgegeben, wenn es auf „true“ gesetzt ist. Neue Versions-ID, wenn der Vorgang eine neue Version erstellt hat. Andernfalls wird die ID der vorhandenen Version zurückgegeben, die aktualisiert wurde.
N
N
N
returnId
Boolesch
false (gibt 204 „Kein Inhalt“ als „false“ zurück; gibt die Antwort 200 OK mit Version in zurück, wenn sie auf „true“ gesetzt ist)
– Die Wertart „VersionAccessControl“ kann die folgenden Zeichenfolgenwerte annehmen: "HIDDEN", "Versperrt", "sperred_EXCEPT_NOtes", "IMport_AND_NOtes", "FULL_ACCESS"
– Gesperrte Planversionen können für keine Benutzergruppe "IMport_AND_NOtes" oder "FULL_ACCESS" festgelegt haben.
- In prädiktiven Versionen kann "FULL_ACCESS" für keine Benutzergruppe festgelegt werden.
-Virtuelle Versionen können für jede Benutzergruppe nur "AUSGEBLENDET" oder "Gesperrt" festlegen.
– Für Unternehmen, für die eine Konsolidierung ohne Planung aktiviert ist, können keine Plan- und prädiktiven Versionen erstellt werden.
Virtuelle Eigenschaften der Version
Die folgenden Eigenschaften sind unter dem verschachtelten Objekt VirtualVersionProperties vorhanden und werden nur für virtuelle Versionen verwendet:
Name
Beschreibung
Erforderlich (für Plan)
Erforderlich (für Prädiktiv)
Erforderlich (für virtuell)
Name der Eigenschaft im Anforderungstext
Wertart
Standardwert
Basisversion
Die Version, die die Basisdaten für die virtuelle Version bereitstellt. Darf keine virtuelle Version oder Unter-Istzahlen-Version sein.
Nicht verwendet
Nicht verwendet
N
baseVersion
Zeichenfolge (Versionsname)
Standardversion
Wechselkursversion
Die Version, die den Wechselkurs für die virtuelle Version bereitstellt, die für Berichte mit Konstantwährungen genutzt wird. Darf keine virtuelle Version oder Unter-Istzahlen-Version sein.
Nicht verwendet
Nicht verwendet
N
exchangeRateVersion
Zeichenfolge (Versionsname)
Root-Istzahlen-Version
Konstantwährungsreporting aktivieren
Aktivieren/deaktivieren Sie das Konstantwährungsreporting.
Nicht verwendet
Nicht verwendet
N
enableConstantCurrencyReporting
Boolesch
false
Zeitversatz
Betrag des Zeitversatzes rückwärts (Positive Ganzzahl) oder Vorwärts (negative Ganzzahl)
Nicht verwendet
Nicht verwendet
N
offset
Ganzzahl
0
Eigenschaften für Veröffentlichungszugriff
Die folgenden Eigenschaften für den Anforderungstext werden nur verwendet, wenn „WD“ aktiviert ist:
Name
Beschreibung
Erforderlich (für Plan)
Erforderlich (für Prädiktiv)
Erforderlich (für virtuell)
Name der Eigenschaft im Anforderungstext
Wertart
Standardwert
Finanzpläne
Finanzpläne für diese Version aktivieren/deaktivieren.
Wird nur verwendet, wenn Adaptive Planning für Finanzpläne aktiviert ist.
N
Nicht verwendet
Nicht verwendet
financialPlans
Boolesch
false
Headcount-Pläne
Aktivieren/deaktivieren Sie Headcount-Pläne für diese Version.
Wird nur verwendet, wenn entweder Adaptive Planning für Financial Plans oder Adaptive Planning für das Personal aktiviert ist.
N
Nicht verwendet
Nicht verwendet
headcountPlans
Boolesch
false
Personalaktionspläne
Aktivieren/deaktivieren Sie Personalaktionspläne für diese Version.
Wird nur verwendet, wenn Adaptive Planning für das Personal aktiviert ist.
N
Nicht verwendet
Nicht verwendet
workforceActionPlans
Boolesch
false
Beispielanforderungstext
Anforderungstext
 
{
        "parent": "Parent Folder",
        "versionType": "PLANNING",
        "description": "Test Plan Version",
        ...
        ...
        "usersAccess": "LOCKED_EXCEPT_NOTES",
        "editableSheetAccess": "LOCKED",
        ...
        "startOfVersion": "2012",
        "endOfVersion": "2013",
        "startingScrollLocation": "01/2012",
        "lockLeadingTimePeriod": "02/2012",
        "actualsOverlayIncludesUnavailableLevels": true
}
Abfrageparameter
Name
Beschreibung
Erforderlich (für Plan)
Erforderlich (für Prädiktiv)
Erforderlich (für virtuell)
Parametername in URL
Standardwert
Name der Quellversion
Der Name der Version, aus der geklont werden soll. Wenn nicht angegeben, wird aus der Standardversion geklont.
N
N
Nicht verwendet
sourceVersionName
Neuer Versionsname
Name der neuen Version, die erstellt werden soll.
J
J
J
newVersionName
Alle Daten kopieren
Bei wahr werden alle Daten kopiert.
N
Nicht verwendet
Nicht verwendet
copyAllData
false
Geteilte Formeln und Regeln kopieren
Bei wahr werden geteilte Formeln und Regeln kopiert.
N
Nicht verwendet
Nicht verwendet
copySharedFormulasAndRules
false
Alle Überschreibungsformeln kopieren
Bei wahr werden alle Überschreibungsformeln kopiert.
N
N
Nicht verwendet
copyAllOverrideFormulas
false
Splits in Hauptbuch- und benutzerdefinierten Konten kopieren
Bei wahr werden Splits in Hauptbuch- und benutzerdefinierten Konten kopiert.
N
Nicht verwendet
Nicht verwendet
copySplitsInGLAndCustomAccounts
false
Modellierte Zeilen kopieren
Bei wahr werden modellierte Zeilen kopiert.
N
Nicht verwendet
Nicht verwendet
copyModeledRows
false
Zellen, Tabellenblatt und Workflow-Notizen kopieren
Bei wahr werden Zellen-, Tabellenblatt- und Workflow-Notizen kopiert (falls zutreffend).
N
Nicht verwendet
Nicht verwendet
copyAllNotes
false
Workflow-Status auf "In Bearbeitung" zurücksetzen
Bei wahr wird der Workflow-Status auf „In Bearbeitung“ zurückgesetzt.
N
Nicht verwendet
Nicht verwendet
resetWorkflowStatusToInProgress
false
Audit-Trail-Historie kopieren
Bei wahr wird allen Berichten die Auswahl für den Berichtsparameter hinzugefügt.
Nicht verwendet
Nicht verwendet
copyAuditTrailHistory
false
Als Auswahl für Berichtsparameter zu allen Berichten hinzufügen
Bei wahr wird allen Berichten die Auswahl für den Berichtsparameter hinzugefügt.
N
Nicht verwendet
Nicht verwendet
addAsReportParameterChoiceToAllReports
false
Neu berechnete Werte von Tabellenblättern kopieren
Bei wahr werden neu berechnete Werte von Tabellenblättern kopiert.
N
Nicht verwendet
Nicht verwendet
copyRecalculatedValuesOfSheets
false
Mit Warnungen fortfahren
Ein optionaler Abfrageparameter, mit dem Warnmeldungen geschlossen werden. Ist diese Option nicht auf „true“ gesetzt, werden potenzielle Warnungen zurückgegeben, bevor der Aufruf ausgeführt wird. Verwerfen Sie sie, indem Sie diesen Parameter in der URL auf „true“ setzen.
N
N
N
proceedWithWarnings
false
Instanz Code
instanceCode, aus dem Werte abgerufen werden sollen. Beispiel: GLOBO. Wenn kein instanceCode angegeben wird, wird die Standardinstanz des Benutzers verwendet.
N
N
N
instanceCode
Standardinstanz des Benutzers
-"Workflow-Status auf "In Bearbeitung" zurücksetzen wird nicht für Unternehmen mit deaktiviertem Workflow unterstützt.
-"Neu berechnete Werte von Tabellenblättern kopieren" wird nicht unterstützt, wenn das Feature Flag modellierter ISOLATION deaktiviert ist.
Pfadparameter:
Name
Beschreibung
Erforderlich
Mandant
Der Mandant, auf dem gearbeitet werden soll, z. B. GREENCO
J
Beispielantwort:
204 NO_CONTENT
Erfolgreiche Antwort ist leer mit Statuscode 204.