unpublishedChangesStatus

Kategorie	Admin-Veröffentlichung
Beschreibung	Rufen Sie die Anzahl der unveröffentlichten Änderungen ab und bestimmen Sie, ob die administrative Veröffentlichung für die Instanz deaktiviert ist.
Zum Aufrufen sind Berechtigungen erforderlich	Es müssen gültige Zugangsdaten für die Instanz sein. Wenn die Admin-Veröffentlichung deaktiviert ist, sind keine zusätzlichen Berechtigungen erforderlich. Wenn Admin-Veröffentlichung aktiviert ist, muss der Benutzer über die Berechtigung „Administratoränderungen veröffentlichen“ verfügen.
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="unpublishedChangesStatus" 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 verfügen, um die Aktion in Reihenfolge für die API auszuführen -Aufruf 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

Dies sind Beispiele für Antworten, die für die Veröffentlichung durch Administratoren aktiviert und deaktiviert wurden.

Beispiel für „Admin-Veröffentlichung aktiviert“.


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <output>
        <unpublishedStatus adminPublishingEnabled="1" numberToPublish="3" />
    </output>
</response>

Beispiel für deaktivierte Veröffentlichung von Admin-Veröffentlichungen


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <output>
        <unpublishedStatus adminPublishingEnabled="0" />
    </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 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 erforderliches unveröffentlichtes Statuselement. Dieser Ausgabe-Wraper ist ein Standard für alle API-Antworten und schließt die gültige Ausgabe jedes erfolgreichen API-Aufrufs ein.

unpublishedStatus element
Tag-Name		unpublishedStatus
Beschreibung		Die Antwort auf eine nicht veröffentlichte AnforderungChangesStatus. Enthält Informationen darüber, ob die Admin-Veröffentlichung aktiviert ist und wenn ja, wie viele unveröffentlichte Änderungen vorhanden sind.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
adminVeröffentlichenAktiviert	J	Ob Admin-Veröffentlichung für diese Instanz aktiviert ist oder nicht (0 = nicht aktiviert, 1 = aktiviert).	1
numberToPublish	N	Wie viele unveröffentlichte Änderungen es gibt. Wird nur angezeigt, wenn Admin-Veröffentlichung aktiviert ist. Wenn keine unveröffentlichten Änderungen vorhanden sind, ist der Wert 0.	2
Inhalt des Elements
(Keine)