ReadFileByPath

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug ExternalDocument >

ReadFileByPath

Legge un file a partire dal suo nome, configurazione e percorso nella Configurazione di JamioPlug ExternalDocument.

 

Metodo

PlugExternalDocument/ReadFileByPath

 

Input

Nome

Descrizione

Tipo

Opzionale

token

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

String

Y

configurationReference

Collegamento alla risorsa di tipo configurazione del Plug ExternalDocument che determina la root operativa.

E' possibile specificare un collegamento in cui è valorizzata solo la proprietà Name con il Nickname di una configurazione esistente.

Reference

 

path

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

String

Y

fileName

Nome del file.

String

 

Output

Nome

Descrizione

Tipo

Opzionale

returnValue

DataSet che contiene i seguenti campi:

•FileReference: collegamento al 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

In assenza di percorso viene utilizzata la root operativa.

Il file deve essere individuato univocamente.

Il metodo crea un allegato di processo e restituisce il collegamento al file.

 

Il metodo si comporta come segue:

Restituisce

Condizione

Un allegato di processo e il returnValue di output.

Se i parametri configurationReference, path e fileName individuano un file, viene creato un allegato di processo

Un allegato di processo e il returnValue di output.

Se path non è valorizzato, il file viene cercato nella root operativa.

Errore FileNotFound.

Se nessun file 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.