NetDocuments

NetDocuments je cloudová služba pro správu obsahu pro firmy všech velikostí, která umožňuje bezpečně vytvářet, ukládat, spravovat a sdílet své dokumenty kdekoli a kdykoli.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Standard	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Logic Apps	Standard	Všechny oblasti Logic Apps s výjimkou následujících:      – Oblasti Azure Government      – Oblasti Azure China      - Ministerstvo obrany USA (DoD)
Power Apps	Standard	Všechny oblasti Power Apps s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Power Automate	Standard	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)

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

Metadata konektoru
Vydavatel	NetDocuments Software, Inc.
Internetová stránka	https://www.netdocuments.com/
Zásady ochrany osobních údajů	https://www.netdocuments.com/privacy-policy/

Vytvoření připojení

Konektor podporuje následující typy ověřování:

výchozí	Parametry pro vytvoření připojení	Všechny oblasti	Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název	Typ	Description	Povinné
Región	řetězec	Oblast, ve které se nachází váš čistý dokument.	Pravdivé

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Aktualizace dokumentu	Aktualizace obsahu dokumentu
Aktualizace pracovního prostoru	Aktualizace pracovního prostoru
Historie dokumentů	Načtení seznamu akcí provedených v dokumentu
Hledání jednoho nebo více skříní	Hledání jednoho nebo více skříní
Hledání položek vyhledávací tabulky	Hledání položek vyhledávací tabulky
Hledání v souboru CAB a úprava seznamů ACL	Hledání v souboru CAB a úprava seznamů ACL
Odemknutí dokumentu	Rozbalte dokument
Odstranit dokument	Odstranění dokumentu
Odstranit složku	Odstranění složky
Odstranění položky podřízené vyhledávací tabulky	Odstranění položky podřízené vyhledávací tabulky
Odstranění položky vyhledávací tabulky	Odstranění položky vyhledávací tabulky
Odstranění skupiny úložišť	Odstranění skupiny úložišť
Přejmenovat složku	Přejmenování složky
Přejmenování dokumentu	Přejmenování dokumentu
Přidání nebo odebrání skupiny z cab	Přidání skupiny do souboru CAB a výchozích přístupových práv
Přidání nebo odebrání uživatele z úložiště	Přidání nebo odebrání uživatele z úložiště
Přidání nebo odebrání člena skupiny	Přidání nebo odebrání člena skupiny
Rezervovat dokument	Rezervace dokumentu
Sledovat složku	Příjem upozornění při přidání nového obsahu do složky
Sledování dokumentu	Příjem upozornění při aktualizaci dokumentu
Soubor nebo zrušení souboru dokumentu do složky	Vytvořte položku ve složce nebo ji odložte ze složky.
Uzamknout verzi dokumentu	Uzamknout verzi dokumentu
Vrácení dokumentu se změnami	Vrácení rezervovaného dokumentu se změnami
Vytvoření collabSpace	Vytvoření nového prostoru CollabSpace
Vytvoření dokumentu	Umožňuje vytvořit nový dokument.
Vytvoření externí skupiny cab	Vytvoření externí skupiny cab
Vytvoření nebo aktualizace položky podřízené vyhledávací tabulky	Vytvoření nebo aktualizace položky podřízené vyhledávací tabulky
Vytvoření nebo aktualizace položky vyhledávací tabulky	Vytvoření nebo aktualizace položky vyhledávací tabulky
Vytvoření nové verze dokumentu	Vytvoření nové verze dokumentu
Vytvoření skupiny úložišť	Vytvoření skupiny úložiště
Vytvoření uživatele	Vytvoření uživatele v úložišti
Vytvoření zabezpečeného propojení	Vygenerování odkazu na dokument, ke kterému má přístup kdokoli
Vytvořit složku	Vytvoření nové složky
Zamknout dokument	Zamknout dokument
Získání aktuálních informací o uživateli	Získání informací o aktuálním uživateli, ID není povinné
Získání informací o pracovním prostoru	Získání informací o pracovním prostoru
Získání informací o skupině	Získání informací o skupině
Získání informací o skříni	Získání informací o skříni
Získání informací o uživateli	Získání informací o uživateli
Získání informací o úložišti	Získání informací o úložišti
Získání nastavení skříně	Získání nastavení skříně
Získání nebo vytvoření pracovního prostoru (s jedním atributem)	Získání nebo vytvoření pracovního prostoru (s jedním atributem)
Získání nebo vytvoření pracovního prostoru (s nadřazenými a podřízenými atributy)	Získání nebo vytvoření pracovního prostoru (s nadřazenými a podřízenými atributy)
Získání obsahu dokumentu	Načtení dokumentu
Získání obsahu kontejneru	Získání obsahu vybraného kontejneru
Získání položek složky	Načtení obsahu složky, včetně dokumentů a podsložek
Získání položky podřízené vyhledávací tabulky	Získání položky podřízené vyhledávací tabulky
Získání položky vyhledávací tabulky nebo hledání podřízených položek tabulky	Získání položky vyhledávací tabulky nebo hledání podřízených položek tabulky
Získání profilu dokumentu	Získání informací o dokumentu
Získání protokolu úložiště	Získání protokolu úložiště
Získání přístupových práv ke skrytým skupinám cab	Získání přístupových práv ke skrytým skupinám cab
Získání seznamu uživatelských skříní	Získání uživatelských skříní
Získání skupin cab	Získání všech skupin přidaných do skříně
Získání skupin úložišť	Získání skupin úložišť
Získání uživatelů úložiště	Získání uživatelů úložiště
Získání verzí dokumentů	Získání verzí dokumentů
Získání vlastních atributů cab	Získání vlastních atributů cab
Získání členství ve skupinách	Získání členství ve skupinách

Aktualizace dokumentu

ID operace:

UpdateDocument

Aktualizace obsahu dokumentu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	12místné ID dokumentu.
Rozšíření dokumentu	extension		string	Je to nutné jenom v případě, že změníte příponu dokumentu. Nezahrnujte úvodní období.
Kódování Base64?	base64		boolean	Kódování Base64?
Aktualizovaný obsah dokumentu	body	True	byte	Obsah dokumentu.

Aktualizace pracovního prostoru

ID operace:

RefreshWorkspace

Aktualizace pracovního prostoru

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Identifikátor pracovního prostoru	workspaceID	True	string	Identifikátor pracovního prostoru

Historie dokumentů

ID operace:

GetDocHistory

Načtení seznamu akcí provedených v dokumentu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	12místné ID dokumentu.

Hledání jednoho nebo více skříní

ID operace:

SearchCabinets

Hledání jednoho nebo více skříní

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Kabinety	cabinets	True	string	(oddělené čárkami)
Query	q	True	string	(Projděte si dokumentaci pro formát dotazu.
Informace, které se mají vrátit	select	True	string	(Projděte si dokumentaci pro návratový formát.
Order by	orderby		string	(Formát: pole#|desc nebo pole#|asc)
Počet výsledků, které se mají vrátit (výchozí hodnota je 50)	top		integer	(Maximálně 500 na stránku)
Počet výsledků, které se mají přeskočit	skip		integer	Počet výsledků, které se mají přeskočit
Token použitý pro stránkování výsledků	skiptoken		string	Token použitý pro stránkování výsledků

Hledání položek vyhledávací tabulky

ID operace:

SearchLookupEntries

Hledání položek vyhledávací tabulky

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)
ID atributu	attributeID	True	string	(Odeberte úvodní 10.
Filter	$filter		string	(Dostupné filtry najdete v dokumentaci)
Pole, která se mají načíst	$select		string	(Zahrnout čárkami oddělený seznam: "klíč", "description", "parent", "hold", 'closed', 'defaulting', 'type', 'user' and/or 'access')
Počet odpovídajících záznamů, které se mají přeskočit	$skip		integer	(Používá se při načítání více bloků výsledků.)
Maximální počet záznamů, které se mají vrátit	$top		integer	Maximální počet záznamů, které se mají vrátit

Návraty

Name	Cesta	Typ	Description
řádky	rows	array of object
nesplnění	rows.defaulting	string
popis	rows.description	string
držet	rows.hold	boolean
klíč	rows.key	string
uzavřený	rows.closed	string
přístup	rows.access	string

Hledání v souboru CAB a úprava seznamů ACL

ID operace:

SearchCabinetModifyACLs

Hledání v souboru CAB a úprava seznamů ACL

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skříně	cabinetID	True	string	(Začíná NG-)
Query	q	True	string	(Projděte si dokumentaci pro formát dotazu.
Úprava režimu seznamu ACL	mode	True	string	Úprava režimu seznamu ACL
Nový seznam ACL	newAcl	True	string	(Projděte si dokumentaci pro správný formát JSON.
E-mailová adresa	email		email	(Místo toho odešlete oznámení na tuto adresu.
Odesílání e-mailů o dokončení	completionEmail		string	(true = send always (default), false = don't send, fail = send only on fail)

Odemknutí dokumentu

ID operace:

UnockDocument

Rozbalte dokument

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	ID dokumentu

Odstranit dokument

ID operace:

DeleteDoc

Odstranění dokumentu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	12místné ID dokumentu.
Trvalé odstranění	permanent		boolean	Označuje, že dokument by se měl trvale odstranit, a ne přesunout do odstraněných položek.

Odstranit složku

ID operace:

DeleteFolder

Odstranění složky

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID složky	id	True	string	12místné ID složky
Trvalé odstranění	permanent		boolean	Označuje, že složka by měla být trvale odstraněna, a ne přesunuta do odstraněných položek. Obsah složky, včetně následnických podsložek, se trvale neodstraní.
Odstranění obsahu složky	deleteContents		boolean	Označuje, že dokumenty v odstraněné složce (a v jakékoli podsložce potomků) by se měly odstranit i místo toho, aby se nefiltrovaly.

Odstranění položky podřízené vyhledávací tabulky

ID operace:

DeleteChildEntry

Odstranění položky podřízené vyhledávací tabulky

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)
ID podřízeného atributu	childAttributeID	True	string	(Odeberte úvodní 10.
Nadřazený klíč	parentID	True	string	Nadřazený klíč
Podřízený klíč	childID	True	string	Podřízený klíč

Návraty

Name	Cesta	Typ	Description
count	count	integer

Odstranění položky vyhledávací tabulky

ID operace:

DeleteLookupEntry

Odstranění položky vyhledávací tabulky

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)
ID atributu	attributeID	True	string	(Odeberte úvodní 10.
Key	parentID	True	string	Key

Návraty

Name	Cesta	Typ	Description
count	count	integer

Odstranění skupiny úložišť

ID operace:

DeleteRepositoryGroup

Odstranění skupiny úložišť

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)
ID skupiny	groupID	True	string	(Začíná UG-)

Přejmenovat složku

ID operace:

RenameFolder

Přejmenování složky

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID složky	id	True	string	12místné ID složky
Nový název	name	True	string

Přejmenování dokumentu

ID operace:

RenameDocument

Přejmenování dokumentu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	12místné ID dokumentu.
Nový název	name	True	string

Přidání nebo odebrání skupiny z cab

ID operace:

AddToOrRemoveGroupFromCabinet

Přidání skupiny do souboru CAB a výchozích přístupových práv

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skříně	cabinetID	True	string	(Začíná NG-)
Přidání nebo odebrání skupiny	action	True	string	Přidání nebo odebrání skupiny
ID skupiny	id	True	string	ID skupiny (začíná UG-).
Zobrazit práva	view	True	boolean	Zobrazit práva (V) – pouze pro přidání
Upravit práva	edit	True	boolean	Upravit práva (E) – pouze pro přidání.
Práva ke sdílení	share	True	boolean	Práva ke sdílení (S) – pouze pro přidání.
Správa práv	administer	True	boolean	Správa práv (A) – pouze pro přidání.
Žádná přístupová práva	noAccess	True	boolean	Žádná přístupová práva (N) – pouze pro přidání.

Přidání nebo odebrání uživatele z úložiště

ID operace:

AddOrRemoveUserRepository

Přidání nebo odebrání uživatele z úložiště

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)
Přidání nebo odebrání uživatele	action	True	string	Přidání nebo odebrání uživatele
ID uživatele	member	True	string	ID uživatele
Uživatel je externí	external	True	boolean	Uživatel je externí
Odstranění uživatele (pokud je federováno)	deleteIfFederated		boolean	(Platí pouze pro odebrání)

Přidání nebo odebrání člena skupiny

ID operace:

AddOrRemoveGroupMember

Přidání nebo odebrání člena skupiny

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	groupID	True	string	(Začíná UG-)
Přidání nebo odebrání uživatele	action	True	string	Přidání nebo odebrání uživatele
ID uživatele	member	True	string	(Musí být již členem úložiště.)

Rezervovat dokument

ID operace:

CheckOutDoc

Rezervace dokumentu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	12místné ID dokumentu.
Comment	comment		string	Comment
Stáhnout dokument	download		boolean	Vrátí obsah dokumentu.
Verze ke stažení	version		string	Určuje, která verze obsahu se má stáhnout. Výchozí hodnota je oficiální verze.
Přidat do posledního	addToRecent		boolean	Přidat do posledního

Sledovat složku

ID operace:

FollowFolder

Příjem upozornění při přidání nového obsahu do složky

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID složky	id	True	string	12místné ID složky
Příjemci	recipients	True	string	Jedna nebo více platných e-mailových adres oddělených středníky. Duplicitní položky se ignorují.
Poslat	send		string	Která kategorie uživatelů by měla výstrahu obdržet.

Sledování dokumentu

ID operace:

FollowDocument

Příjem upozornění při aktualizaci dokumentu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	12místné ID dokumentu.
Příjemci	recipients	True	string	Jedna nebo více platných e-mailových adres oddělených středníky. Duplicitní položky se ignorují.
Poslat	send		string	Která kategorie uživatelů by měla výstrahu obdržet.

Soubor nebo zrušení souboru dokumentu do složky

ID operace:

FileFolder

Vytvořte položku ve složce nebo ji odložte ze složky.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID složky	id	True	string	12místné ID složky
ID dokumentu	item	True	string	12místné ID dokumentu.
Soubor nebo zrušení souboru	action	True	string	Soubor nebo zrušení souboru

Uzamknout verzi dokumentu

ID operace:

LockDocumentVersion

Uzamknout verzi dokumentu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	12místné ID dokumentu.
Verze dokumentu	version	True	integer	Verze dokumentu
Popis verze	description		string	Popis verze

Vrácení dokumentu se změnami

ID operace:

CheckinDoc

Vrácení rezervovaného dokumentu se změnami

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	12místné ID dokumentu.
Rozšíření dokumentu	extension		string	Nezahrnujte úvodní období.
Obsah dokumentu	file		file	Dokument ve formuláři s více částmi
Přidat do posledního	addToRecent		boolean	Přidejte do seznamu posledních dokumentů uživatele.

Vytvoření collabSpace

ID operace:

CreateCollabSpace

Vytvoření nového prostoru CollabSpace

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Identifikátor pracovního prostoru	workspaceID	True	string	Identifikátor pracovního prostoru
Název CollabSpace	name	True	string	Název CollabSpace
Description	description		string	Description

Návraty

Name	Cesta	Typ	Description
identifikační číslo	Id	string
EnvUrl	EnvUrl	string

Vytvoření dokumentu

ID operace:

CreateDocument

Umožňuje vytvořit nový dokument.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Cíl	destination	True	string	12místné ID nebo EnvID složky, filtru nebo pracovního prostoru.
Obsah dokumentu	file	True	file	Do doprovodného pole názvu souboru vložte příponu plus.
Přidat do posledního	addToRecent		boolean	Přidat do posledního
Profil dokumentu	profile		string	Nastavení profilu dokumentu (formát JSON)

Návraty

Name	Cesta	Typ	Description
identifikační číslo	id	string
přípona	extension	string
název	name	string

Vytvoření externí skupiny cab

ID operace:

CreateCabinetExternalGroup

Vytvoření externí skupiny cab

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skříně	cabinetID	True	string	(Začíná NG-)
Název skupiny	name	True	string	Název skupiny
Možnosti skupiny	options		string	Možnosti skupiny
Výchozí přístup cab	access		string	Výchozí přístup cab
CollabSpace ID	collaborationSpaceId		string	(Chcete-li tuto skupinu nastavit jako externí skupinu CollabSpace)
Přístup ke službě CollabSpace	collaborationspaceaccess		string	Přístup ke službě CollabSpace
Nejvyšší hodnota atributu pracovního prostoru	topwsattributegroupkey		string	(Pro běžné externí skupiny cab; pro přidružení skupiny ke konkrétní hodnotě atributu top pracovního prostoru)

Návraty

Name	Cesta	Typ	Description
Typ	Type	integer
identifikační číslo	Id	string
Název	Name	string
Možnosti	Options	string
Access	Access	string

Vytvoření nebo aktualizace položky podřízené vyhledávací tabulky

ID operace:

CreateChildEntry

Vytvoření nebo aktualizace položky podřízené vyhledávací tabulky

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)
ID podřízeného atributu	childAttributeID	True	string	(Odeberte úvodní 10.
Nadřazený klíč	parentID	True	string	Nadřazený klíč
Podřízený klíč	childID	True	string	Podřízený klíč
Description	description		string
Typ	defaulting		string
Blokování soudních sporů	hold		boolean
Datum uzavření	closed		string	Formát '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/'
Filtrovaná oprávnění	filtered_permissions	True	boolean
Vynucené permsze	force_permissions	True	boolean
Zobrazit	view	True	boolean
Edit	edit	True	boolean
Sdílet	share	True	boolean
Spravovat	administer	True	boolean
Žádný přístup	noAccess	True	boolean
Výchozí nastavení cab	cabDefault	True	boolean
Ředitel školy	principal	True	string	(ID uživatele nebo skupiny)

Návraty

Name	Cesta	Typ	Description
count	count	integer

Vytvoření nebo aktualizace položky vyhledávací tabulky

ID operace:

CreateEntry

Vytvoření nebo aktualizace položky vyhledávací tabulky

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)
ID atributu	attributeID	True	string	(Odeberte úvodní 10.
Key	parentID	True	string	Key
Description	description		string
Typ	defaulting		string
Blokování soudních sporů	hold		boolean
Datum uzavření	closed		string	Formát '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/'
Filtrovaná oprávnění	filtered_permissions	True	boolean
Vynucené permsze	force_permissions	True	boolean
Zobrazit	view	True	boolean
Edit	edit	True	boolean
Sdílet	share	True	boolean
Spravovat	administer	True	boolean
Žádný přístup	noAccess	True	boolean
Výchozí nastavení cab	cabDefault	True	boolean
Ředitel školy	principal	True	string	(ID uživatele nebo skupiny)

Návraty

Name	Cesta	Typ	Description
count	count	integer

Vytvoření nové verze dokumentu

ID operace:

NewVersion

Vytvoření nové verze dokumentu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	12místné ID dokumentu.
Rozšíření dokumentu	extension		string	Nezahrnujte úvodní období.
Popis verze	version_description		string	Popis verze
Název nové verze	verName		string	Název nové verze
Vytvoření oficiální verze	official		boolean	Nová verze nebude oficiální verzí, pokud tento parametr není nastavený.
Přidat do posledních dokumentů	addToRecent		boolean	Přidat do posledních dokumentů
Číslo zdrojové verze	srcVer		string	Pokud kopírujete obsah z předchozí verze, kterou verzi dokumentu chcete zkopírovat.
Vytvoření jako subversion	allocatesubversion		boolean	Vytvořte jako subversion místo jako plnou verzi.
Obsah dokumentu nové verze	body		binary	Obsah nové verze, pokud nekopíruje jinou verzi nebo oficiální verzi.

Návraty

Name	Cesta	Typ	Description
latestVersionNumber	latestVersionNumber	integer
newVer	newVer	integer
newVersionLabel	newVersionLabel	string
officialVer	officialVer	integer
officialVerName	officialVerName	string
versions	versions	integer

Vytvoření skupiny úložišť

ID operace:

CreateRepositoryGroup

Vytvoření skupiny úložiště

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)
Název skupiny	name	True	string	Název skupiny
External	external	True	boolean	External
Skrýt v seznamech	hidden	True	boolean	Skrýt v seznamech
Skryté členství	hideMembership	True	boolean	Skryté členství

Návraty

Name	Cesta	Typ	Description
externí	external	boolean
skrytý	hidden	boolean
hideMembership	hideMembership	boolean
identifikační číslo	id	string
název	name	string

Vytvoření uživatele

ID operace:

CreateUser

Vytvoření uživatele v úložišti

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Uživatelské jméno	username	True	email	(Stejné jako e-mailová adresa uživatele)
Křestní jméno	displayFirstName	True	string	Křestní jméno
Druhé jméno	displayMiddleName		string	Druhé jméno
Příjmení	displayLastName	True	string	Příjmení
E-mailová adresa	email	True	email	E-mailová adresa
Uživatel je externí	external	True	boolean	(Platí pouze pro přidání)
Odeslat uvítací e-mail	sendWelcome	True	boolean	Odeslat uvítací e-mail
ID úložiště	repository	True	string	(Začíná certifikační autoritou-)

Návraty

Name	Cesta	Typ	Description
zobrazované jméno	displayName	string
e-mail	email	email
identifikační číslo	id	string
externí	external	boolean

Vytvoření zabezpečeného propojení

ID operace:

CreateSecuredLink

Vygenerování odkazu na dokument, ke kterému má přístup kdokoli

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	12místné ID dokumentu.
Heslo pro zabezpečený odkaz	password		string	V závislosti na konfiguraci skříně může být heslo volitelné nebo povinné.
Datum vypršení platnosti zabezpečeného propojení	expirationdate		string	Vstupní formát: rrrr-MM-dd.
Verze dokumentu	version		string	Kterou verzi dokumentu chcete sdílet. Pokud je tato hodnota prázdná, bude oficiální verze sdílena.
Stáhnout dokument	download		boolean	Pokud ano, může dokument stáhnout příjemce.
Upozornit mě	notifyme		boolean	Pokud je hodnota true, upozorněte odesílatele na přístup k zabezpečenému odkazu.
Zamknout dokument	lock		boolean	Volitelně můžete uzamknout vybranou verzi dokumentu. To vyžaduje práva pro úpravy.

Návraty

Name	Cesta	Typ	Description
pohled	standardAttributes.view	string
stáhnout	standardAttributes.download	string

Vytvořit složku

ID operace:

CreateFolder

Vytvoření nové složky

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název složky	name	True	string	Název složky.
Nadřazené ID	parent		string	12místné ID nebo EnvID nadřazeného kontejneru nové složky.
ID skříně	cabinet		string	(Začíná NG-) Pokud je v nadřazené položce zadáno ID složky nebo pracovního prostoru, můžete ho vynechat.

Návraty

Name	Cesta	Typ	Description
identifikační číslo	standardAttributes.id	string
název	standardAttributes.name	string

Zamknout dokument

ID operace:

LockDocument

Zamknout dokument

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	Id dokumentu
Comment	comment		string	Comment

Získání aktuálních informací o uživateli

ID operace:

GetCurrentUserInfo

Získání informací o aktuálním uživateli, ID není povinné

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skříně	cabGuid		string	(Začíná NG-)

Návraty

Name	Cesta	Typ	Description
zobrazované jméno	displayName	string
e-mail	email	email
identifikační číslo	id	string
organizace	organization	string
isRepositoryMember	isRepositoryMember	boolean
primaryCabinet	primaryCabinet	string
sortLookupBy	sortLookupBy	string
externí	external	boolean

Získání informací o pracovním prostoru

ID operace:

GetWorkspaceInformation

Získání informací o pracovním prostoru

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Identifikátor pracovního prostoru	workspaceID	True	string	Identifikátor pracovního prostoru

Získání informací o skupině

ID operace:

GetGroupInformation

Získání informací o skupině

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	groupID	True	string	ID skupiny (začíná UG-).
Členství ve skupině CAB	cabMembership		boolean	(Pokud je tato skupina nastavena na true, jsou tyto skupiny členy a budou zahrnuta výchozí přístupová práva k dokumentům pro každý soubor CAB.)

Návraty

Name	Cesta	Typ	Description
externí	external	boolean
skrytý	hidden	boolean
hideMembership	hideMembership	boolean
identifikační číslo	id	string
název	name	string
cabMembership	cabMembership	array of object
identifikační číslo	cabMembership.id	string
název	cabMembership.name	string
práva	cabMembership.rights	string

Získání informací o skříni

ID operace:

GetCabinetInformation

Získání informací o skříni

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skříně	cabinetID	True	string	(Začíná NG-)

Získání informací o uživateli

ID operace:

GetUserInfo

Získání informací o uživateli

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID uživatele	id	True	string	ID uživatele přiřazené rozhraním NetDocuments.
ID skříně	cabGuid		string	(Začíná NG-)

Návraty

Name	Cesta	Typ	Description
zobrazované jméno	displayName	string
e-mail	email	email
identifikační číslo	id	string
organizace	organization	string
isRepositoryMember	isRepositoryMember	boolean
primaryCabinet	primaryCabinet	string
sortLookupBy	sortLookupBy	string
externí	external	boolean

Získání informací o úložišti

ID operace:

GetRepositoryInformation

Získání informací o úložišti

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)

Získání nastavení skříně

ID operace:

GetCabinetSettings

Získání nastavení skříně

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skříně	cabinetID	True	string	(Začíná NG-)

Získání nebo vytvoření pracovního prostoru (s jedním atributem)

ID operace:

CreateWorkspaceSingle

Získání nebo vytvoření pracovního prostoru (s jedním atributem)

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skříně	cabinetID	True	string	(Začíná NG-)
Sole Value	parentID	True	string	Jediná hodnota použitá k definování pracovních prostorů v souboru CAB.

Návraty

Name	Cesta	Typ	Description
identifikační číslo	standardAttributes.id	string

Získání nebo vytvoření pracovního prostoru (s nadřazenými a podřízenými atributy)

ID operace:

CreateWorkspaceParentChild

Získání nebo vytvoření pracovního prostoru (s nadřazenými a podřízenými atributy)

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skříně	cabinetID	True	string	(Začíná NG-)
Nadřazená hodnota	parentID	True	string	Nadřazená hodnota použitá k definování pracovních prostorů v souboru CAB.
Podřízená hodnota	childID	True	string	Podřízená hodnota použitá k definování pracovních prostorů v souboru CAB.

Návraty

Name	Cesta	Typ	Description
identifikační číslo	standardAttributes.id	string

Získání obsahu dokumentu

ID operace:

GetDocContent

Načtení dokumentu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	12místné ID dokumentu.
Kódování Base64?	base64		boolean	Kódování Base64?

Získání obsahu kontejneru

ID operace:

GetContainerContents

Získání obsahu vybraného kontejneru

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID kontejneru	containerID	True	string	ID kontejneru
Informace, které se mají vrátit	select	True	string	(Projděte si dokumentaci pro návratový formát.
Počet výsledků, které se mají vrátit (výchozí hodnota je 50)	top		integer	(Maximálně 500 na stránku)
Token použitý pro stránkování výsledků	skiptoken		string	Token použitý pro stránkování výsledků
Order by	orderby		string	(Formát: pole#|desc nebo pole#|asc)

Získání položek složky

ID operace:

GetFldContent

Načtení obsahu složky, včetně dokumentů a podsložek

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID složky	id	True	string	12místné ID složky
Atributy k vrácení	$select		string	Čárkami oddělený seznam hodnot atributů. Další podrobnosti najdete v dokumentaci k rozhraní REST API.

Získání položky podřízené vyhledávací tabulky

ID operace:

GetChildEntry

Získání položky podřízené vyhledávací tabulky

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)
ID podřízeného atributu	childAttributeID	True	string	(Odeberte úvodní 10.
Nadřazený klíč	parentID	True	string	Nadřazený klíč
Podřízený klíč	childID	True	string	Podřízený klíč

Získání položky vyhledávací tabulky nebo hledání podřízených položek tabulky

ID operace:

GetLookupEntry

Získání položky vyhledávací tabulky nebo hledání podřízených položek tabulky

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)
ID atributu	attributeID	True	string	(Odeberte úvodní 10. Pokud chcete vrátit jednu hodnotu, zadejte ID nadřazeného atributu nebo vyhledejte podřízené položky, zadejte ID podřízeného atributu.)
Key	parentID	True	string	(Pokud chcete vrátit jednu hodnotu, zadejte klíč jednoho atributu nebo vyhledejte podřízené položky, zadejte klíč nadřazeného objektu.)
Filtr (pouze při vyhledávání)	$filter		string	(Dostupné filtry najdete v dokumentaci)
Pole, která se mají načíst	$select		string	(Zahrnout čárkami oddělený seznam: "klíč", "description", "parent", "hold", 'closed', 'defaulting', 'type', 'user' and/or 'access')
Počet odpovídajících záznamů, které se mají přeskočit	$skip		integer	(Používá se při načítání více bloků výsledků.)
Maximální počet záznamů, které se mají vrátit	$top		integer	Maximální počet záznamů, které se mají vrátit
Seřazení výsledků podle	$orderby		string	Seřazení výsledků podle

Získání profilu dokumentu

ID operace:

GetDocInfo

Získání informací o dokumentu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	id	True	string	12místné ID dokumentu.

Získání protokolu úložiště

ID operace:

GetRepositoryLog

Získání protokolu úložiště

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)
Počáteční datum a čas	start		string	(Výchozí hodnota je 30 dní; formát rrrr-MM-dd nebo rrrr-MM-ddThh:mm:ssZ)
Koncové datum a čas	end		string	(Stejný formát jako začátek; výchozí hodnota je dnes)
Typ protokolu	Logtype	True	string	Typ protokolu

Získání přístupových práv ke skrytým skupinám cab

ID operace:

GetCabinetDefaultAccess

Získání přístupových práv ke skrytým skupinám cab

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skříně	cabinetID	True	string	(Začíná NG-)

Návraty

Name	Cesta	Typ	Description
		array of object
spravovat	administer	boolean
cabDefault	cabDefault	boolean
úprava	edit	boolean
název	name	string
noAccess	noAccess	boolean
objekt zabezpečení	principal	string
sdílená složka	share	boolean
pohled	view	boolean

Získání seznamu uživatelských skříní

ID operace:

GetUserCabinets

Získání uživatelských skříní

Návraty

Name	Cesta	Typ	Description
		array of object
identifikační číslo	id	string
isCollaborationSpacesEnabled	isCollaborationSpacesEnabled	string
název	name	string
ID úložiště	repositoryId	string
repositoryName	repositoryName	string
wsAttrNum	wsAttrNum	integer
wsOrgAttrNum	wsOrgAttrNum	integer

Získání skupin cab

ID operace:

GetCabinetGroups

Získání všech skupin přidaných do skříně

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skříně	cabinetID	True	string	(Začíná NG-)

Návraty

Name	Cesta	Typ	Description
		array of object
identifikační číslo	Id	string
Název	Name	string
External	External	boolean
Skrytý	Hidden	boolean

Získání skupin úložišť

ID operace:

GetRepositoryGroups

Získání skupin úložišť

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)
Filter	$filter		string	(Podívejte se do dokumentace k kritériím filtru.
Počet výsledků	$top		string	(Výchozí hodnota je 5 000. Maximálně 10 000)
Paging	paging		boolean	(Vrátí výsledky na stránkách; výchozí hodnota je false)
Stránkovací token	$skiptoken		string	(Pro účely stránkování; vráceno předchozími voláními jako "další"))
Návratové informace	returnInfo		string	všechny vrátí názvy skupin. Výchozí hodnota je prázdná pro vrácení jenom ID.

Návraty

Name	Cesta	Typ	Description
		array of string

Získání uživatelů úložiště

ID operace:

GetRepositoryUsers

Získání uživatelů úložiště

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úložiště	repositoryID	True	string	(Začíná certifikační autoritou-)

Návraty

Name	Cesta	Typ	Description
		array of object
zobrazované jméno	displayName	string
e-mail	email	string
externí	external	boolean
identifikační číslo	id	string
lastLogin	lastLogin	string
registrovaný	registered	string

Získání verzí dokumentů

ID operace:

GetDocumentVersions

Získání verzí dokumentů

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	documentID	True	string	12místné ID dokumentu.

Získání vlastních atributů cab

ID operace:

GetCabinetCustomAttributes

Získání vlastních atributů cab

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skříně	cabinetID	True	string	(Začíná NG-)

Návraty

Name	Cesta	Typ	Description
		array of object
items		object

Získání členství ve skupinách

ID operace:

GetGroupMembership

Získání členství ve skupinách

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	groupID	True	string	(Začíná UG-)

Návraty

Name	Cesta	Typ	Description
		array of object
zobrazované jméno	displayName	string
identifikační číslo	id	string

Aktivační události

Prohledávat skříňku

Prohledat zadanou skříňku

Prohledávat skříňku

ID operace:

SearchCab

Prohledat zadanou skříňku

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skříně	cabId	True	string	(Začíná NG-)
Kritéria hledání	q	True	string	Použijte stejný formát a operátory jako ve webovém rozhraní NetDocuments.
Order by	$orderby		string	Order by
Maximální počet výsledků	$top		string	Celé číslo mezi 1 a 500. Výchozí hodnota je 100.
Atributy k vrácení	$select		string	Čárkami oddělený seznam hodnot atributů. Další podrobnosti najdete v dokumentaci k rozhraní REST API.