publishChanges

Categoria	Pubblicazione amministratore
Descrizione	Pubblicare le modifiche in attesa.
Autorizzazioni necessarie per richiamare	Devono essere credenziali valide per l'istanza e l'autorizzazione "Pubblica modifiche amministratore". L'istanza deve avere la pubblicazione amministratore abilitata.
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="publishChanges" 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é la chiamata API avere 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

Se la richiesta viene ricevuta senza modifiche in batch, la risposta è "Pubblicazione completata" con "publishedCount" = 0.

L'esito positivo è il momento in cui, a seguito di n modifiche non pubblicate, tutte le n vengono pubblicate.

In una pubblicazione completata, l'output contiene un elemento publishResponse con un attributo PublishedCount che indica il numero di modifiche pubblicate.

In una pubblicazione non riuscita, l'output contiene un elemento publishResponse con lo stesso attributo PublishedCount e un attributo notPublishedCount che elenca il numero di modifiche non pubblicate.

Esempio di successo


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

Esempio di errore


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

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 di conti. Questo wrapper di output è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita.

elemento publishResponse
Nome tag		publishResponse
Descrizione		La risposta a una richiesta di modifica di pubblicazione. Contiene informazioni sullo stato delle modifiche non pubblicate o sul risultato di una pubblicazione.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
PublishedCount	S	Il numero di modifiche che sono state pubblicate.	6
notPublishedCount	N	Il numero di modifiche che NON sono state pubblicate. Incluso con una risposta di "pubblicazione" non riuscita.	2
Contenuto dell'elemento
(nessuno)