ReadFileByReference

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug ExternalDocument >

ReadFileByReference

Legge un file a partire dal suocollegamento, usando il percorso della cartella e il nome del file come fallback nella Configurazione di JamioPlug ExternalDocument.

 

Metodo

PlugExternalDocument/ReadFileByReference

 

Input

Nome

Descrizione

Tipo

Opzionale

token

Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).

String

Y

fileReference

Collegamento External Document del file.

Reference

 

folderPath

Percorso utilizzabile nel fallback. Il carattere "/" deve essere utilizzato come separatore tra i nodi della gerarchia.

String

Y

fileName

Nome del file utilizzabile nel fallback.

String

Y

Output

Nome

Descrizione

Tipo

Opzionale

returnValue

Dato strutturato che contiene i seguenti campi:

•StreamReference: collegamento all'allegato di processo creato.

•FileReference: collegamento del file.

•WebUrl: campo di tipo testo che riporta l'URL corrente.

•MetadataProfile: campo di tipo testo che contiene il profilo metadati corrente del file; per Microsoft SharePoint corrisponde al ContentType.

•BusinessMetadata: dato strutturato che riporta i metadati correnti del file, esclusi i valori nulli.

DataSet


 

Commenti

Il metodo tenta prioritariamente la lettura del file tramite il suo collegamento.

Il fallback usa la configurazione ricavata dal Collegamento e richiede le informazioni necessarie per individuare un solo file.

 

Il metodo si comporta come segue:

Restituisce

Condizione

Un allegato di processo e il returnValue di output.

Se il parametro fileReference identifica il file, viene creato un allegato di processo e viene restituito il dato strutturato di output.

Un allegato di processo e il returnValue di output.

Se il parametro fileReference non individua più il file e folderPath e fileName individuano un solo file, il file viene letto tramite fallback.

Errore FileNotFound.

Se il file non viene individuato.

Errore MultipleFilesFound.

Se vengono individuati più file.

 

Autorizzazioni

Per eseguire il metodo e necessario possedere il permesso di Utilizzo sulla Configurazione del Plug ExternalDocument.