NetDocuments

A NetDocuments egy felhőbeli tartalomkezelő szolgáltatás, amellyel a különböző méretű vállalatok biztonságosan hozhatják létre, tárolhatják, kezelhetik és oszthatják meg dokumentumaikat bárhol, bármikor.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service	Class	Régiók
Copilot Studio	Standard	Az összes Power Automate-régió, kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások	Standard	Az összes Logic Apps-régió , kivéve a következőket:      - Azure Government-régiók      - Azure China-régiók      - Amerikai Védelmi Minisztérium (DoD)
Power Alkalmazások	Standard	Az összes Power Apps-régió , kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Power Automate	Standard	Az összes Power Automate-régió, kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)

Érintkezés
URL	https://support.netdocuments.com/hc/en-us

Összekötő metaadatai
Kiadó	NetDocuments Software, Inc.
Webhely	https://www.netdocuments.com/
Adatvédelmi irányelvek	https://www.netdocuments.com/privacy-policy/

Kapcsolat létrehozása

Az összekötő a következő hitelesítési típusokat támogatja:

Alapértelmezett	A kapcsolat létrehozásának paraméterei.	Minden régió	Nem osztható meg

Alapértelmezett

Alkalmazható: Minden régió

A kapcsolat létrehozásának paraméterei.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Név	Típus	Description	Kötelező
Régió	karakterlánc	A nettó dokumentum régiója.	True

Szabályozási korlátok

Name	Hívások	Megújítási időszak
API-hívások kapcsolatonként	100	60 másodperc

Műveletek

A kabinet adatainak lekérése	A kabinet adatainak lekérése
A kabinet beállításainak lekérése	A kabinet beállításainak lekérése
Adattár felhasználóinak lekérése	Adattár felhasználóinak lekérése
Adattáradatok lekérése	Adattáradatok lekérése
Adattárcsoport létrehozása	Adattárcsoport létrehozása
Adattárcsoport törlése	Tárházcsoport törlése
Adattárcsoportok lekérése	Adattárcsoportok lekérése
Adattárnapló lekérése	Adattárnapló lekérése
Aktuális felhasználói adatok lekérése	Az aktuális felhasználó adatainak lekérése, nincs szükség azonosítóra
Biztonságos hivatkozás létrehozása	Bárki által elérhető dokumentumra mutató hivatkozás létrehozása
CollabSpace létrehozása	Új CollabSpace létrehozása
Csoport hozzáadása vagy eltávolítása a szekrényből	Csoport hozzáadása a kabinethez és az alapértelmezett hozzáférési jogosultságok
Csoportadatok lekérése	Csoportadatok lekérése
Csoporttag hozzáadása vagy eltávolítása	Csoporttag hozzáadása vagy eltávolítása
Csoporttagság lekérése	Csoporttagság lekérése
Dokumentum beadása	Kivett dokumentum beadása
Dokumentum frissítése	Dokumentum tartalmának frissítése
Dokumentum kivétele	Dokumentum kivétele
Dokumentum követése	Riasztások fogadása a dokumentum frissítésekor
Dokumentum létrehozása	Új dokumentum létrehozása
Dokumentum törlése	Dokumentum törlése
Dokumentum zárolása	Dokumentum zárolása
Dokumentum zárolásának feloldása	Dokumentum kicsomagolása
Dokumentum átnevezése	Dokumentum átnevezése
Dokumentum új verziójának létrehozása	Dokumentum új verziójának létrehozása
Dokumentumelőzmények	Dokumentumon végrehajtott műveletek listájának lekérése
Dokumentumprofil lekérése	Dokumentum adatainak lekérése
Dokumentumtartalom lekérése	Dokumentum lekérése
Dokumentumverzió zárolása	Dokumentumverzió zárolása
Dokumentumverziók lekérése	Dokumentumverziók lekérése
Felfedetlen kabinetcsoportok hozzáférési jogosultságának lekérése	Felfedetlen kabinetcsoportok hozzáférési jogosultságának lekérése
Felhasználó hozzáadása vagy eltávolítása az adattárból	Felhasználó hozzáadása vagy eltávolítása az adattárból
Felhasználó létrehozása	Felhasználó létrehozása adattárban
Felhasználói adatok lekérése	Felhasználó adatainak lekérése
Felhasználói szekrények listájának lekérése	Felhasználói szekrények lekérése
Fájl vagy fájlfájl törlése mappába	Fájlba rendezhet egy elemet egy mappában, vagy törölhet egy elemet egy mappából.
Gyermek keresési tábla bejegyzésének lekérése	Gyermek keresési tábla bejegyzésének lekérése
Gyermek keresési tábla bejegyzésének létrehozása vagy frissítése	Gyermek keresési tábla bejegyzésének létrehozása vagy frissítése
Gyermek keresési tábla bejegyzésének törlése	Gyermek keresési tábla bejegyzésének törlése
Kabinet egyéni attribútumainak lekérése	Kabinet egyéni attribútumainak lekérése
Kabinet keresése és ACL-ek módosítása	Kabinet keresése és ACL-ek módosítása
Kabinetcsoportok lekérése	Az összes csoport hozzáadása egy szekrényhez
Keresés egy vagy több szekrényben	Keresés egy vagy több szekrényben
Keresési tábla bejegyzéseinek keresése	Keresési tábla bejegyzéseinek keresése
Keresési tábla bejegyzésének lekérése vagy gyermektábla-bejegyzések keresése	Keresési tábla bejegyzésének lekérése vagy gyermektábla-bejegyzések keresése
Keresési tábla bejegyzésének létrehozása vagy frissítése	Keresési tábla bejegyzésének létrehozása vagy frissítése
Keresési tábla bejegyzésének törlése	Keresési tábla bejegyzésének törlése
Külső kabinetcsoport létrehozása	Külső kabinetcsoport létrehozása
Mappa követése	Riasztások fogadása új tartalom mappába való hozzáadásakor
Mappa létrehozása	Új mappa létrehozása
Mappa törlése	Mappa törlése
Mappa átnevezése	Mappa átnevezése
Mappaelemek lekérése	Mappa tartalmának lekérése, beleértve a dokumentumokat és az almappákat
Munkaterület adatainak lekérése	Munkaterület adatainak lekérése
Munkaterület frissítése	Munkaterület frissítése
Munkaterület lekérése vagy létrehozása (egyetlen attribútummal)	Munkaterület lekérése vagy létrehozása (egyetlen attribútummal)
Munkaterület lekérése vagy létrehozása (szülő- és gyermekattribútumokkal)	Munkaterület lekérése vagy létrehozása (szülő- és gyermekattribútumokkal)
Tároló tartalmának lekérése	A kijelölt tároló tartalmának lekérése

A kabinet adatainak lekérése

Műveletazonosító:

GetCabinetInformation

A kabinet adatainak lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kabinetazonosító	cabinetID	True	string	(NG-vel kezdődik.)

A kabinet beállításainak lekérése

Műveletazonosító:

GetCabinetSettings

A kabinet beállításainak lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kabinetazonosító	cabinetID	True	string	(NG-vel kezdődik.)

Adattár felhasználóinak lekérése

Műveletazonosító:

GetRepositoryUsers

Adattár felhasználóinak lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik))

Válaszok

Name	Elérési út	Típus	Description
		array of object
kijelző neve	displayName	string
e-mail	email	string
külső	external	boolean
azonosító	id	string
lastLogin	lastLogin	string
bejegyzett	registered	string

Adattáradatok lekérése

Műveletazonosító:

GetRepositoryInformation

Adattáradatok lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik))

Adattárcsoport létrehozása

Műveletazonosító:

CreateRepositoryGroup

Adattárcsoport létrehozása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik.)
Csoport neve	name	True	string	Csoport neve
External	external	True	boolean	External
Elrejtés listákban	hidden	True	boolean	Elrejtés listákban
Rejtett tagság	hideMembership	True	boolean	Rejtett tagság

Válaszok

Name	Elérési út	Típus	Description
külső	external	boolean
rejtett	hidden	boolean
hideMembership	hideMembership	boolean
azonosító	id	string
név	name	string

Adattárcsoport törlése

Műveletazonosító:

DeleteRepositoryGroup

Tárházcsoport törlése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik.)
Csoportazonosító	groupID	True	string	(UG-val kezdődik))

Adattárcsoportok lekérése

Műveletazonosító:

GetRepositoryGroups

Adattárcsoportok lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik.)
Filter	$filter		string	(A szűrési feltételek dokumentációjában)
Eredmények száma	$top		string	(Alapértelmezés szerint 5000. Maximum 10 000)
Paging	paging		boolean	(Az eredményeket a lapokban adja vissza; az alapértelmezett érték hamis)
Lapozási jogkivonat	$skiptoken		string	(Lapozási célokra; a korábbi hívások a következőként adják vissza)
Adatok visszaküldése	returnInfo		string	minden visszaadja a csoportneveket. Az alapértelmezett érték üres csak azonosítók visszaadásához

Válaszok

Name	Elérési út	Típus	Description
		array of string

Adattárnapló lekérése

Műveletazonosító:

GetRepositoryLog

Adattárnapló lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik))
Kezdési dátum/idő	start		string	(Alapértelmezés szerint 30 nap; formátum yyy-MM-dd vagy yyyy-MM-ddThh:mm:ssZ)
Záró dátum/idő	end		string	(Ugyanaz a formátum, mint a start; alapértelmezés szerint ma)
Napló típusa	Logtype	True	string	Napló típusa

Aktuális felhasználói adatok lekérése

Műveletazonosító:

GetCurrentUserInfo

Az aktuális felhasználó adatainak lekérése, nincs szükség azonosítóra

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kabinetazonosító	cabGuid		string	(NG-vel kezdődik.)

Válaszok

Name	Elérési út	Típus	Description
kijelző neve	displayName	string
e-mail	email	email
azonosító	id	string
szervezet	organization	string
isRepositoryMember	isRepositoryMember	boolean
primaryCabinet	primaryCabinet	string
sortLookupBy	sortLookupBy	string
külső	external	boolean

Biztonságos hivatkozás létrehozása

Műveletazonosító:

CreateSecuredLink

Bárki által elérhető dokumentumra mutató hivatkozás létrehozása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	12 jegyű dokumentumazonosító.
A biztonságos hivatkozás jelszava	password		string	A kabinet konfigurációjától függően a jelszó opcionális vagy kötelező lehet.
A biztonságos hivatkozás lejárati dátuma.	expirationdate		string	Bemeneti formátum: yyyyy-MM-dd.
A dokumentum verziója	version		string	A megosztani kívánt dokumentum melyik verziója. Ha üres, a hivatalos verzió meg lesz osztva.
Dokumentum letöltése	download		boolean	Ha igaz, előfordulhat, hogy a címzett letölti a dokumentumot.
Értesítés	notifyme		boolean	Ha igaz, értesítse a feladót a biztonságos hivatkozás elérésekor.
Dokumentum zárolása	lock		boolean	Ha szükséges, zárolja a dokumentum kijelölt verzióját. Ehhez szerkesztési jogosultság szükséges.

Válaszok

Name	Elérési út	Típus	Description
nézet	standardAttributes.view	string
letölt	standardAttributes.download	string

CollabSpace létrehozása

Műveletazonosító:

CreateCollabSpace

Új CollabSpace létrehozása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Munkaterület azonosítója	workspaceID	True	string	Munkaterület azonosítója
CollabSpace név	name	True	string	CollabSpace név
Description	description		string	Description

Válaszok

Name	Elérési út	Típus	Description
Azonosító	Id	string
EnvUrl	EnvUrl	string

Csoport hozzáadása vagy eltávolítása a szekrényből

Műveletazonosító:

AddToOrRemoveGroupFromCabinet

Csoport hozzáadása a kabinethez és az alapértelmezett hozzáférési jogosultságok

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kabinetazonosító	cabinetID	True	string	(NG-vel kezdődik.)
Csoport hozzáadása vagy eltávolítása	action	True	string	Csoport hozzáadása vagy eltávolítása
Csoportazonosító	id	True	string	Csoportazonosító (UG-val kezdődik).
Jogosultságok megtekintése	view	True	boolean	Jogosultságok megtekintése (V) – Csak hozzáadáshoz.
Jogosultságok szerkesztése	edit	True	boolean	Jogosultságok szerkesztése (E) – Csak a hozzáadáshoz.
Megosztási jogosultságok	share	True	boolean	Megosztási jogosultságok (S) – Csak hozzáadáshoz.
Jogosultságok kezelése	administer	True	boolean	Jogosultságok felügyelete (A) – Csak a hozzáadáshoz.
Nincs hozzáférési jogosultság	noAccess	True	boolean	Nincs hozzáférési jogosultság (N) – Csak a hozzáadáshoz.

Csoportadatok lekérése

Műveletazonosító:

GetGroupInformation

Csoportadatok lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csoportazonosító	groupID	True	string	Csoportazonosító (UG-val kezdődik).
Csoport kabinettagság	cabMembership		boolean	(Ha "igaz" értékre állítja azokat a kabineteket, amelynek ez a csoport tagja, és az egyes kabinetekhez tartozó alapértelmezett dokumentumhozzáférési jogosultságok is szerepelni fognak.)

Válaszok

Name	Elérési út	Típus	Description
külső	external	boolean
rejtett	hidden	boolean
hideMembership	hideMembership	boolean
azonosító	id	string
név	name	string
cabMembership	cabMembership	array of object
azonosító	cabMembership.id	string
név	cabMembership.name	string
Jogok	cabMembership.rights	string

Csoporttag hozzáadása vagy eltávolítása

Műveletazonosító:

AddOrRemoveGroupMember

Csoporttag hozzáadása vagy eltávolítása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csoportazonosító	groupID	True	string	(UG-val kezdődik))
Felhasználó hozzáadása vagy eltávolítása	action	True	string	Felhasználó hozzáadása vagy eltávolítása
Felhasználói azonosító	member	True	string	(Az adattárnak már tagja kell lennie.)

Csoporttagság lekérése

Műveletazonosító:

GetGroupMembership

Csoporttagság lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csoportazonosító	groupID	True	string	(UG-val kezdődik))

Válaszok

Name	Elérési út	Típus	Description
		array of object
kijelző neve	displayName	string
azonosító	id	string

Dokumentum beadása

Műveletazonosító:

CheckinDoc

Kivett dokumentum beadása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	12 jegyű dokumentumazonosító.
Dokumentumbővítmény	extension		string	Ne foglalja bele a kezdő időszakot.
Dokumentum tartalma	file		file	A dokumentum többrészes formában.
Hozzáadás a legutóbbiakhoz	addToRecent		boolean	Hozzáadás a felhasználó legutóbbi dokumentumlistájához.

Dokumentum frissítése

Műveletazonosító:

UpdateDocument

Dokumentum tartalmának frissítése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	12 jegyű dokumentumazonosító.
Dokumentumbővítmény	extension		string	Csak akkor szükséges, ha módosítja a dokumentum bővítményét. Ne foglalja bele a kezdő időszakot.
Base64 kódolású?	base64		boolean	Base64 kódolású?
Dokumentumtartalom frissítése	body	True	byte	A dokumentum tartalma.

Dokumentum kivétele

Műveletazonosító:

CheckOutDoc

Dokumentum kivétele

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	12 jegyű dokumentumazonosító.
Comment	comment		string	Comment
Dokumentum letöltése	download		boolean	A dokumentum tartalmát adja vissza.
Letöltendő verzió	version		string	Megadja, hogy melyik verzió tartalmát kell letölteni. A hivatalos verzió alapértelmezett értéke.
Hozzáadás a legutóbbiakhoz	addToRecent		boolean	Hozzáadás a legutóbbiakhoz

Dokumentum követése

Műveletazonosító:

FollowDocument

Riasztások fogadása a dokumentum frissítésekor

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	12 jegyű dokumentumazonosító.
Címzettek	recipients	True	string	Egy vagy több érvényes e-mail-cím pontosvesszővel elválasztva. Az ismétlődések figyelmen kívül hagyva.
Küld	send		string	A felhasználók melyik kategóriája kapja meg a riasztást.

Dokumentum létrehozása

Műveletazonosító:

CreateDocument

Új dokumentum létrehozása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Úti cél	destination	True	string	A mappa, szűrő vagy munkaterület 12 jegyű azonosítója vagy EnvID azonosítója.
Dokumentum tartalma	file	True	file	Helyezze a fájlnevet és a kiterjesztést a hozzá tartozó fájlnév mezőbe.
Hozzáadás a legutóbbiakhoz	addToRecent		boolean	Hozzáadás a legutóbbiakhoz
Dokumentumprofil	profile		string	A dokumentumprofil beállítása (JSON formátum)

Válaszok

Name	Elérési út	Típus	Description
azonosító	id	string
bővítmény	extension	string
név	name	string

Dokumentum törlése

Műveletazonosító:

DeleteDoc

Dokumentum törlése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	12 jegyű dokumentumazonosító.
Végleges törlés	permanent		boolean	Azt jelzi, hogy a dokumentumot véglegesen törölni kell a törölt elemek helyett.

Dokumentum zárolása

Műveletazonosító:

LockDocument

Dokumentum zárolása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	Dokumentum iD
Comment	comment		string	Comment

Dokumentum zárolásának feloldása

Műveletazonosító:

UnockDocument

Dokumentum kicsomagolása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	Dokumentumazonosító

Dokumentum átnevezése

Műveletazonosító:

RenameDocument

Dokumentum átnevezése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	12 jegyű dokumentumazonosító.
Új név	name	True	string

Dokumentum új verziójának létrehozása

Műveletazonosító:

NewVersion

Dokumentum új verziójának létrehozása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	12 jegyű dokumentumazonosító.
Dokumentumbővítmény	extension		string	Ne foglalja bele a kezdő időszakot.
Verzió leírása	version_description		string	Verzió leírása
Az új verzió neve	verName		string	Az új verzió neve
Hivatalos verzió készítése	official		boolean	Ha ez a paraméter nincs beállítva, az új verzió nem lesz a hivatalos verzió.
Hozzáadás a legutóbbi dokumentumokhoz	addToRecent		boolean	Hozzáadás a legutóbbi dokumentumokhoz
Forrás verziószáma	srcVer		string	Ha a tartalmat egy korábbi verzióból másolja, akkor a dokumentum melyik verzióját másolja.
Létrehozás felforgatóként	allocatesubversion		boolean	Teljes verzió helyett alverzióként hozhat létre.
Új verziójú dokumentum tartalma	body		binary	Az új verzió tartalma, ha nem másol egy másik verziót vagy a hivatalos verziót.

Válaszok

Name	Elérési út	Típus	Description
latestVersionNumber	latestVersionNumber	integer
newVer	newVer	integer
newVersionLabel	newVersionLabel	string
officialVer	officialVer	integer
officialVerName	officialVerName	string
versions	versions	integer

Dokumentumelőzmények

Műveletazonosító:

GetDocHistory

Dokumentumon végrehajtott műveletek listájának lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	12 jegyű dokumentumazonosító.

Dokumentumprofil lekérése

Műveletazonosító:

GetDocInfo

Dokumentum adatainak lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	12 jegyű dokumentumazonosító.

Dokumentumtartalom lekérése

Műveletazonosító:

GetDocContent

Dokumentum lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	12 jegyű dokumentumazonosító.
Base64 kódolású?	base64		boolean	Base64 kódolású?

Dokumentumverzió zárolása

Műveletazonosító:

LockDocumentVersion

Dokumentumverzió zárolása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	id	True	string	12 jegyű dokumentumazonosító.
Dokumentum verziója	version	True	integer	Dokumentum verziója
Verzió leírása	description		string	Verzió leírása

Dokumentumverziók lekérése

Műveletazonosító:

GetDocumentVersions

Dokumentumverziók lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	documentID	True	string	12 jegyű dokumentumazonosító.

Felfedetlen kabinetcsoportok hozzáférési jogosultságának lekérése

Műveletazonosító:

GetCabinetDefaultAccess

Felfedetlen kabinetcsoportok hozzáférési jogosultságának lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kabinetazonosító	cabinetID	True	string	(NG-vel kezdődik.)

Válaszok

Name	Elérési út	Típus	Description
		array of object
kormányoz	administer	boolean
cabDefault	cabDefault	boolean
szerkesztés	edit	boolean
név	name	string
noAccess	noAccess	boolean
rendszerbiztonsági tag	principal	string
megoszt	share	boolean
nézet	view	boolean

Felhasználó hozzáadása vagy eltávolítása az adattárból

Műveletazonosító:

AddOrRemoveUserRepository

Felhasználó hozzáadása vagy eltávolítása az adattárból

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik))
Felhasználó hozzáadása vagy eltávolítása	action	True	string	Felhasználó hozzáadása vagy eltávolítása
Felhasználói azonosító	member	True	string	Felhasználói azonosító
A felhasználó külső	external	True	boolean	A felhasználó külső
Felhasználó törlése (ha összevont)	deleteIfFederated		boolean	(Csak eltávolítás esetén alkalmazható)

Felhasználó létrehozása

Műveletazonosító:

CreateUser

Felhasználó létrehozása adattárban

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Felhasználónév	username	True	email	(Ugyanaz, mint a felhasználó e-mail-címe)
Keresztnév	displayFirstName	True	string	Keresztnév
Középső név	displayMiddleName		string	Középső név
Vezetéknév	displayLastName	True	string	Vezetéknév
Email cím	email	True	email	Email cím
A felhasználó külső	external	True	boolean	(Csak hozzáadás esetén alkalmazható)
Üdvözlő e-mail küldése	sendWelcome	True	boolean	Üdvözlő e-mail küldése
Adattár azonosítója	repository	True	string	(Ca-val kezdődik))

Válaszok

Name	Elérési út	Típus	Description
kijelző neve	displayName	string
e-mail	email	email
azonosító	id	string
külső	external	boolean

Felhasználói adatok lekérése

Műveletazonosító:

GetUserInfo

Felhasználó adatainak lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Felhasználói azonosító	id	True	string	A NetDocuments által hozzárendelt felhasználói azonosító.
Kabinetazonosító	cabGuid		string	(NG-vel kezdődik.)

Válaszok

Name	Elérési út	Típus	Description
kijelző neve	displayName	string
e-mail	email	email
azonosító	id	string
szervezet	organization	string
isRepositoryMember	isRepositoryMember	boolean
primaryCabinet	primaryCabinet	string
sortLookupBy	sortLookupBy	string
külső	external	boolean

Felhasználói szekrények listájának lekérése

Műveletazonosító:

GetUserCabinets

Felhasználói szekrények lekérése

Válaszok

Name	Elérési út	Típus	Description
		array of object
azonosító	id	string
isCollaborationSpacesEnabled	isCollaborationSpacesEnabled	string
név	name	string
adattárazonosító	repositoryId	string
repositoryName	repositoryName	string
wsAttrNum	wsAttrNum	integer
wsOrgAttrNum	wsOrgAttrNum	integer

Fájl vagy fájlfájl törlése mappába

Műveletazonosító:

FileFolder

Fájlba rendezhet egy elemet egy mappában, vagy törölhet egy elemet egy mappából.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Mappaazonosító	id	True	string	12 jegyű mappaazonosító.
Dokumentumazonosító	item	True	string	12 jegyű dokumentumazonosító.
Fájl vagy fájl törlése	action	True	string	Fájl vagy fájl törlése

Gyermek keresési tábla bejegyzésének lekérése

Műveletazonosító:

GetChildEntry

Gyermek keresési tábla bejegyzésének lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik.)
Gyermekattribútum azonosítója	childAttributeID	True	string	(A kezdő '10' eltávolítása)
Szülőkulcs	parentID	True	string	Szülőkulcs
Gyermekkulcs	childID	True	string	Gyermekkulcs

Gyermek keresési tábla bejegyzésének létrehozása vagy frissítése

Műveletazonosító:

CreateChildEntry

Gyermek keresési tábla bejegyzésének létrehozása vagy frissítése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik.)
Gyermekattribútum azonosítója	childAttributeID	True	string	(A kezdő '10' eltávolítása)
Szülőkulcs	parentID	True	string	Szülőkulcs
Gyermekkulcs	childID	True	string	Gyermekkulcs
Description	description		string
Típus	defaulting		string
Peres eljárás visszatartása	hold		boolean
Záró dátum	closed		string	Formátum : "/Date(1970. január 1-től számított millisek száma+-UTC", például: "/Date(1582261200000-0500)/"
Szűrt engedélyek	filtered_permissions	True	boolean
Kényszeres permsziók	force_permissions	True	boolean
View	view	True	boolean
Edit	edit	True	boolean
Megosztás	share	True	boolean
Felügyelet	administer	True	boolean
Nincs hozzáférés	noAccess	True	boolean
A kabinet alapértelmezett beállítása	cabDefault	True	boolean
Vezető	principal	True	string	(Felhasználó vagy csoport azonosítója)

Válaszok

Name	Elérési út	Típus	Description
count	count	integer

Gyermek keresési tábla bejegyzésének törlése

Műveletazonosító:

DeleteChildEntry

Gyermek keresési tábla bejegyzésének törlése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik.)
Gyermekattribútum azonosítója	childAttributeID	True	string	(A kezdő '10' eltávolítása)
Szülőkulcs	parentID	True	string	Szülőkulcs
Gyermekkulcs	childID	True	string	Gyermekkulcs

Válaszok

Name	Elérési út	Típus	Description
count	count	integer

Kabinet egyéni attribútumainak lekérése

Műveletazonosító:

GetCabinetCustomAttributes

Kabinet egyéni attribútumainak lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kabinetazonosító	cabinetID	True	string	(NG-vel kezdődik.)

Válaszok

Name	Elérési út	Típus	Description
		array of object
items		object

Kabinet keresése és ACL-ek módosítása

Műveletazonosító:

SearchCabinetModifyACLs

Kabinet keresése és ACL-ek módosítása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kabinetazonosító	cabinetID	True	string	(NG-vel kezdődik.)
Query	q	True	string	(Tekintse át a lekérdezés formátumának dokumentációját)
ACL mód módosítása	mode	True	string	ACL mód módosítása
Új ACL	newAcl	True	string	(Tekintse át a dokumentációt a megfelelő json formátumhoz)
Email cím	email		email	(Értesítés küldése erre a címre)
Befejező e-mailek küldése	completionEmail		string	(true = send always (alapértelmezett), false = don't send, fail = send only on fail)

Kabinetcsoportok lekérése

Műveletazonosító:

GetCabinetGroups

Az összes csoport hozzáadása egy szekrényhez

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kabinetazonosító	cabinetID	True	string	(NG-vel kezdődik.)

Válaszok

Name	Elérési út	Típus	Description
		array of object
Azonosító	Id	string
Név	Name	string
External	External	boolean
Rejtett	Hidden	boolean

Keresés egy vagy több szekrényben

Műveletazonosító:

SearchCabinets

Keresés egy vagy több szekrényben

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Szekrények	cabinets	True	string	(vesszőből tagolt)
Query	q	True	string	(Tekintse át a lekérdezés formátumának dokumentációját)
Visszaküldött információk	select	True	string	(Tekintse át a visszaküldési formátum dokumentációját)
Megrendelés a következő szerint:	orderby		string	(Formátum: mező#|desc vagy mező#|asc)
A visszaadandó eredmények száma (alapértelmezés szerint 50)	top		integer	(Oldalanként legfeljebb 500)
Kihagyandó eredmények száma	skip		integer	Kihagyandó eredmények száma
Az eredmények lapszámozásához használt jogkivonat	skiptoken		string	Az eredmények lapszámozásához használt jogkivonat

Keresési tábla bejegyzéseinek keresése

Műveletazonosító:

SearchLookupEntries

Keresési tábla bejegyzéseinek keresése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik.)
Attribútumazonosító	attributeID	True	string	(A kezdő '10' eltávolítása)
Filter	$filter		string	(Lásd a rendelkezésre álló szűrők dokumentációját)
Lekérendő mezők	$select		string	(A következő vesszővel tagolt lista belefoglalása: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user', and/or 'access')
Kihagyandó egyező rekordok száma	$skip		integer	(Ez több találatblokk lekérésekor használatos.)
Visszaadandó rekordok maximális száma	$top		integer	Visszaadandó rekordok maximális száma

Válaszok

Name	Elérési út	Típus	Description
Sorok	rows	array of object
Mulasztó	rows.defaulting	string
leírás	rows.description	string
tart	rows.hold	boolean
kulcs	rows.key	string
zárt	rows.closed	string
hozzáférés	rows.access	string

Keresési tábla bejegyzésének lekérése vagy gyermektábla-bejegyzések keresése

Műveletazonosító:

GetLookupEntry

Keresési tábla bejegyzésének lekérése vagy gyermektábla-bejegyzések keresése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik.)
Attribútumazonosító	attributeID	True	string	(Távolítsa el a kezdő 10-et. Egyetlen érték visszaadásához adja meg a szülőattribútum azonosítóját, vagy gyermekbejegyzések kereséséhez adja meg a gyermekattribútum azonosítóját.)
Key	parentID	True	string	(Egyetlen érték visszaadásához adja meg az egyetlen attribútum kulcsát, vagy gyermekbejegyzések kereséséhez adja meg a szülő kulcsát.)
Szűrés (csak kereséskor)	$filter		string	(Lásd a rendelkezésre álló szűrők dokumentációját)
Lekérendő mezők	$select		string	(A következő vesszővel tagolt lista belefoglalása: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user', and/or 'access')
Kihagyandó egyező rekordok száma	$skip		integer	(Ez több találatblokk lekérésekor használatos.)
Visszaadandó rekordok maximális száma	$top		integer	Visszaadandó rekordok maximális száma
Rendelési eredmények a következő szerint:	$orderby		string	Rendelési eredmények a következő szerint:

Keresési tábla bejegyzésének létrehozása vagy frissítése

Műveletazonosító:

CreateEntry

Keresési tábla bejegyzésének létrehozása vagy frissítése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik.)
Attribútumazonosító	attributeID	True	string	(A kezdő '10' eltávolítása)
Key	parentID	True	string	Key
Description	description		string
Típus	defaulting		string
Peres eljárás visszatartása	hold		boolean
Záró dátum	closed		string	Formátum : "/Date(1970. január 1-től számított millisek száma+-UTC", például: "/Date(1582261200000-0500)/"
Szűrt engedélyek	filtered_permissions	True	boolean
Kényszeres permsziók	force_permissions	True	boolean
View	view	True	boolean
Edit	edit	True	boolean
Megosztás	share	True	boolean
Felügyelet	administer	True	boolean
Nincs hozzáférés	noAccess	True	boolean
A kabinet alapértelmezett beállítása	cabDefault	True	boolean
Vezető	principal	True	string	(Felhasználó vagy csoport azonosítója)

Válaszok

Name	Elérési út	Típus	Description
count	count	integer

Keresési tábla bejegyzésének törlése

Műveletazonosító:

DeleteLookupEntry

Keresési tábla bejegyzésének törlése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Adattár azonosítója	repositoryID	True	string	(Ca-val kezdődik.)
Attribútumazonosító	attributeID	True	string	(A kezdő '10' eltávolítása)
Key	parentID	True	string	Key

Válaszok

Name	Elérési út	Típus	Description
count	count	integer

Külső kabinetcsoport létrehozása

Műveletazonosító:

CreateCabinetExternalGroup

Külső kabinetcsoport létrehozása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kabinetazonosító	cabinetID	True	string	(NG-vel kezdődik.)
Csoport neve	name	True	string	Csoport neve
Csoportbeállítások	options		string	Csoportbeállítások
A kabinet alapértelmezett hozzáférése	access		string	A kabinet alapértelmezett hozzáférése
CollabSpace-azonosító	collaborationSpaceId		string	(A CollabSpace-külső csoport létrehozása)
CollabSpace-hozzáférés	collaborationspaceaccess		string	CollabSpace-hozzáférés
A munkaterület legfontosabb attribútumértéke	topwsattributegroupkey		string	(Normál kabinet külső csoportok esetén; a csoport társítása egy adott legfelső munkaterületi attribútumértékkel)

Válaszok

Name	Elérési út	Típus	Description
Típus	Type	integer
Azonosító	Id	string
Név	Name	string
Beállítások	Options	string
Access	Access	string

Mappa követése

Műveletazonosító:

FollowFolder

Riasztások fogadása új tartalom mappába való hozzáadásakor

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Mappaazonosító	id	True	string	12 jegyű mappaazonosító.
Címzettek	recipients	True	string	Egy vagy több érvényes e-mail-cím pontosvesszővel elválasztva. Az ismétlődések figyelmen kívül hagyva.
Küld	send		string	A felhasználók melyik kategóriája kapja meg a riasztást.

Mappa létrehozása

Műveletazonosító:

CreateFolder

Új mappa létrehozása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Mappa neve	name	True	string	Mappa neve.
Szülőazonosító	parent		string	Az új mappa szülőtárolójának 12 jegyű azonosítója vagy EnvID azonosítója.
Kabinetazonosító	cabinet		string	(NG-vel kezdődik.) Kihagyható, ha a szülőben meg van adva mappa- vagy munkaterület-azonosító.

Válaszok

Name	Elérési út	Típus	Description
azonosító	standardAttributes.id	string
név	standardAttributes.name	string

Mappa törlése

Műveletazonosító:

DeleteFolder

Mappa törlése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Mappaazonosító	id	True	string	12 jegyű mappaazonosító.
Végleges törlés	permanent		boolean	Azt jelzi, hogy a mappát véglegesen törölni kell a törölt elemek helyett. A mappa tartalma, beleértve a leszármazott almappákat is, nem törlődik véglegesen.
Mappa tartalmának törlése	deleteContents		boolean	Azt jelzi, hogy a törölt mappában (és bármely leszármazott almappában) lévő dokumentumokat is törölni kell ahelyett, hogy egyszerűen törölné őket.

Mappa átnevezése

Műveletazonosító:

RenameFolder

Mappa átnevezése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Mappaazonosító	id	True	string	12 jegyű mappaazonosító.
Új név	name	True	string

Mappaelemek lekérése

Műveletazonosító:

GetFldContent

Mappa tartalmának lekérése, beleértve a dokumentumokat és az almappákat

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Mappaazonosító	id	True	string	12 jegyű mappaazonosító.
Visszaadandó attribútumok	$select		string	Attribútumértékek vesszővel tagolt listája. További részletekért tekintse meg a REST API dokumentációját.

Munkaterület adatainak lekérése

Műveletazonosító:

GetWorkspaceInformation

Munkaterület adatainak lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Munkaterület azonosítója	workspaceID	True	string	Munkaterület azonosítója

Munkaterület frissítése

Műveletazonosító:

RefreshWorkspace

Munkaterület frissítése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Munkaterület azonosítója	workspaceID	True	string	Munkaterület azonosítója

Munkaterület lekérése vagy létrehozása (egyetlen attribútummal)

Műveletazonosító:

CreateWorkspaceSingle

Munkaterület lekérése vagy létrehozása (egyetlen attribútummal)

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kabinetazonosító	cabinetID	True	string	(NG-vel kezdődik.)
Egyetlen érték	parentID	True	string	A kabinetben lévő munkaterületek definiálásához használt egyetlen érték.

Válaszok

Name	Elérési út	Típus	Description
azonosító	standardAttributes.id	string

Munkaterület lekérése vagy létrehozása (szülő- és gyermekattribútumokkal)

Műveletazonosító:

CreateWorkspaceParentChild

Munkaterület lekérése vagy létrehozása (szülő- és gyermekattribútumokkal)

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kabinetazonosító	cabinetID	True	string	(NG-vel kezdődik.)
Szülőérték	parentID	True	string	A munkaterületek kabinetben való definiálásához használt szülőérték.
Gyermekérték	childID	True	string	A kabinet munkaterületeinek definiálásához használt gyermekérték.

Válaszok

Name	Elérési út	Típus	Description
azonosító	standardAttributes.id	string

Tároló tartalmának lekérése

Műveletazonosító:

GetContainerContents

A kijelölt tároló tartalmának lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Tárolóazonosító	containerID	True	string	Tárolóazonosító
Visszaküldött információk	select	True	string	(Tekintse át a visszaküldési formátum dokumentációját)
A visszaadandó eredmények száma (alapértelmezés szerint 50)	top		integer	(Oldalanként legfeljebb 500)
Az eredmények lapszámozásához használt jogkivonat	skiptoken		string	Az eredmények lapszámozásához használt jogkivonat
Megrendelés a következő szerint:	orderby		string	(Formátum: mező#|desc vagy mező#|asc)

Triggerek

Keresési kabinet

Keresés a megadott kabinetben

Keresési kabinet

Műveletazonosító:

SearchCab

Keresés a megadott kabinetben

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kabinetazonosító	cabId	True	string	(NG-vel kezdődik.)
Keresési feltételek	q	True	string	Használja ugyanazt a formátumot és operátorokat, mint a NetDocuments webes felületén.
Megrendelés a következő szerint:	$orderby		string	Megrendelés a következő szerint:
Találatok maximális száma	$top		string	1 és 500 közötti egész szám. Az alapértelmezett érték 100.
Visszaadandó attribútumok	$select		string	Attribútumértékek vesszővel tagolt listája. További részletekért tekintse meg a REST API dokumentációját.