unpublishedChangesStatus

Categoria	Pubblicazione amministratore
Descrizione	Recuperare il numero di modifiche non pubblicate e determinare se la pubblicazione dell'amministratore è disabilitata per l'istanza.
Autorizzazioni necessarie per richiamare	Devono essere credenziali valide per l'istanza. Se la pubblicazione dell'amministratore è disabilitata, non sono necessarie autorizzazioni aggiuntive. Se la pubblicazione amministratore è abilitata, l'utente deve disporre dell'autorizzazione Pubblica modifiche amministratore.
Parametri obbligatori su richiesta	Credenziali

La richiesta di questo metodo contiene un tag delle credenziali per identificare e autorizzare l'utente chiamante. Una volta verificato, questo metodo pubblicherà le modifiche in batch. Facoltativamente, la richiesta può contenere un tag azione.

Formato richiesta


<?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>

elemento credenziali
Nome tag		credenziali
Descrizione		Tutte le chiamate API devono contenere un singolo elemento di credenziali per identificare l'utente che richiama l'API. La chiamata API viene quindi eseguita come utente (qualsiasi audit trail o storico delle azioni nel sistema mostrerà che l'azione è stata eseguita dall'utente) e pertanto l'utente deve disporre delle autorizzazioni necessarie per eseguire l'azione affinché l'API chiamata per ottenere l'esito positivo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
accedere	S	Il nome di accesso dell'utente che richiama il metodo API. L'utente deve disporre delle autorizzazioni necessarie per richiamare il metodo.	sampleuser@company.com
password	S	La password dell'utente che richiama il metodo API.	my_password
impostazioni internazionali	N	Specificare le impostazioni internazionali da utilizzare per interpretare i numeri e le date in entrata e per formattare i numeri e le date in uscita (utilizzando il separatore delle migliaia, i nomi dei mesi e la formattazione della data appropriati). Le impostazioni internazionali vengono utilizzate anche per specificare la lingua in cui devono essere visualizzati i messaggi di sistema nella risposta. Se non viene specificato, viene utilizzato en_US (inglese americano).	fr_FR
instanceCode	N	Se l'utente specificato nelle credenziali ha accesso a più istanze di Adaptive Planning , questo attributo può essere utilizzato per specificare che l'utente intende accedere a un'istanza diversa da quella predefinita. Se non viene specificata, verrà utilizzata l'istanza predefinita dell'utente. Per determinare i codici di istanza disponibili, utilizzare l'API exportInstances.	MYINSTANCE1
Contenuto dell'elemento
(nessuno)

Formato risposta

Questi sono esempi di risposte per la pubblicazione amministratore abilitata e disabilitata.

Esempio di pubblicazione amministratore abilitata


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

Esempio di pubblicazione amministratore disabilitata


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

elemento di risposta
Nome tag		risposta
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	Vero o falso, a indicare se la chiamata API è riuscita o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.	true
obsoleto	N	Se presente nel tag di risposta e impostato su true, questo attributo indica che la versione del metodo o dell'API richiamata è diventata obsoleta ed è ufficialmente obsoleta. Sebbene continui a funzionare in questo momento, potrebbe cessare di funzionare in breve tempo. In genere, questo attributo non è presente.	falso
Contenuto dell'elemento
Un singolo elemento di messaggi facoltativo ed esattamente un elemento di output obbligatorio.

elemento di output
Nome tag	output
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Un singolo elemento obbligatorio unpublishedStatus. Questo wrapper di output è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita.

elemento unpublishedStatus
Nome tag		unpublishedStatus
Descrizione		La risposta a una richiesta ChangesStatus non pubblicata. Contiene informazioni sull'abilitazione della pubblicazione da parte degli amministratori e, in tal caso, sul numero di modifiche non pubblicate.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
adminPublishingEnabled	S	Indipendentemente dal fatto che la pubblicazione amministratore sia abilitata o meno per questa istanza (0=non abilitata, 1=abilitata).	1
numberToPublish	N	Quante modifiche non pubblicate sono presenti. Viene visualizzato solo se è abilitata la pubblicazione amministratore. Se non sono presenti modifiche non pubblicate, il valore è 0.	2
Contenuto dell'elemento
(nessuno)