CustomizeDocumentsByCatalog

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > Servizi Core > Jamio Document >

CustomizeDocumentsByCatalog

Aggiorna all’ultima versione il modello associato ed eventualmente i valori dei campi di Documenti contenuti in un catalogo.

 

Metodo

JamioResource/CustomizeDocumentsByCatalog

 

Input

Nome

Descrizione

Tipo

Opzionale

token

Il token di sessione (per la sessione corrente, nel Dominio corrente, potrebbe essere nullo o vuoto).

String

Y

catalogReference

Collegamento al catalogo contenente i Documenti da aggiornare.

Reference

 

parameters

Parametri di filtro da applicare al catalogo, eventuali valori impostati per la paginazione e l'ordinamento vengono ignorati.

SearchParameters

Y

updateFields

Lista chiave-valore contenente i nomi dei campi e i rispettivi valori eventualmente da aggiornare nei Documenti della lista.

Dataset

Y

versionChangeType

Eventuale variazione applicata alla Versione dei Documenti. Il valore di default è NoChange.

VersionChangeType

 

versionLabel

Eventuale valore da assegnare alla proprietà VersionLabel dei Documenti. Il valore di default è stringa vuota.

String

Y

versionChangeDescription

Eventuale valore da assegnare alla proprietà VersionChangeDescription dei Documenti che indica il dettaglio delle modifiche apportate al documento. Il valore di default è “Aggiornamento modello”.

String

Y

Output

Nome

Descrizione

Tipo

Opzionale

returnValue

Dato strutturato con i seguenti campi:

TotalItems: numero totale di Documenti considerati;

ProcessedItems: numero di Documenti processati correttamente;

ScrappedItems: numero di Documenti processati con errore e/o non elaborati in seguito ad interruzione del job;

ScrapReport: collegamento ad un file CSV composto da tre colonne (url dei Documenti processati con errore, codice errore e descrizione).

JobStatus: stato finale del job (Completed o Canceled).

Dataset

 

 

Commenti

Se il parametro updateFields è stato valorizzato con una lista chiave-valore che contiene dei campi non presenti nelle risorse da personalizzare, il metodo li ignora.

 

Se il parametro updateFields è stato valorizzato con una lista chiave-valore, in cui alcuni valori sono vuoti (o nulli) vengono sovrascritti i valori dei corrispondenti campi dei Documenti (se nulli, vengono sovrascritti solo i valori dei campi del tipo compatibile, ad esempio testo breve, testo lungo etc... ).

 

I documenti che sono in modifica presso un utente non vengono processati.