publishChanges

Kategorie	Admin-Veröffentlichung
Beschreibung	Veröffentlichen Sie alle anstehenden Änderungen.
Zum Aufrufen sind Berechtigungen erforderlich	Es müssen gültige Zugangsdaten für die Instanz und die Berechtigung "Administratoränderungen veröffentlichen" vorhanden sein. Für die Instanz muss Admin-Veröffentlichung aktiviert sein.
Auf Anforderung erforderliche Parameter	Zugangsdaten

Die Anforderung dieser Methode enthält ein Credentials-Tag, um den aufrufenden Benutzer zu identifizieren und zu autorisieren. Nach der Verifizierung werden mit dieser Methode alle Batch-Änderungen veröffentlicht. Optional kann die Anforderung ein Aktions-Tag enthalten.

Anforderungsformat


<?xml version='1.0' encoding='UTF-8'?>
<call method="publishChanges" 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)

Antwortformat

Wenn die Anforderung ohne Batch-Änderungen eingeht, lautet die Antwort "Publish Success" mit "PublishedCount" = 0.

Ein Erfolg liegt vor, wenn bei n unveröffentlichten Änderungen alle n erfolgreich veröffentlicht wurden.

Bei einer erfolgreichen Veröffentlichung enthält die Ausgabe das Element publishResponse mit dem Attribut publishCount, das die Anzahl der veröffentlichten Änderungen angibt.

Bei einer nicht erfolgreichen Veröffentlichung enthält die Ausgabe ein Element publishResponse mit demselben Attribut publishCount und ein Attribut notPublishedCount, das die Anzahl der nicht veröffentlichten Änderungen auflistet.

Erfolgreiches Beispiel


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <output>
        <publishResponse publishedCount="3" />
    </output>
</response>

Fehlerbeispiel


 <?xml version='1.0' encoding='UTF-8'?>
 <response success="false">
   <messages>
       <message type="ERROR">Publish Error</message>
   </messages>
   <output>
       <publishResponse publishedCount="0" notPublishedCount="2" />
   </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 und offiziell veraltet ist. 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.

publishResponse-Element
Tag-Name		publishResponse
Beschreibung		Die Antwort auf eine Anforderung von Änderungsveröffentlichungen. Enthält Informationen zum Status unveröffentlichter Änderungen oder zum Ergebnis einer Veröffentlichung.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
publishedCount	J	Die Anzahl der Änderungen, die erfolgreich veröffentlicht wurden.	6
notPublishedCount	N	Die Anzahl der Änderungen, die NICHT veröffentlicht wurden. Enthalten in einer nicht erfolgreichen Antwort "Veröffentlichen".	2
Inhalt des Elements
(Keine)