NetDocuments

NetDocuments è un servizio di gestione dei contenuti cloud che consente alle aziende di tutte le dimensioni di creare, archiviare, gestire e condividere in modo sicuro il lavoro dei documenti ovunque, in qualsiasi momento.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio	Class	Regions
Copilot Studio	Normale	Tutte le aree di Power Automate , ad eccezione delle seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica	Normale	Tutte le aree di App per la logica , ad eccezione delle seguenti:      - Aree di Azure per enti pubblici      - Aree di Azure Cina      - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps	Normale	Tutte le aree di Power Apps , ad eccezione dei seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate	Normale	Tutte le aree di Power Automate , ad eccezione delle seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)

Contatto
URL	https://support.netdocuments.com/hc/en-us

Metadati del connettore
Editore	NetDocuments Software, Inc.
Sito web	https://www.netdocuments.com/
Informativa sulla privacy	https://www.netdocuments.com/privacy-policy/

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:

Predefinita	Parametri per la creazione della connessione.	Tutte le aree geografiche	Non condivisibile

Predefinito

Applicabile: tutte le aree

Parametri per la creazione della connessione.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Nome	TIPO	Description	Obbligatorio
Area geografica	corda	Area in cui risiede il documento net.	Vero

Limiti per la limitazione delle richieste

Nome	Chiamate	Periodo di rinnovo
Chiamate API per connessione	100	60 secondi

Azioni

Aggiornare il documento	Aggiornare il contenuto di un documento
Aggiornare un'area di lavoro	Aggiornare un'area di lavoro
Aggiungere o rimuovere l'utente dal repository	Aggiungere o rimuovere l'utente dal repository
Aggiungere o rimuovere un gruppo dal cabinet	Aggiungere un gruppo all'archivio cab e ai diritti di accesso predefiniti
Aggiungere o rimuovere un membro del gruppo	Aggiungere o rimuovere un membro del gruppo
Archiviare il documento	Archiviare un documento estratto
Blocca documento	Blocca documento
Bloccare la versione del documento	Bloccare la versione del documento
Cercare le voci della tabella di ricerca	Cercare le voci della tabella di ricerca
Cercare un cabinet e modificare gli elenchi di controllo di accesso	Cercare un cabinet e modificare gli elenchi di controllo di accesso
Cercare uno o più armadi	Cercare uno o più armadi
Creare CollabSpace	Creare un nuovo CollabSpace
Creare la cartella	Creare una nuova cartella
Creare o aggiornare una voce di tabella di ricerca	Creare o aggiornare una voce di tabella di ricerca
Creare o aggiornare una voce di tabella di ricerca figlio	Creare o aggiornare una voce di tabella di ricerca figlio
Creare un collegamento protetto	Generare un collegamento a un documento accessibile da chiunque
Creare un documento	Crea un nuovo documento
Creare un gruppo di repository	Creare un gruppo di repository
Creare un gruppo esterno cabrio	Creare un gruppo esterno cabrio
Creare un utente	Creare un utente in un repository
Creare una nuova versione di un documento	Creare una nuova versione di un documento
Cronologia documenti	Recuperare un elenco di azioni eseguite in un documento
Elimina cartella	Eliminare una cartella
Elimina documento	Eliminazione di un documento
Eliminare un gruppo di repository	Eliminare un gruppo di repository
Eliminare una voce di tabella di ricerca	Eliminare una voce di tabella di ricerca
Eliminare una voce di tabella di ricerca figlio	Eliminare una voce di tabella di ricerca figlio
Estrai documento	Estrai un documento
File o unfile document to folder	Archiviare un elemento in una cartella o rimuovere il file di un elemento da una cartella.
Ottenere attributi personalizzati cab	Ottenere attributi personalizzati cab
Ottenere gli elementi della cartella	Recuperare il contenuto di una cartella, inclusi documenti e sottocartelle
Ottenere gli utenti del repository	Ottenere gli utenti del repository
Ottenere gruppi cabrio	Ottenere tutti i gruppi aggiunti a un cabinet
Ottenere gruppi di repository	Ottenere gruppi di repository
Ottenere i diritti di accesso dei gruppi cab non distribuiti	Ottenere i diritti di accesso dei gruppi cab non distribuiti
Ottenere il contenuto del contenitore	Ottenere il contenuto del contenitore selezionato
Ottenere il contenuto del documento	Recuperare un documento
Ottenere il log del repository	Ottenere il log del repository
Ottenere il profilo del documento	Ottenere informazioni su un documento
Ottenere informazioni sul gruppo	Ottenere informazioni sul gruppo
Ottenere informazioni sul repository	Ottenere informazioni sul repository
Ottenere informazioni sull'archivio dati	Ottenere informazioni sull'archivio dati
Ottenere informazioni sull'area di lavoro	Ottenere informazioni sull'area di lavoro
Ottenere informazioni sull'utente	Ottenere informazioni su un utente
Ottenere informazioni sull'utente corrente	Ottenere informazioni sull'utente corrente, l'ID non è obbligatorio
Ottenere l'appartenenza al gruppo	Ottenere l'appartenenza al gruppo
Ottenere l'elenco di archivi utente	Ottenere archivi utente
Ottenere le impostazioni cabrio	Ottenere le impostazioni cabrio
Ottenere le versioni dei documenti	Ottenere le versioni dei documenti
Ottenere o creare un'area di lavoro (con attributi padre e figlio)	Ottenere o creare un'area di lavoro (con attributi padre e figlio)
Ottenere o creare un'area di lavoro (con un singolo attributo)	Ottenere o creare un'area di lavoro (con un singolo attributo)
Ottenere una voce della tabella di ricerca figlio	Ottenere una voce della tabella di ricerca figlio
Ottenere una voce di tabella di ricerca o cercare voci di tabella figlio	Ottenere una voce di tabella di ricerca o cercare voci di tabella figlio
Rinomina cartella	Rinominare una cartella
Rinominare il documento	Rinominare un documento
Sbloccare il documento	Documento nonck
Seguire il documento	Ricevere avvisi quando il documento viene aggiornato
Seguire la cartella	Ricevere avvisi quando viene aggiunto nuovo contenuto a una cartella

Aggiornare il documento

ID operazione:

UpdateDocument

Aggiornare il contenuto di un documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento a 12 cifre.
Estensione documento	extension		string	È necessario solo se si modifica l'estensione del documento. Non includere il periodo iniziale.
Codifica Base64?	base64		boolean	Codifica Base64?
Contenuto del documento aggiornato	body	True	byte	Contenuto del documento.

Aggiornare un'area di lavoro

ID operazione:

RefreshWorkspace

Aggiornare un'area di lavoro

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID area di lavoro	workspaceID	True	string	ID area di lavoro

Aggiungere o rimuovere l'utente dal repository

ID operazione:

AddOrRemoveUserRepository

Aggiungere o rimuovere l'utente dal repository

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)
Aggiungere o rimuovere un utente	action	True	string	Aggiungere o rimuovere un utente
ID utente	member	True	string	ID utente
L'utente è esterno	external	True	boolean	L'utente è esterno
Eliminare l'utente (se federato)	deleteIfFederated		boolean	(Applicabile solo in caso di rimozione)

Aggiungere o rimuovere un gruppo dal cabinet

ID operazione:

AddToOrRemoveGroupFromCabinet

Aggiungere un gruppo all'archivio cab e ai diritti di accesso predefiniti

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cab	cabinetID	True	string	(Inizia con NG-)
Aggiungere o rimuovere un gruppo	action	True	string	Aggiungere o rimuovere un gruppo
ID del Gruppo	id	True	string	ID gruppo (inizia con UG-).
Visualizzare i diritti	view	True	boolean	Visualizza diritti (V) - Solo per l'aggiunta.
Modifica diritti	edit	True	boolean	Modifica diritti (E): solo per l'aggiunta.
Diritti di condivisione	share	True	boolean	Diritti di condivisione (S): solo per l'aggiunta.
Amministrare i diritti	administer	True	boolean	Amministrare i diritti (A): solo per l'aggiunta.
Nessun diritto di accesso	noAccess	True	boolean	Nessun diritto di accesso (N): solo per l'aggiunta.

Aggiungere o rimuovere un membro del gruppo

ID operazione:

AddOrRemoveGroupMember

Aggiungere o rimuovere un membro del gruppo

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Gruppo	groupID	True	string	(Inizia con UG-)
Aggiungere o rimuovere l'utente	action	True	string	Aggiungere o rimuovere l'utente
ID utente	member	True	string	Deve essere già membro del repository.

Archiviare il documento

ID operazione:

CheckinDoc

Archiviare un documento estratto

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento a 12 cifre.
Estensione documento	extension		string	Non includere il periodo iniziale.
Contenuto del documento	file		file	Documento in formato in più parti.
Aggiungi a recente	addToRecent		boolean	Aggiungere all'elenco di documenti recenti dell'utente.

Blocca documento

ID operazione:

LockDocument

Blocca documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento
Comment	comment		string	Comment

Bloccare la versione del documento

ID operazione:

LockDocumentVersion

Bloccare la versione del documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento a 12 cifre.
Versione documento	version	True	integer	Versione documento
Descrizione della versione	description		string	Descrizione della versione

Cercare le voci della tabella di ricerca

ID operazione:

SearchLookupEntries

Cercare le voci della tabella di ricerca

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)
ID attributo	attributeID	True	string	(Rimuovere il primo '10')
Filter	$filter		string	(Vedere la documentazione per i filtri disponibili)
Campi da recuperare	$select		string	(Includere un elenco delimitato da virgole di: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user', and/or 'access')
Numero di record corrispondenti da ignorare	$skip		integer	Questa operazione viene usata durante il recupero di più blocchi di risultati.
Numero massimo di record da restituire	$top		integer	Numero massimo di record da restituire

Restituisce

Nome	Percorso	Tipo	Descrizione
righe	rows	array of object
moroso	rows.defaulting	string
descrizione	rows.description	string
tenere	rows.hold	boolean
key	rows.key	string
chiuso	rows.closed	string
accesso	rows.access	string

Cercare un cabinet e modificare gli elenchi di controllo di accesso

ID operazione:

SearchCabinetModifyACLs

Cercare un cabinet e modificare gli elenchi di controllo di accesso

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cab	cabinetID	True	string	(Inizia con NG-)
Query	q	True	string	(Esaminare la documentazione per il formato di query)
Modificare la modalità ACL	mode	True	string	Modificare la modalità ACL
Nuovo ACL	newAcl	True	string	(Esaminare la documentazione per il formato JSON appropriato)
Indirizzo di posta elettronica	email		email	(In alternativa, inviare una notifica a questo indirizzo)
Inviare messaggi di posta elettronica di completamento	completionEmail		string	(true = send always (impostazione predefinita), false = don't send, fail = send only on fail)

Cercare uno o più armadi

ID operazione:

SearchCabinets

Cercare uno o più armadi

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Armadi	cabinets	True	string	(delimitato da virgole)
Query	q	True	string	(Esaminare la documentazione per il formato di query)
Informazioni da restituire	select	True	string	(Esaminare la documentazione per il formato restituito)
Ordina per	orderby		string	(Formato: field#|desc o field#|asc)
Numero di risultati da restituire (il valore predefinito è 50)	top		integer	(Massimo 500 per pagina)
Numero di risultati da ignorare	skip		integer	Numero di risultati da ignorare
Token usato per la paginazione dei risultati	skiptoken		string	Token usato per la paginazione dei risultati

Creare CollabSpace

ID operazione:

CreateCollabSpace

Creare un nuovo CollabSpace

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID area di lavoro	workspaceID	True	string	ID area di lavoro
CollabSpace name	name	True	string	CollabSpace name
Description	description		string	Description

Restituisce

Nome	Percorso	Tipo	Descrizione
id	Id	string
EnvUrl	EnvUrl	string

Creare la cartella

ID operazione:

CreateFolder

Creare una nuova cartella

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome cartella	name	True	string	Nome cartella.
ID padre	parent		string	ID a 12 cifre o EnvID del contenitore padre della nuova cartella.
ID cab	cabinet		string	(Inizia con NG-) Può essere omesso se nell'elemento padre è specificato un ID cartella o di un'area di lavoro.

Restituisce

Nome	Percorso	Tipo	Descrizione
id	standardAttributes.id	string
nome	standardAttributes.name	string

Creare o aggiornare una voce di tabella di ricerca

ID operazione:

CreateEntry

Creare o aggiornare una voce di tabella di ricerca

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)
ID attributo	attributeID	True	string	(Rimuovere il primo '10')
Key	parentID	True	string	Key
Description	description		string
TIPO	defaulting		string
Conservazione in caso di dispute	hold		boolean
Data di Chiusura	closed		string	Formato '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/'
Autorizzazioni filtrate	filtered_permissions	True	boolean
Forzare le permssioni	force_permissions	True	boolean
View	view	True	boolean
Edit	edit	True	boolean
Share	share	True	boolean
Administer	administer	True	boolean
Nessun accesso	noAccess	True	boolean
Impostazione predefinita cabrio	cabDefault	True	boolean
Principale	principal	True	string	(ID utente o gruppo)

Restituisce

Nome	Percorso	Tipo	Descrizione
count	count	integer

Creare o aggiornare una voce di tabella di ricerca figlio

ID operazione:

CreateChildEntry

Creare o aggiornare una voce di tabella di ricerca figlio

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)
ID attributo figlio	childAttributeID	True	string	(Rimuovere il primo '10')
Chiave padre	parentID	True	string	Chiave padre
Chiave figlio	childID	True	string	Chiave figlio
Description	description		string
TIPO	defaulting		string
Conservazione in caso di dispute	hold		boolean
Data di Chiusura	closed		string	Formato '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/'
Autorizzazioni filtrate	filtered_permissions	True	boolean
Forzare le permssioni	force_permissions	True	boolean
View	view	True	boolean
Edit	edit	True	boolean
Share	share	True	boolean
Administer	administer	True	boolean
Nessun accesso	noAccess	True	boolean
Impostazione predefinita cabrio	cabDefault	True	boolean
Principale	principal	True	string	(ID utente o gruppo)

Restituisce

Nome	Percorso	Tipo	Descrizione
count	count	integer

Creare un collegamento protetto

ID operazione:

CreateSecuredLink

Generare un collegamento a un documento accessibile da chiunque

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento a 12 cifre.
Password per il collegamento protetto	password		string	A seconda della configurazione cabrio, la password può essere facoltativa o obbligatoria.
Data di scadenza per il collegamento protetto.	expirationdate		string	Formato di input: aaaa-MM-gg.
Versione del documento	version		string	Versione del documento da condividere. Se vuoto, la versione ufficiale verrà condivisa.
Scaricare il documento	download		boolean	Se true, il documento può essere scaricato dal destinatario.
Comunica	notifyme		boolean	Se true, inviare una notifica al mittente quando si accede al collegamento protetto.
Blocca documento	lock		boolean	Facoltativamente, bloccare la versione selezionata del documento. Questo richiede diritti di modifica.

Restituisce

Nome	Percorso	Tipo	Descrizione
view	standardAttributes.view	string
scaricamento	standardAttributes.download	string

Creare un documento

ID operazione:

CreateDocument

Crea un nuovo documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Destinazione	destination	True	string	ID a 12 cifre o EnvID della cartella, filtro o area di lavoro.
Contenuto del documento	file	True	file	Inserire il nome file più l'estensione nel campo nome file associato.
Aggiungi a recente	addToRecent		boolean	Aggiungi a recente
Profilo documento	profile		string	Impostare il profilo documento (formato JSON)

Restituisce

Nome	Percorso	Tipo	Descrizione
id	id	string
extension	extension	string
nome	name	string

Creare un gruppo di repository

ID operazione:

CreateRepositoryGroup

Creare un gruppo di repository

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)
Nome del gruppo	name	True	string	Nome del gruppo
External	external	True	boolean	External
Nascondi negli elenchi	hidden	True	boolean	Nascondi negli elenchi
Appartenenza nascosta	hideMembership	True	boolean	Appartenenza nascosta

Restituisce

Nome	Percorso	Tipo	Descrizione
esterno	external	boolean
Nascosto	hidden	boolean
hideMembership	hideMembership	boolean
id	id	string
nome	name	string

Creare un gruppo esterno cabrio

ID operazione:

CreateCabinetExternalGroup

Creare un gruppo esterno cabrio

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cab	cabinetID	True	string	(Inizia con NG-)
Nome del gruppo	name	True	string	Nome del gruppo
Opzioni di gruppo	options		string	Opzioni di gruppo
Accesso predefinito cab	access		string	Accesso predefinito cab
CollabSpace ID	collaborationSpaceId		string	(Per creare un gruppo collabSpace-external)
Accesso a CollabSpace	collaborationspaceaccess		string	Accesso a CollabSpace
Valore dell'attributo dell'area di lavoro principale	topwsattributegroupkey		string	(Per i normali gruppi esterni di cabinet; per associare il gruppo a un valore specifico dell'attributo dell'area di lavoro principale)

Restituisce

Nome	Percorso	Tipo	Descrizione
TIPO	Type	integer
id	Id	string
Nome	Name	string
Options	Options	string
Accesso	Access	string

Creare un utente

ID operazione:

CreateUser

Creare un utente in un repository

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome utente	username	True	email	(uguale all'indirizzo di posta elettronica dell'utente)
Nome di battesimo	displayFirstName	True	string	Nome di battesimo
Secondo nome	displayMiddleName		string	Secondo nome
Cognome	displayLastName	True	string	Cognome
Indirizzo di posta elettronica	email	True	email	Indirizzo di posta elettronica
L'utente è esterno	external	True	boolean	(Applicabile solo al componente aggiuntivo)
Inviare un messaggio di posta elettronica di benvenuto	sendWelcome	True	boolean	Inviare un messaggio di posta elettronica di benvenuto
ID archivio	repository	True	string	(Inizia con CA-)

Restituisce

Nome	Percorso	Tipo	Descrizione
nome visualizzato	displayName	string
posta elettronica	email	email
id	id	string
esterno	external	boolean

Creare una nuova versione di un documento

ID operazione:

NewVersion

Creare una nuova versione di un documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento a 12 cifre.
Estensione documento	extension		string	Non includere il periodo iniziale.
Descrizione della versione	version_description		string	Descrizione della versione
Nome della nuova versione	verName		string	Nome della nuova versione
Rendere ufficiale la versione	official		boolean	La nuova versione non sarà la versione ufficiale se questo parametro non è impostato.
Aggiungere ai documenti recenti	addToRecent		boolean	Aggiungere ai documenti recenti
Numero di versione di origine	srcVer		string	Se si copia il contenuto da una versione precedente, quale versione del documento copiare.
Creare come sottoversione	allocatesubversion		boolean	Creare come sottoversione anziché come versione completa.
Contenuto del documento della nuova versione	body		binary	Contenuto della nuova versione, se non viene copiata un'altra versione o la versione ufficiale.

Restituisce

Nome	Percorso	Tipo	Descrizione
latestVersionNumber	latestVersionNumber	integer
newVer	newVer	integer
newVersionLabel	newVersionLabel	string
officialVer	officialVer	integer
officialVerName	officialVerName	string
versions	versions	integer

Cronologia documenti

ID operazione:

GetDocHistory

Recuperare un elenco di azioni eseguite in un documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento a 12 cifre.

Elimina cartella

ID operazione:

DeleteFolder

Eliminare una cartella

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cartella	id	True	string	ID cartella a 12 cifre.
Eliminare definitivamente	permanent		boolean	Indica che la cartella deve essere eliminata in modo permanente, anziché spostata in Elementi eliminati. Il contenuto della cartella, incluse le sottocartelle discendenti, non verrà eliminato definitivamente.
Eliminare il contenuto della cartella	deleteContents		boolean	Indica che i documenti nella cartella eliminata (e in qualsiasi sottocartella discendente) devono essere eliminati anche, anziché semplicemente defiled.

Elimina documento

ID operazione:

DeleteDoc

Eliminazione di un documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento a 12 cifre.
Eliminare definitivamente	permanent		boolean	Indica che il documento deve essere eliminato definitivamente, anziché spostato in Elementi eliminati.

Eliminare un gruppo di repository

ID operazione:

DeleteRepositoryGroup

Eliminare un gruppo di repository

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)
ID del Gruppo	groupID	True	string	(Inizia con UG-)

Eliminare una voce di tabella di ricerca

ID operazione:

DeleteLookupEntry

Eliminare una voce di tabella di ricerca

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)
ID attributo	attributeID	True	string	(Rimuovere il primo '10')
Key	parentID	True	string	Key

Restituisce

Nome	Percorso	Tipo	Descrizione
count	count	integer

Eliminare una voce di tabella di ricerca figlio

ID operazione:

DeleteChildEntry

Eliminare una voce di tabella di ricerca figlio

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)
ID attributo figlio	childAttributeID	True	string	(Rimuovere il primo '10')
Chiave padre	parentID	True	string	Chiave padre
Chiave figlio	childID	True	string	Chiave figlio

Restituisce

Nome	Percorso	Tipo	Descrizione
count	count	integer

Estrai documento

ID operazione:

CheckOutDoc

Estrai un documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento a 12 cifre.
Comment	comment		string	Comment
Scaricare il documento	download		boolean	Restituisce il contenuto del documento.
Versione da scaricare	version		string	Specifica il contenuto della versione da scaricare. Il valore predefinito è la versione ufficiale.
Aggiungi a recente	addToRecent		boolean	Aggiungi a recente

File o unfile document to folder

ID operazione:

FileFolder

Archiviare un elemento in una cartella o rimuovere il file di un elemento da una cartella.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cartella	id	True	string	ID cartella a 12 cifre.
ID documento	item	True	string	ID documento a 12 cifre.
File o unfile	action	True	string	File o unfile

Ottenere attributi personalizzati cab

ID operazione:

GetCabinetCustomAttributes

Ottenere attributi personalizzati cab

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cab	cabinetID	True	string	(Inizia con NG-)

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
items		object

Ottenere gli elementi della cartella

ID operazione:

GetFldContent

Recuperare il contenuto di una cartella, inclusi documenti e sottocartelle

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cartella	id	True	string	ID cartella a 12 cifre.
Attributi da restituire	$select		string	Elenco delimitato da virgole di valori di attributo. Per altri dettagli, vedere la documentazione dell'API REST.

Ottenere gli utenti del repository

ID operazione:

GetRepositoryUsers

Ottenere gli utenti del repository

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
nome visualizzato	displayName	string
posta elettronica	email	string
esterno	external	boolean
id	id	string
lastLogin	lastLogin	string
registrato	registered	string

Ottenere gruppi cabrio

ID operazione:

GetCabinetGroups

Ottenere tutti i gruppi aggiunti a un cabinet

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cab	cabinetID	True	string	(Inizia con NG-)

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
id	Id	string
Nome	Name	string
External	External	boolean
Nascosto	Hidden	boolean

Ottenere gruppi di repository

ID operazione:

GetRepositoryGroups

Ottenere gruppi di repository

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)
Filter	$filter		string	(Vedere la documentazione per i criteri di filtro)
Numero di risultati	$top		string	Il valore predefinito è 5.000. Massimo 10.000)
Paging	paging		boolean	(Restituisce i risultati nelle pagine; il valore predefinito è false)
Token di paging	$skiptoken		string	(A scopo di paging; restituito dalle chiamate precedenti come 'next')
Informazioni di restituzione	returnInfo		string	tutti restituiranno i nomi dei gruppi. Il valore predefinito è vuoto per restituire solo GLI ID

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of string

Ottenere i diritti di accesso dei gruppi cab non distribuiti

ID operazione:

GetCabinetDefaultAccess

Ottenere i diritti di accesso dei gruppi cab non distribuiti

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cab	cabinetID	True	string	(Inizia con NG-)

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
amministrare	administer	boolean
cabDefault	cabDefault	boolean
edit	edit	boolean
nome	name	string
noAccess	noAccess	boolean
preside	principal	string
Condividi	share	boolean
view	view	boolean

Ottenere il contenuto del contenitore

ID operazione:

GetContainerContents

Ottenere il contenuto del contenitore selezionato

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID contenitore	containerID	True	string	ID contenitore
Informazioni da restituire	select	True	string	(Esaminare la documentazione per il formato restituito)
Numero di risultati da restituire (il valore predefinito è 50)	top		integer	(Massimo 500 per pagina)
Token usato per la paginazione dei risultati	skiptoken		string	Token usato per la paginazione dei risultati
Ordina per	orderby		string	(Formato: field#|desc o field#|asc)

Ottenere il contenuto del documento

ID operazione:

GetDocContent

Recuperare un documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento a 12 cifre.
Codifica Base64?	base64		boolean	Codifica Base64?

Ottenere il log del repository

ID operazione:

GetRepositoryLog

Ottenere il log del repository

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)
Data/ora di inizio	start		string	(Il valore predefinito è 30 giorni; formato aaaa-MM-gg o aa-MM-ggThh:mm:ssZ)
Data/ora di fine	end		string	(Stesso formato dell'inizio; il valore predefinito è oggi)
Tipo di log	Logtype	True	string	Tipo di log

Ottenere il profilo del documento

ID operazione:

GetDocInfo

Ottenere informazioni su un documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento a 12 cifre.

Ottenere informazioni sul gruppo

ID operazione:

GetGroupInformation

Ottenere informazioni sul gruppo

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Gruppo	groupID	True	string	ID gruppo (inizia con UG-).
Appartenenza al gabinetto di gruppo	cabMembership		boolean	Se impostato su "true" gli archivi di questo gruppo sono membri di e verranno inclusi i diritti di accesso ai documenti predefiniti per ogni archivio.

Restituisce

Nome	Percorso	Tipo	Descrizione
esterno	external	boolean
Nascosto	hidden	boolean
hideMembership	hideMembership	boolean
id	id	string
nome	name	string
cabMembership	cabMembership	array of object
id	cabMembership.id	string
nome	cabMembership.name	string
diritti	cabMembership.rights	string

Ottenere informazioni sul repository

ID operazione:

GetRepositoryInformation

Ottenere informazioni sul repository

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)

Ottenere informazioni sull'archivio dati

ID operazione:

GetCabinetInformation

Ottenere informazioni sull'archivio dati

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cab	cabinetID	True	string	(Inizia con NG-)

Ottenere informazioni sull'area di lavoro

ID operazione:

GetWorkspaceInformation

Ottenere informazioni sull'area di lavoro

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID area di lavoro	workspaceID	True	string	ID area di lavoro

Ottenere informazioni sull'utente

ID operazione:

GetUserInfo

Ottenere informazioni su un utente

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID utente	id	True	string	ID utente assegnato da NetDocuments.
ID cab	cabGuid		string	(Inizia con NG-)

Restituisce

Nome	Percorso	Tipo	Descrizione
nome visualizzato	displayName	string
posta elettronica	email	email
id	id	string
organizzazione	organization	string
isRepositoryMember	isRepositoryMember	boolean
primaryCabinet	primaryCabinet	string
sortLookupBy	sortLookupBy	string
esterno	external	boolean

Ottenere informazioni sull'utente corrente

ID operazione:

GetCurrentUserInfo

Ottenere informazioni sull'utente corrente, l'ID non è obbligatorio

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cab	cabGuid		string	(Inizia con NG-)

Restituisce

Nome	Percorso	Tipo	Descrizione
nome visualizzato	displayName	string
posta elettronica	email	email
id	id	string
organizzazione	organization	string
isRepositoryMember	isRepositoryMember	boolean
primaryCabinet	primaryCabinet	string
sortLookupBy	sortLookupBy	string
esterno	external	boolean

Ottenere l'appartenenza al gruppo

ID operazione:

GetGroupMembership

Ottenere l'appartenenza al gruppo

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Gruppo	groupID	True	string	(Inizia con UG-)

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
nome visualizzato	displayName	string
id	id	string

Ottenere l'elenco di archivi utente

ID operazione:

GetUserCabinets

Ottenere archivi utente

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
id	id	string
isCollaborationSpacesEnabled	isCollaborationSpacesEnabled	string
nome	name	string
repositoryId	repositoryId	string
repositoryName	repositoryName	string
wsAttrNum	wsAttrNum	integer
wsOrgAttrNum	wsOrgAttrNum	integer

Ottenere le impostazioni cabrio

ID operazione:

GetCabinetSettings

Ottenere le impostazioni cabrio

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cab	cabinetID	True	string	(Inizia con NG-)

Ottenere le versioni dei documenti

ID operazione:

GetDocumentVersions

Ottenere le versioni dei documenti

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	documentID	True	string	ID documento a 12 cifre.

Ottenere o creare un'area di lavoro (con attributi padre e figlio)

ID operazione:

CreateWorkspaceParentChild

Ottenere o creare un'area di lavoro (con attributi padre e figlio)

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cab	cabinetID	True	string	(Inizia con NG-)
Valore padre	parentID	True	string	Valore padre utilizzato per definire le aree di lavoro nel cabinet.
Valore figlio	childID	True	string	Valore figlio usato per definire le aree di lavoro nel cabinet.

Restituisce

Nome	Percorso	Tipo	Descrizione
id	standardAttributes.id	string

Ottenere o creare un'area di lavoro (con un singolo attributo)

ID operazione:

CreateWorkspaceSingle

Ottenere o creare un'area di lavoro (con un singolo attributo)

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cab	cabinetID	True	string	(Inizia con NG-)
Valore unico	parentID	True	string	Valore unico usato per definire le aree di lavoro nel cabinet.

Restituisce

Nome	Percorso	Tipo	Descrizione
id	standardAttributes.id	string

Ottenere una voce della tabella di ricerca figlio

ID operazione:

GetChildEntry

Ottenere una voce della tabella di ricerca figlio

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)
ID attributo figlio	childAttributeID	True	string	(Rimuovere il primo '10')
Chiave padre	parentID	True	string	Chiave padre
Chiave figlio	childID	True	string	Chiave figlio

Ottenere una voce di tabella di ricerca o cercare voci di tabella figlio

ID operazione:

GetLookupEntry

Ottenere una voce di tabella di ricerca o cercare voci di tabella figlio

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID archivio	repositoryID	True	string	(Inizia con CA-)
ID attributo	attributeID	True	string	Rimuovere l'elemento "10" iniziale. Per restituire un singolo valore, immettere l'ID attributo padre o cercare voci figlio, immettere l'ID attributo figlio.
Key	parentID	True	string	Per restituire un singolo valore, immettere la chiave del singolo attributo o cercare voci figlio immettere la chiave dell'elemento padre.
Filtro (solo durante la ricerca)	$filter		string	(Vedere la documentazione per i filtri disponibili)
Campi da recuperare	$select		string	(Includere un elenco delimitato da virgole di: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user', and/or 'access')
Numero di record corrispondenti da ignorare	$skip		integer	Questa operazione viene usata durante il recupero di più blocchi di risultati.
Numero massimo di record da restituire	$top		integer	Numero massimo di record da restituire
Ordinare i risultati in base a	$orderby		string	Ordinare i risultati in base a

Rinomina cartella

ID operazione:

RenameFolder

Rinominare una cartella

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cartella	id	True	string	ID cartella a 12 cifre.
Nuovo nome	name	True	string

Rinominare il documento

ID operazione:

RenameDocument

Rinominare un documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento a 12 cifre.
Nuovo nome	name	True	string

Sbloccare il documento

ID operazione:

UnockDocument

Documento nonck

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento

Seguire il documento

ID operazione:

FollowDocument

Ricevere avvisi quando il documento viene aggiornato

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	id	True	string	ID documento a 12 cifre.
Destinatari	recipients	True	string	Uno o più indirizzi di posta elettronica validi separati da punti e virgola. Duplicati ignorati.
Invia	send		string	Quale categoria di utenti deve ricevere l'avviso.

Seguire la cartella

ID operazione:

FollowFolder

Ricevere avvisi quando viene aggiunto nuovo contenuto a una cartella

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cartella	id	True	string	ID cartella a 12 cifre.
Destinatari	recipients	True	string	Uno o più indirizzi di posta elettronica validi separati da punti e virgola. Duplicati ignorati.
Invia	send		string	Quale categoria di utenti deve ricevere l'avviso.

Trigger

Armadio di ricerca

Cercare il file CAB specificato

Armadio di ricerca

ID operazione:

SearchCab

Cercare il file CAB specificato

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cab	cabId	True	string	(Inizia con NG-)
Criteri di ricerca	q	True	string	Usare lo stesso formato e gli stessi operatori dell'interfaccia Web NetDocuments.
Ordina per	$orderby		string	Ordina per
Numero massimo di risultati	$top		string	Intero compreso tra 1 e 500. Il valore predefinito è 100.
Attributi da restituire	$select		string	Elenco delimitato da virgole di valori di attributo. Per altri dettagli, vedere la documentazione dell'API REST.