NetDocuments

NetDocuments est un service de gestion de contenu cloud pour les entreprises de toutes tailles afin de créer, stocker, gérer et partager en toute sécurité leur travail de document n’importe où, à tout moment.

Ce connecteur est disponible dans les produits et régions suivants :

Service	classe	Régions
Copilot Studio	Norme	Toutes les régions Power Automate , à l’exception des éléments suivants :      - Us Government (GCC)      - Us Government (GCC High)      - China Cloud géré par 21Vianet      - Us Department of Defense (DoD)
Applications logiques	Norme	Toutes les régions Logic Apps , à l’exception des suivantes :      - Régions Azure Government      - Régions Azure Chine      - Us Department of Defense (DoD)
Power Apps	Norme	Toutes les régions Power Apps , à l’exception des suivantes :      - Us Government (GCC)      - Us Government (GCC High)      - China Cloud géré par 21Vianet      - Us Department of Defense (DoD)
Power Automate	Norme	Toutes les régions Power Automate , à l’exception des éléments suivants :      - Us Government (GCC)      - Us Government (GCC High)      - China Cloud géré par 21Vianet      - Us Department of Defense (DoD)

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

Métadonnées du connecteur
Éditeur	NetDocuments Software, Inc.
Site internet	https://www.netdocuments.com/
Politique de confidentialité	https://www.netdocuments.com/privacy-policy/

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :

Par défaut	Paramètres de création de connexion.	Toutes les régions	Impossible à partager

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Ce n’est pas une connexion partageable. Si l’application Power est partagée avec un autre utilisateur, un autre utilisateur sera invité à créer explicitement une nouvelle connexion.

Nom	Type	Descriptif	Obligatoire
Région	ficelle	Région dans laquelle réside votre document net.	Vrai

Limitations

Nom	Appels	Période de renouvellement
Appels d’API par connexion	100	60 secondes

Actions

Actualiser un espace de travail	Actualiser un espace de travail
Ajouter ou supprimer un groupe dans l’armoire	Ajouter un groupe à l’armoire et des droits d’accès par défaut
Ajouter ou supprimer un membre de groupe	Ajouter ou supprimer un membre de groupe
Ajouter un utilisateur au référentiel ou le supprimer	Ajouter un utilisateur au référentiel ou le supprimer
Archiver le document	Archiver un document extrait
Créer CollabSpace	Créer un collabSpace
Créer ou mettre à jour une entrée de table de recherche	Créer ou mettre à jour une entrée de table de recherche
Créer ou mettre à jour une entrée de table de recherche enfant	Créer ou mettre à jour une entrée de table de recherche enfant
Créer un document	Créer un document
Créer un dossier	Créer un dossier
Créer un groupe de référentiels	Créer un groupe de référentiels
Créer un groupe externe d’armoire	Créer un groupe externe d’armoire
Créer un lien sécurisé	Générer un lien vers un document accessible par toute personne
Créer un utilisateur	Créer un utilisateur dans un référentiel
Créer une version d’un document	Créer une nouvelle version d’un document
Déverrouiller le document	Unock document
Extraire le document	Extraire un document
Fichier ou un fichier de document dans le dossier	Déposez un élément dans un dossier ou annulez le fichier d’un élément à partir d’un dossier.
Historique des documents	Récupérer une liste d’actions effectuées sur un document
Mettre à jour le document	Mettre à jour le contenu d’un document
Obtenir des attributs personnalisés d’armoire	Obtenir des attributs personnalisés d’armoire
Obtenir des groupes de référentiels	Obtenir des groupes de référentiels
Obtenir des groupes d’armoires	Obtenir tous les groupes ajoutés à une armoire
Obtenir des informations sur le cabinet	Obtenir des informations sur le cabinet
Obtenir des informations sur le groupe	Obtenir des informations sur le groupe
Obtenir des informations sur le référentiel	Obtenir des informations sur le référentiel
Obtenir des informations sur l’espace de travail	Obtenir des informations sur l’espace de travail
Obtenir des informations utilisateur	Obtenir des informations sur un utilisateur
Obtenir des utilisateurs du référentiel	Obtenir des utilisateurs du référentiel
Obtenir des versions de document	Obtenir des versions de document
Obtenir des éléments de dossier	Récupérer le contenu d’un dossier, y compris les documents et les sous-dossiers
Obtenir la liste des armoires utilisateur	Obtenir des armoires utilisateur
Obtenir le contenu du conteneur	Obtenir le contenu du conteneur sélectionné
Obtenir le contenu du document	Récupérer un document
Obtenir le journal des référentiels	Obtenir le journal des référentiels
Obtenir les droits d’accès des groupes d’armoires non attachés	Obtenir les droits d’accès des groupes d’armoires non attachés
Obtenir les informations de l’utilisateur actuel	Obtenir des informations sur l’utilisateur actuel, l’ID n’est pas obligatoire
Obtenir les paramètres de l’armoire	Obtenir les paramètres de l’armoire
Obtenir l’appartenance au groupe	Obtenir l’appartenance au groupe
Obtenir ou créer un espace de travail (avec des attributs parent et enfant)	Obtenir ou créer un espace de travail (avec des attributs parent et enfant)
Obtenir ou créer un espace de travail (avec un seul attribut)	Obtenir ou créer un espace de travail (avec un seul attribut)
Obtenir un profil de document	Obtenir des informations sur un document
Obtenir une entrée de table de recherche enfant	Obtenir une entrée de table de recherche enfant
Obtenir une entrée de table de recherche ou rechercher des entrées de table enfants	Obtenir une entrée de table de recherche ou rechercher des entrées de table enfants
Rechercher dans une armoire et modifier des listes de contrôle d’accès	Rechercher dans une armoire et modifier des listes de contrôle d’accès
Rechercher des entrées de table de recherche	Rechercher des entrées de table de recherche
Rechercher une ou plusieurs armoires	Rechercher une ou plusieurs armoires
Renommer le document	Renommer un document
Renommer le dossier	Renommer un dossier
Suivre le document	Recevoir des alertes lorsque le document est mis à jour
Suivre le dossier	Recevoir des alertes lorsque le nouveau contenu est ajouté à un dossier
Supprimer le dossier	Supprimer un dossier
Supprimer le groupe de référentiels	Supprimer un groupe de référentiels
Supprimer un document	Supprimer un document
Supprimer une entrée de table de choix	Supprimer une entrée de table de choix
Supprimer une entrée de table de recherche enfant	Supprimer une entrée de table de recherche enfant
Verrouiller la version du document	Verrouiller la version du document
Verrouiller le document	Verrouiller le document

Actualiser un espace de travail

ID d’opération :

RefreshWorkspace

Actualiser un espace de travail

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de l’espace de travail	workspaceID	True	string	ID de l’espace de travail

Ajouter ou supprimer un groupe dans l’armoire

ID d’opération :

AddToOrRemoveGroupFromCabinet

Ajouter un groupe à l’armoire et des droits d’accès par défaut

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cabinet ID	cabinetID	True	string	(Il commence par NG-)
Ajouter ou supprimer un groupe	action	True	string	Ajouter ou supprimer un groupe
ID de groupe	id	True	string	ID de groupe (commence par UG-).
Afficher les droits	view	True	boolean	Afficher les droits (V) : uniquement pour l’ajouter.
Modifier les droits	edit	True	boolean	Modifier les droits (E) : uniquement pour l’ajouter.
Droits de partage	share	True	boolean	Droits de partage (S) : uniquement pour l’ajout.
Administrer les droits	administer	True	boolean	Administrer les droits (A) : uniquement pour l’ajout.
Aucun droit d’accès	noAccess	True	boolean	Aucun droit d’accès (N) - Uniquement pour l’ajout.

Ajouter ou supprimer un membre de groupe

ID d’opération :

AddOrRemoveGroupMember

Ajouter ou supprimer un membre de groupe

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de groupe	groupID	True	string	(Commence par UG-)
Ajouter ou supprimer l’utilisateur	action	True	string	Ajouter ou supprimer l’utilisateur
ID d’utilisateur	member	True	string	(Doit être membre du référentiel déjà.)

Ajouter un utilisateur au référentiel ou le supprimer

ID d’opération :

AddOrRemoveUserRepository

Ajouter un utilisateur au référentiel ou le supprimer

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Commence par l’autorité de certification)
Ajouter ou supprimer un utilisateur	action	True	string	Ajouter ou supprimer un utilisateur
ID d’utilisateur	member	True	string	ID d’utilisateur
L’utilisateur est externe	external	True	boolean	L’utilisateur est externe
Supprimer l’utilisateur (si fédéré)	deleteIfFederated		boolean	(Applicable uniquement lors de la suppression)

Archiver le document

ID d’opération :

CheckinDoc

Archiver un document extrait

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	ID de document à 12 chiffres.
Extension de document	extension		string	N’incluez pas la période de début.
Contenu du document	file		file	Document en plusieurs parties.
Ajouter à la version récente	addToRecent		boolean	Ajoutez à la liste des documents récents de l’utilisateur.

Créer CollabSpace

ID d’opération :

CreateCollabSpace

Créer un collabSpace

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de l’espace de travail	workspaceID	True	string	ID de l’espace de travail
Nom de CollabSpace	name	True	string	Nom de CollabSpace
Descriptif	description		string	Descriptif

Retours

Nom	Chemin d’accès	Type	Description
Id	Id	string
EnvUrl	EnvUrl	string

Créer ou mettre à jour une entrée de table de recherche

ID d’opération :

CreateEntry

Créer ou mettre à jour une entrée de table de recherche

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Il commence par l’autorité de certification-)
ID d’attribut	attributeID	True	string	(Supprimer le premier « 10 »)
Key	parentID	True	string	Key
Descriptif	description		string
Type	defaulting		string
Conservation pour litige	hold		boolean
Date de fermeture	closed		string	Format '/Date(Number of Millis From Jan 1, 1970+-UTC', like : '/Date(1582261200000-05000)/'
Autorisations filtrées	filtered_permissions	True	boolean
Forcer les permssions	force_permissions	True	boolean
Affichage	view	True	boolean
Edit	edit	True	boolean
Share	share	True	boolean
Administer	administer	True	boolean
Aucun accès	noAccess	True	boolean
Valeur par défaut de l’armoire	cabDefault	True	boolean
Élement principal	principal	True	string	(ID d’utilisateur ou de groupe)

Retours

Nom	Chemin d’accès	Type	Description
count	count	integer

Créer ou mettre à jour une entrée de table de recherche enfant

ID d’opération :

CreateChildEntry

Créer ou mettre à jour une entrée de table de recherche enfant

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Il commence par l’autorité de certification-)
ID d’attribut enfant	childAttributeID	True	string	(Supprimer le premier « 10 »)
Clé parente	parentID	True	string	Clé parente
Clé enfant	childID	True	string	Clé enfant
Descriptif	description		string
Type	defaulting		string
Conservation pour litige	hold		boolean
Date de fermeture	closed		string	Format '/Date(Number of Millis From Jan 1, 1970+-UTC', like : '/Date(1582261200000-05000)/'
Autorisations filtrées	filtered_permissions	True	boolean
Forcer les permssions	force_permissions	True	boolean
Affichage	view	True	boolean
Edit	edit	True	boolean
Share	share	True	boolean
Administer	administer	True	boolean
Aucun accès	noAccess	True	boolean
Valeur par défaut de l’armoire	cabDefault	True	boolean
Élement principal	principal	True	string	(ID d’utilisateur ou de groupe)

Retours

Nom	Chemin d’accès	Type	Description
count	count	integer

Créer un document

ID d’opération :

CreateDocument

Créer un document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Destination	destination	True	string	ID à 12 chiffres ou ID EnvID du dossier, du filtre ou de l’espace de travail.
Contenu du document	file	True	file	Placez le nom de fichier plus l’extension dans le champ de nom de fichier associé.
Ajouter à la version récente	addToRecent		boolean	Ajouter à la version récente
Profil de document	profile		string	Définir le profil de document (format JSON)

Retours

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	string
extension	extension	string
nom	name	string

Créer un dossier

ID d’opération :

CreateFolder

Créer un dossier

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom du dossier	name	True	string	Nom du dossier.
Parent ID	parent		string	ID à 12 chiffres ou ID EnvID du conteneur parent du nouveau dossier.
Cabinet ID	cabinet		string	(Il commence par NG-) Peut être omis si un dossier ou un ID d’espace de travail est spécifié dans le parent.

Retours

Nom	Chemin d’accès	Type	Description
pièce d'identité	standardAttributes.id	string
nom	standardAttributes.name	string

Créer un groupe de référentiels

ID d’opération :

CreateRepositoryGroup

Créer un groupe de référentiels

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Il commence par l’autorité de certification-)
Nom du groupe	name	True	string	Nom du groupe
External	external	True	boolean	External
Masquer dans les listes	hidden	True	boolean	Masquer dans les listes
Appartenance masquée	hideMembership	True	boolean	Appartenance masquée

Retours

Nom	Chemin d’accès	Type	Description
externe	external	boolean
caché	hidden	boolean
hideMembership	hideMembership	boolean
pièce d'identité	id	string
nom	name	string

Créer un groupe externe d’armoire

ID d’opération :

CreateCabinetExternalGroup

Créer un groupe externe d’armoire

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cabinet ID	cabinetID	True	string	(Il commence par NG-)
Nom du groupe	name	True	string	Nom du groupe
Options de groupe	options		string	Options de groupe
Accès par défaut au cabinet	access		string	Accès par défaut au cabinet
CollabSpace ID	collaborationSpaceId		string	(Pour en faire un groupe CollabSpace-external)
Accès collabSpace	collaborationspaceaccess		string	Accès collabSpace
Valeur d’attribut d’espace de travail supérieure	topwsattributegroupkey		string	(Pour les groupes externes d’armoire standard ; pour associer le groupe à une valeur d’attribut d’espace de travail supérieure spécifique)

Retours

Nom	Chemin d’accès	Type	Description
Type	Type	integer
Id	Id	string
Nom	Name	string
Options	Options	string
Accès	Access	string

Créer un lien sécurisé

ID d’opération :

CreateSecuredLink

Générer un lien vers un document accessible par toute personne

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	ID de document à 12 chiffres.
Mot de passe pour le lien sécurisé	password		string	Selon la configuration de l’armoire, le mot de passe peut être facultatif ou obligatoire.
Date d’expiration du lien sécurisé.	expirationdate		string	Format d’entrée : aaaa-MM-jj.
Version du document	version		string	Quelle version du document à partager. Si elle est vide, la version officielle sera partagée.
Télécharger le document	download		boolean	Si la valeur est true, le document peut être téléchargé par le destinataire.
M’avertir	notifyme		boolean	Si la valeur est true, informez l’expéditeur lorsque le lien sécurisé est accessible.
Verrouiller le document	lock		boolean	Si vous le souhaitez, verrouillez la version sélectionnée du document. Cela nécessite des droits d’édition.

Retours

Nom	Chemin d’accès	Type	Description
view	standardAttributes.view	string
télécharger	standardAttributes.download	string

Créer un utilisateur

ID d’opération :

CreateUser

Créer un utilisateur dans un référentiel

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom d’utilisateur	username	True	email	(Identique à l’adresse e-mail de l’utilisateur)
Prénom	displayFirstName	True	string	Prénom
Deuxième prénom	displayMiddleName		string	Deuxième prénom
Nom	displayLastName	True	string	Nom
Adresse de messagerie	email	True	email	Adresse de messagerie
L’utilisateur est externe	external	True	boolean	(Applicable uniquement sur l’ajout)
Envoyer un e-mail de bienvenue	sendWelcome	True	boolean	Envoyer un e-mail de bienvenue
ID du dépôt	repository	True	string	(Commence par l’autorité de certification)

Retours

Nom	Chemin d’accès	Type	Description
nom d’affichage	displayName	string
Messagerie électronique	email	email
pièce d'identité	id	string
externe	external	boolean

Créer une version d’un document

ID d’opération :

NewVersion

Créer une nouvelle version d’un document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	ID de document à 12 chiffres.
Extension de document	extension		string	N’incluez pas la période de début.
Description de la version	version_description		string	Description de la version
Nom de la nouvelle version	verName		string	Nom de la nouvelle version
Créer une version officielle	official		boolean	La nouvelle version ne sera pas la version officielle si ce paramètre n’est pas défini.
Ajouter à des documents récents	addToRecent		boolean	Ajouter à des documents récents
Numéro de version source	srcVer		string	Si vous copiez le contenu à partir d’une version antérieure, quelle version du document à copier.
Créer en tant que subversion	allocatesubversion		boolean	Créez en tant que subversion au lieu d’une version complète.
Nouveau contenu du document de version	body		binary	Contenu de la nouvelle version, s’il ne copie pas une autre version ou la version officielle.

Retours

Nom	Chemin d’accès	Type	Description
latestVersionNumber	latestVersionNumber	integer
newVer	newVer	integer
newVersionLabel	newVersionLabel	string
officialVer	officialVer	integer
officialVerName	officialVerName	string
versions	versions	integer

Déverrouiller le document

ID d’opération :

UnockDocument

Unock document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	Document ID

Extraire le document

ID d’opération :

CheckOutDoc

Extraire un document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	ID de document à 12 chiffres.
Commentaire	comment		string	Commentaire
Télécharger le document	download		boolean	Retourne le contenu du document.
Version à télécharger	version		string	Spécifie le contenu de la version à télécharger. La valeur par défaut est la version officielle.
Ajouter à la version récente	addToRecent		boolean	Ajouter à la version récente

Fichier ou un fichier de document dans le dossier

ID d’opération :

FileFolder

Déposez un élément dans un dossier ou annulez le fichier d’un élément à partir d’un dossier.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dossier	id	True	string	ID de dossier à 12 chiffres.
Document ID	item	True	string	ID de document à 12 chiffres.
Fichier ou un fichier	action	True	string	Fichier ou un fichier

Historique des documents

ID d’opération :

GetDocHistory

Récupérer une liste d’actions effectuées sur un document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	ID de document à 12 chiffres.

Mettre à jour le document

ID d’opération :

UpdateDocument

Mettre à jour le contenu d’un document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	ID de document à 12 chiffres.
Extension de document	extension		string	Nécessaire uniquement si vous modifiez l’extension du document. N’incluez pas la période de début.
Codé en base64 ?	base64		boolean	Codé en base64 ?
Contenu du document mis à jour	body	True	byte	Contenu du document.

Obtenir des attributs personnalisés d’armoire

ID d’opération :

GetCabinetCustomAttributes

Obtenir des attributs personnalisés d’armoire

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cabinet ID	cabinetID	True	string	(Il commence par NG-)

Retours

Nom	Chemin d’accès	Type	Description
		array of object
items		object

Obtenir des groupes de référentiels

ID d’opération :

GetRepositoryGroups

Obtenir des groupes de référentiels

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Il commence par l’autorité de certification-)
Filter	$filter		string	(Consultez la documentation relative aux critères de filtre)
Nombre de résultats	$top		string	(La valeur par défaut est 5 000. Maximum 10 000)
Paging	paging		boolean	(Retourner les résultats dans les pages ; la valeur par défaut est false)
Jeton de pagination	$skiptoken		string	(À des fins de pagination ; retournées par des appels précédents en tant que 'suivant')
Informations de retour	returnInfo		string	tous retournent des noms de groupe. La valeur par défaut est vide pour retourner uniquement les ID

Retours

Nom	Chemin d’accès	Type	Description
		array of string

Obtenir des groupes d’armoires

ID d’opération :

GetCabinetGroups

Obtenir tous les groupes ajoutés à une armoire

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cabinet ID	cabinetID	True	string	(Il commence par NG-)

Retours

Nom	Chemin d’accès	Type	Description
		array of object
Id	Id	string
Nom	Name	string
External	External	boolean
Caché	Hidden	boolean

Obtenir des informations sur le cabinet

ID d’opération :

GetCabinetInformation

Obtenir des informations sur le cabinet

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cabinet ID	cabinetID	True	string	(Il commence par NG-)

Obtenir des informations sur le groupe

ID d’opération :

GetGroupInformation

Obtenir des informations sur le groupe

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de groupe	groupID	True	string	ID de groupe (commence par UG-).
Appartenance au cabinet de groupe	cabMembership		boolean	(Si la valeur est « true », les armoires dont ce groupe est membre et les droits d’accès aux documents par défaut pour chaque armoire sont inclus.)

Retours

Nom	Chemin d’accès	Type	Description
externe	external	boolean
caché	hidden	boolean
hideMembership	hideMembership	boolean
pièce d'identité	id	string
nom	name	string
cabMembership	cabMembership	array of object
pièce d'identité	cabMembership.id	string
nom	cabMembership.name	string
droits	cabMembership.rights	string

Obtenir des informations sur le référentiel

ID d’opération :

GetRepositoryInformation

Obtenir des informations sur le référentiel

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Commence par l’autorité de certification)

Obtenir des informations sur l’espace de travail

ID d’opération :

GetWorkspaceInformation

Obtenir des informations sur l’espace de travail

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de l’espace de travail	workspaceID	True	string	ID de l’espace de travail

Obtenir des informations utilisateur

ID d’opération :

GetUserInfo

Obtenir des informations sur un utilisateur

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’utilisateur	id	True	string	ID d’utilisateur affecté par NetDocuments.
Cabinet ID	cabGuid		string	(Il commence par NG-)

Retours

Nom	Chemin d’accès	Type	Description
nom d’affichage	displayName	string
Messagerie électronique	email	email
pièce d'identité	id	string
organisation	organization	string
isRepositoryMember	isRepositoryMember	boolean
primaryCabinet	primaryCabinet	string
sortLookupBy	sortLookupBy	string
externe	external	boolean

Obtenir des utilisateurs du référentiel

ID d’opération :

GetRepositoryUsers

Obtenir des utilisateurs du référentiel

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Commence par l’autorité de certification)

Retours

Nom	Chemin d’accès	Type	Description
		array of object
nom d’affichage	displayName	string
Messagerie électronique	email	string
externe	external	boolean
pièce d'identité	id	string
lastLogin	lastLogin	string
recommandé	registered	string

Obtenir des versions de document

ID d’opération :

GetDocumentVersions

Obtenir des versions de document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	documentID	True	string	ID de document à 12 chiffres.

Obtenir des éléments de dossier

ID d’opération :

GetFldContent

Récupérer le contenu d’un dossier, y compris les documents et les sous-dossiers

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dossier	id	True	string	ID de dossier à 12 chiffres.
Attributs à retourner	$select		string	Liste séparée par des virgules de valeurs d’attribut. Pour plus d’informations, consultez la documentation de l’API REST.

Obtenir la liste des armoires utilisateur

ID d’opération :

GetUserCabinets

Obtenir des armoires utilisateur

Retours

Nom	Chemin d’accès	Type	Description
		array of object
pièce d'identité	id	string
isCollaborationSpacesEnabled	isCollaborationSpacesEnabled	string
nom	name	string
repositoryId	repositoryId	string
repositoryName	repositoryName	string
wsAttrNum	wsAttrNum	integer
wsOrgAttrNum	wsOrgAttrNum	integer

Obtenir le contenu du conteneur

ID d’opération :

GetContainerContents

Obtenir le contenu du conteneur sélectionné

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de conteneur	containerID	True	string	ID de conteneur
Informations à retourner	select	True	string	(Passez en revue la documentation du format de retour)
Nombre de résultats à retourner (valeur par défaut : 50)	top		integer	(Maximum 500 par page)
Jeton utilisé pour la pagination des résultats	skiptoken		string	Jeton utilisé pour la pagination des résultats
Commande par	orderby		string	(Format : champ#|desc ou champ#|asc)

Obtenir le contenu du document

ID d’opération :

GetDocContent

Récupérer un document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	ID de document à 12 chiffres.
Codé en base64 ?	base64		boolean	Codé en base64 ?

Obtenir le journal des référentiels

ID d’opération :

GetRepositoryLog

Obtenir le journal des référentiels

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Commence par l’autorité de certification)
Date/heure de début	start		string	(Valeur par défaut : 30 jours ; format aaaa-MM-jj ou aaaa-MM-ddThh :mm :ssZ)
Date/heure de fin	end		string	(Même format que le début ; valeur par défaut aujourd’hui)
Type de log	Logtype	True	string	Type de log

Obtenir les droits d’accès des groupes d’armoires non attachés

ID d’opération :

GetCabinetDefaultAccess

Obtenir les droits d’accès des groupes d’armoires non attachés

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cabinet ID	cabinetID	True	string	(Il commence par NG-)

Retours

Nom	Chemin d’accès	Type	Description
		array of object
administrer	administer	boolean
cabDefault	cabDefault	boolean
edit	edit	boolean
nom	name	string
noAccess	noAccess	boolean
directeur	principal	string
partager	share	boolean
view	view	boolean

Obtenir les informations de l’utilisateur actuel

ID d’opération :

GetCurrentUserInfo

Obtenir des informations sur l’utilisateur actuel, l’ID n’est pas obligatoire

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cabinet ID	cabGuid		string	(Il commence par NG-)

Retours

Nom	Chemin d’accès	Type	Description
nom d’affichage	displayName	string
Messagerie électronique	email	email
pièce d'identité	id	string
organisation	organization	string
isRepositoryMember	isRepositoryMember	boolean
primaryCabinet	primaryCabinet	string
sortLookupBy	sortLookupBy	string
externe	external	boolean

Obtenir les paramètres de l’armoire

ID d’opération :

GetCabinetSettings

Obtenir les paramètres de l’armoire

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cabinet ID	cabinetID	True	string	(Il commence par NG-)

Obtenir l’appartenance au groupe

ID d’opération :

GetGroupMembership

Obtenir l’appartenance au groupe

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de groupe	groupID	True	string	(Commence par UG-)

Retours

Nom	Chemin d’accès	Type	Description
		array of object
nom d’affichage	displayName	string
pièce d'identité	id	string

Obtenir ou créer un espace de travail (avec des attributs parent et enfant)

ID d’opération :

CreateWorkspaceParentChild

Obtenir ou créer un espace de travail (avec des attributs parent et enfant)

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cabinet ID	cabinetID	True	string	(Il commence par NG-)
Valeur parente	parentID	True	string	Valeur parente utilisée pour définir des espaces de travail dans l’armoire.
Valeur enfant	childID	True	string	Valeur enfant utilisée pour définir des espaces de travail dans l’armoire.

Retours

Nom	Chemin d’accès	Type	Description
pièce d'identité	standardAttributes.id	string

Obtenir ou créer un espace de travail (avec un seul attribut)

ID d’opération :

CreateWorkspaceSingle

Obtenir ou créer un espace de travail (avec un seul attribut)

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cabinet ID	cabinetID	True	string	(Il commence par NG-)
Valeur unique	parentID	True	string	Valeur unique utilisée pour définir des espaces de travail dans l’armoire.

Retours

Nom	Chemin d’accès	Type	Description
pièce d'identité	standardAttributes.id	string

Obtenir un profil de document

ID d’opération :

GetDocInfo

Obtenir des informations sur un document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	ID de document à 12 chiffres.

Obtenir une entrée de table de recherche enfant

ID d’opération :

GetChildEntry

Obtenir une entrée de table de recherche enfant

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Il commence par l’autorité de certification-)
ID d’attribut enfant	childAttributeID	True	string	(Supprimer le premier « 10 »)
Clé parente	parentID	True	string	Clé parente
Clé enfant	childID	True	string	Clé enfant

Obtenir une entrée de table de recherche ou rechercher des entrées de table enfants

ID d’opération :

GetLookupEntry

Obtenir une entrée de table de recherche ou rechercher des entrées de table enfants

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Il commence par l’autorité de certification-)
ID d’attribut	attributeID	True	string	(Supprimez le premier « 10 ». Pour retourner une valeur unique, entrez l’ID d’attribut parent ou pour rechercher des entrées enfants, entrez l’ID d’attribut enfant.)
Key	parentID	True	string	(Pour retourner une valeur unique, entrez la clé de l’attribut unique ou pour rechercher des entrées enfants entrez la clé du parent.)
Filtrer (uniquement lors de la recherche)	$filter		string	(Consultez la documentation relative aux filtres disponibles)
Champs à récupérer	$select		string	(Incluez la liste séparée par des virgules de : « key », « description », « parent », « hold », « closed », « defaulting », « type », « user » et/ou « access »)
Nombre d’enregistrements correspondants à ignorer	$skip		integer	(Cela est utilisé lors de la récupération de plusieurs blocs de résultats.)
Nombre maximal d’enregistrements à retourner	$top		integer	Nombre maximal d’enregistrements à retourner
Commandez les résultats par	$orderby		string	Commandez les résultats par

Rechercher dans une armoire et modifier des listes de contrôle d’accès

ID d’opération :

SearchCabinetModifyACLs

Rechercher dans une armoire et modifier des listes de contrôle d’accès

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cabinet ID	cabinetID	True	string	(Il commence par NG-)
Query	q	True	string	(Passez en revue la documentation du format de requête)
Modifier le mode ACL	mode	True	string	Modifier le mode ACL
Nouvelle liste de contrôle d’accès	newAcl	True	string	(Passez en revue la documentation pour le format json approprié)
Adresse de messagerie	email		email	(Envoyer une notification à cette adresse à la place)
Envoyer des e-mails d’achèvement	completionEmail		string	(true = send always (default), false = don’t send, fail = send only on fail)

Rechercher des entrées de table de recherche

ID d’opération :

SearchLookupEntries

Rechercher des entrées de table de recherche

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Il commence par l’autorité de certification-)
ID d’attribut	attributeID	True	string	(Supprimer le premier « 10 »)
Filter	$filter		string	(Consultez la documentation relative aux filtres disponibles)
Champs à récupérer	$select		string	(Incluez la liste séparée par des virgules de : « key », « description », « parent », « hold », « closed », « defaulting », « type », « user » et/ou « access »)
Nombre d’enregistrements correspondants à ignorer	$skip		integer	(Cela est utilisé lors de la récupération de plusieurs blocs de résultats.)
Nombre maximal d’enregistrements à retourner	$top		integer	Nombre maximal d’enregistrements à retourner

Retours

Nom	Chemin d’accès	Type	Description
Lignes	rows	array of object
Défaillant	rows.defaulting	string
descriptif	rows.description	string
tenir	rows.hold	boolean
key	rows.key	string
fermé	rows.closed	string
accès	rows.access	string

Rechercher une ou plusieurs armoires

ID d’opération :

SearchCabinets

Rechercher une ou plusieurs armoires

Paramètres

Nom	Clé	Obligatoire	Type	Description
Armoires	cabinets	True	string	(délimité par des virgules)
Query	q	True	string	(Passez en revue la documentation du format de requête)
Informations à retourner	select	True	string	(Passez en revue la documentation du format de retour)
Commande par	orderby		string	(Format : champ#|desc ou champ#|asc)
Nombre de résultats à retourner (valeur par défaut : 50)	top		integer	(Maximum 500 par page)
Nombre de résultats à ignorer	skip		integer	Nombre de résultats à ignorer
Jeton utilisé pour la pagination des résultats	skiptoken		string	Jeton utilisé pour la pagination des résultats

Renommer le document

ID d’opération :

RenameDocument

Renommer un document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	ID de document à 12 chiffres.
Nouveau nom	name	True	string

Renommer le dossier

ID d’opération :

RenameFolder

Renommer un dossier

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dossier	id	True	string	ID de dossier à 12 chiffres.
Nouveau nom	name	True	string

Suivre le document

ID d’opération :

FollowDocument

Recevoir des alertes lorsque le document est mis à jour

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	ID de document à 12 chiffres.
Destinataires	recipients	True	string	Une ou plusieurs adresses e-mail valides séparées par des points-virgules. Doublons ignorés.
Envoi	send		string	Quelle catégorie d’utilisateurs doit recevoir l’alerte.

Suivre le dossier

ID d’opération :

FollowFolder

Recevoir des alertes lorsque le nouveau contenu est ajouté à un dossier

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dossier	id	True	string	ID de dossier à 12 chiffres.
Destinataires	recipients	True	string	Une ou plusieurs adresses e-mail valides séparées par des points-virgules. Doublons ignorés.
Envoi	send		string	Quelle catégorie d’utilisateurs doit recevoir l’alerte.

Supprimer le dossier

ID d’opération :

DeleteFolder

Supprimer un dossier

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dossier	id	True	string	ID de dossier à 12 chiffres.
Supprimer définitivement	permanent		boolean	Indique que le dossier doit être supprimé définitivement, plutôt que déplacé vers les éléments supprimés. Le contenu du dossier, y compris les sous-dossiers descendants, ne sera pas supprimé définitivement.
Supprimer le contenu du dossier	deleteContents		boolean	Indique que les documents du dossier supprimé (et dans n’importe quel sous-dossier descendant) doivent également être supprimés, plutôt que simplement non filtrés.

Supprimer le groupe de référentiels

ID d’opération :

DeleteRepositoryGroup

Supprimer un groupe de référentiels

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Il commence par l’autorité de certification-)
ID de groupe	groupID	True	string	(Commence par UG-)

Supprimer un document

ID d’opération :

DeleteDoc

Supprimer un document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	ID de document à 12 chiffres.
Supprimer définitivement	permanent		boolean	Indique que le document doit être supprimé définitivement, plutôt que déplacé vers les éléments supprimés.

Supprimer une entrée de table de choix

ID d’opération :

DeleteLookupEntry

Supprimer une entrée de table de choix

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Il commence par l’autorité de certification-)
ID d’attribut	attributeID	True	string	(Supprimer le premier « 10 »)
Key	parentID	True	string	Key

Retours

Nom	Chemin d’accès	Type	Description
count	count	integer

Supprimer une entrée de table de recherche enfant

ID d’opération :

DeleteChildEntry

Supprimer une entrée de table de recherche enfant

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du dépôt	repositoryID	True	string	(Il commence par l’autorité de certification-)
ID d’attribut enfant	childAttributeID	True	string	(Supprimer le premier « 10 »)
Clé parente	parentID	True	string	Clé parente
Clé enfant	childID	True	string	Clé enfant

Retours

Nom	Chemin d’accès	Type	Description
count	count	integer

Verrouiller la version du document

ID d’opération :

LockDocumentVersion

Verrouiller la version du document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	ID de document à 12 chiffres.
Version du document	version	True	integer	Version du document
Description de la version	description		string	Description de la version

Verrouiller le document

ID d’opération :

LockDocument

Verrouiller le document

Paramètres

Nom	Clé	Obligatoire	Type	Description
Document ID	id	True	string	Id de document
Commentaire	comment		string	Commentaire

Déclencheurs

Cabinet de recherche

Rechercher dans l’armoire spécifiée

Cabinet de recherche

ID d’opération :

SearchCab

Rechercher dans l’armoire spécifiée

Paramètres

Nom	Clé	Obligatoire	Type	Description
Cabinet ID	cabId	True	string	(Il commence par NG-)
Critères de recherche	q	True	string	Utilisez le même format et les mêmes opérateurs que dans l’interface web NetDocuments.
Commande par	$orderby		string	Commande par
Nombre maximal de résultats	$top		string	Entier compris entre 1 et 500. La valeur par défaut est 100.
Attributs à retourner	$select		string	Liste séparée par des virgules de valeurs d’attribut. Pour plus d’informations, consultez la documentation de l’API REST.