Massenaktualisierung von Metadaten
Wird unterstützt in API v17 +
Der wichtigste Vorteil von APIs für die Massenaktualisierung von Metadaten besteht darin, dass sie die Synchronisierung von Ebenen, Dimensionen und Hauptbuch-Konten in ermöglichen
Adaptive Planning
mit Kollegen in einem externen System regelmäßig und geplant. Anstatt einzelne Elemente einzeln aufzurufen, können Sie mit diesen APIs eine unformatierte XML-Datei oder verschlüsseltes (gezipptes) XML übermitteln, um Elemente zu aktualisieren, neu anzuordnen und zu erstellen.Bei Metadaten-Massen-APIs wird die neue Version des Baums vorhandener Elemente in importiert
Adaptive Planning
.APIs für die Massenaktualisierung von Metadaten:
- Nie löschen. Elemente, die in der hochgeladenen Version fehlen, bleiben davon unberührt.
- Erstellen Sie alle neuen Elemente aus dem Upload, sofern möglich.
- Aktualisieren Sie die Eigenschaften aller hochgeladenen Elemente, einschließlich ihrer übergeordneten Eigenschaften.
- Aktualisieren Sie die hochgeladenen Attributzuweisungen.
- Sie ermöglichen speziell das teilweise Hochladen von Baumblättern (da ein Löschvorgang nie durchgeführt wird, sind teilweise Uploads nicht destruktiv).
- Damit können die vorhandenen Elemente in einem Baum entweder anhand ihrer internen ID-Nummer oder anhand ihres „ursprünglichen“ (vor Aktualisierung) Felds zur eindeutigen ID identifiziert werden.
- Stoppen Sie bei tragischen Fehlern und führen Sie einen Rollback durch. Zu den kritischsten Fehlern gehören:
- Versucht, einen Zyklus in einer Hierarchie zu erstellen
- Versucht, ein neues Element zu erstellen, dessen identifizierendes Feld mit einem bereits im System vorhandenen Feld übereinstimmt (z. B. Erstellen eines neuen Kontos mit einem bereits verwendeten Code)
- Versucht, das identifizierende Feld eines Elements so zu aktualisieren, dass es mit einem bereits im System vorhandenen Feld bricht.
- Fahren Sie bei ignorierenden Fehlern fort, die den Import nicht stoppen, und melden Sie die Ergebnisantwort als Warnungen. Zu den ignorierenden Fehlern gehören diejenigen, die wahrscheinlich keine kaskadierende Auswirkung haben, wie z. B.:
- Versucht, eine Attributzuweisung in einen nicht vorhandenen Wert zu ändern.
- Versucht, einen Ebenennamen auf einen Namen zu setzen, der zu lang für das Feld ist.
Massen-Upload mit zusammengefasstem XML (gezippt)
Bei großen Nutzlasten können Sie zusammengefasste Inhalte als ZIP-Datei hochladen, die nur die XML-Datei der Aktualisierungen ohne Unterverzeichnisse, Ordner oder andere Inhalte enthält. Wenn Ordner oder Unterverzeichnisse bei der Postzuordnung in der ZIP-Datei gefunden werden, wird die Anforderung abgelehnt.
Hängen Sie eine Beispieldatei für Rollup in XML (gezippt) an
curl -i -X POST -H "Content-Type: multipart/form-data" -F "request=<C:/temp/requestUpdateDimVal.xml" -F "content=@C:/temp/updateDimensions.zip" https://api.adaptiveplanning.com/api/v20
requestUpdateDimVal.xml content
<?xml version='1.0' encoding='UTF-8'?> <call method="updateDimensions" callerName="Steve C"> <credentials login="sampleuser@company.com" password="my_password"/> </call>
updateDimVal.zip/content.xml
<?xml version='1.0' encoding='UTF-8'?> <dimensions> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0"> <dimensionValue id="32" name="Graduate" description="Modified Graduate degree" /> </dimension> </dimensions>
Sie können weiterhin API-Anforderungen im Text eines API-Aufrufs stellen, ohne Anhänge zu verwenden.
<?xml version='1.0' encoding='UTF-8'?> <call method="updateDimensions" callerName="Steve C"> <credentials login="sampleuser@company.com" password="my_password"/> <dimensions> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0"> <dimensionValue id="32" name="Graduate" description="Modified Graduate degree" /> </dimension> </dimensions> </call>