API di piattaforma > JamioPlug > JamioPlug ExternalDocument

Crea una cartella all'interno di un'altra padre, identificata tramite il suo collegamento, con fallback su percorso simbolico nella Configurazione di JamioPlug ExternalDocument.

Metodo

PlugExternalDocument/CreateFolderByParentReference

Input
Nome	Descrizione	Tipo	Opzionale
token	Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).	String	Y
folderName	Nome base della nuova cartella.	String
parentFolderReference	Collegamento ExternalDocument della cartella padre. Il carattere "/" deve essere utilizzato come separatore tra i nodi della gerarchia.	Reference
parentPath	Percorso simbolico della cartella padre utilizzato come fallback. Il carattere "/" deve essere utilizzato come separatore tra i nodi della gerarchia.	String	Y
separator	Separatore della composizione; non può essere il carattere "/", né un carattere non ammesso.	String	Y
insertCounter	Indica se inserire il contatore.	Boolean
auto	Determina automaticamente il progressivo; ignorato con insertCounter=false.	Boolean
digitNumber	Numero di digit del counter; ignorato con insertCounter=false.	Integer	Y
counter	Progressivo manuale; ignorato con insertCounter=false.	Integer	Y
counterPosition	Posizione del counter, assume i valori: •0 = PrePrefix •1 = PostPrefix •2 = PreSuffix •3 = PostSuffix. Necessario quando il counter viene inserito.	Integer
prefix	Prefisso opzionale.	String	Y
suffix	Suffisso opzionale.	String	Y
Output
Nome	Descrizione	Tipo	Opzionale
returnValue	Dato strutturato che contiene i seguenti campi: WebUrl: testo che riporta l'URL della cartella creata/esistente. FolderReference: collegamento alla cartella creata/esistente. FolderAlreadyExists: booleano che assume il valore True se la cartella finale esisteva già e non è stata creata.	DataSet

Commenti

Il metodo tenta prioritariamente l'individuazione della cartella padre tramite collegamento.

Se il collegamento non è più valido e il percorso della cartella padre è valorizzato, il fallback viene eseguito nella configurazione del collegamento.

Il separatore viene applicato solo tra componenti presenti e non può essere il carattere "/" né un carattere non ammesso.

Se i parametri insertCounter è True, auto è False e counter è valorizzato, il counter viene inserito nella posizione definita in counterPosition e digitNumber viene applicato se valorizzato.

Se i parametri insertCounter e auto sono True, viene creato il progressivo successivo rispetto al massimo esistente, oppure 1 in assenza di progressivi.

digitNumber applica padding; se è insufficiente viene restituito un errore specifico.

Il metodo non applica metadati. Il nome finale viene normalizzato secondo le regole Jamio.

Il metodo si comporta come segue:

Restituisce	Condizione
DataSet	Se parentFolderReference individua una cartella e il nome finale non esiste, la nuova cartella viene creata nella cartella padre e FolderAlreadyExists è false.
DataSet	Se parentFolderReference non individua più la cartella padre e parentPath individua la cartella padre nella configurazione del Collegamento, la cartella viene creata nella cartella padre individuata simbolicamente.
Errore	Se la cartella padre non viene individuata, viene restituito ParentFolderNotFound.
DataSet	Se la cartella padre è individuata e il nome finale esiste già, la cartella non viene creata, FolderAlreadyExists è true e vengono restituiti FolderReference e WebUrl.
DataSet	Se prefix e suffix sono valorizzati, viene composto il nome finale applicando separator solo tra componenti presenti.
DataSet	Se viene applicato un counter, viene utilizzato il counter manuale oppure il progressivo automatico successivo.

Tracciamento

Durante l'esecuzione di CreateFolderByParentReference viene registrata la metrica Request.

Autorizzazioni

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