NetDocuments

NetDocuments är en molntjänst för innehållshantering för företag i alla storlekar för att på ett säkert sätt skapa, lagra, hantera och dela dokumentarbete var som helst, när som helst.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster	Class	Regioner
Copilot Studio	Norm	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Logiska appar	Norm	Alla Logic Apps-regioner utom följande:      – Azure Government-regioner      – Regioner i Azure Kina      - US Department of Defense (DoD)
Power Apps	Norm	Alla Power Apps-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Power Automate	Norm	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)

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

Metadata för anslutningsprogram
Utgivare	NetDocuments Software, Inc.
Webbplats	https://www.netdocuments.com/
Sekretesspolicy	https://www.netdocuments.com/privacy-policy/

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:

Standardinställning	Parametrar för att skapa anslutning.	Alla regioner	Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn	Typ	Description	Krävs
Region	snöre	Region som ditt nettodokument finns i.	Sann

Begränsningsgränser

Name	Anrop	Förnyelseperiod
API-anrop per anslutning	100	60 sekunder

Åtgärder

Byt namn på dokument	Byt namn på ett dokument
Byt namn på mapp	Byt namn på en mapp
Checka in dokument	Checka in ett utcheckat dokument
Checka ut dokument	Kolla in ett dokument
Dokumenthistorik	Hämta en lista över åtgärder som vidtagits i ett dokument
Fil- eller avfila dokument till mapp	Fila ett objekt i en mapp eller avfilera ett objekt från en mapp.
Följ dokument	Ta emot aviseringar när dokumentet uppdateras
Följ mapp	Ta emot aviseringar när nytt innehåll läggs till i en mapp
Hämta aktuell användarinformation	Hämta information om aktuell användare, ID krävs inte
Hämta anpassade attribut för kabinett	Hämta anpassade attribut för kabinett
Hämta användarinformation	Hämta information om en användare
Hämta containerinnehåll	Hämta innehållet i den valda containern
Hämta dokumentinnehåll	Hämta ett dokument
Hämta dokumentprofil	Hämta information om ett dokument
Hämta dokumentversioner	Hämta dokumentversioner
Hämta eller skapa en arbetsyta (med ett enda attribut)	Hämta eller skapa en arbetsyta (med ett enda attribut)
Hämta eller skapa en arbetsyta (med överordnade och underordnade attribut)	Hämta eller skapa en arbetsyta (med överordnade och underordnade attribut)
Hämta en underordnad uppslagstabellpost	Hämta en underordnad uppslagstabellpost
Hämta en uppslagstabellpost eller sök efter underordnade tabellposter	Hämta en uppslagstabellpost eller sök efter underordnade tabellposter
Hämta gruppinformation	Hämta gruppinformation
Hämta gruppmedlemskap	Hämta gruppmedlemskap
Hämta information om arbetsytan	Hämta information om arbetsytan
Hämta information om lagringsplats	Hämta information om lagringsplats
Hämta information om skåpet	Hämta information om skåpet
Hämta kabinettgrupper	Hämta alla grupper som lagts till i ett kabinett
Hämta lagringsplatsanvändare	Hämta lagringsplatsanvändare
Hämta lagringsplatsgrupper	Hämta lagringsplatsgrupper
Hämta lagringsplatslogg	Hämta lagringsplatslogg
Hämta lista över användarskåp	Hämta användarskåp
Hämta mappobjekt	Hämta innehållet i en mapp, inklusive dokument och undermappar
Hämta skåpinställningar	Hämta skåpinställningar
Hämta åtkomsträttigheter för ohämrade kabinettgrupper	Hämta åtkomsträttigheter för ohämrade kabinettgrupper
Lägg till i eller ta bort grupp från kabinettet	Lägg till grupp i kabinettet och standardbehörigheter för åtkomst
Lägga till eller ta bort användare från lagringsplatsen	Lägga till eller ta bort användare från lagringsplatsen
Lägga till eller ta bort gruppmedlem	Lägga till eller ta bort gruppmedlem
Lås dokument	Lås dokument
Lås dokumentversion	Lås dokumentversion
Låsa upp dokument	Ta bort dokument
Skapa användare	Skapa en användare på en lagringsplats
Skapa collabspace	Skapa ett nytt collabspace
Skapa dokument	Skapa ett nytt dokument
Skapa eller uppdatera en post i uppslagstabellen	Skapa eller uppdatera en post i uppslagstabellen
Skapa eller uppdatera en underordnad uppslagstabellpost	Skapa eller uppdatera en underordnad uppslagstabellpost
Skapa en extern kabinettgrupp	Skapa en extern kabinettgrupp
Skapa en ny version av ett dokument	Skapa en ny version av ett dokument
Skapa lagringsplatsgrupp	Skapa en lagringsplatsgrupp
Skapa mapp	Skapa en ny mapp
Skapa skyddad länk	Generera en länk till ett dokument som kan nås av vem som helst
Sök efter uppslagstabellposter	Sök efter uppslagstabellposter
Sök i ett eller flera skåp	Sök i ett eller flera skåp
Söka i ett kabinett och ändra ACL:er	Söka i ett kabinett och ändra ACL:er
Ta bort dokument	Ta bort ett dokument
Ta bort en post i uppslagstabellen	Ta bort en post i uppslagstabellen
Ta bort en underordnad uppslagstabellpost	Ta bort en underordnad uppslagstabellpost
Ta bort lagringsplatsgrupp	Ta bort en lagringsplatsgrupp
Ta bort mapp	Ta bort en mapp
Uppdatera dokument	Uppdatera innehållet i ett dokument
Uppdatera en arbetsyta	Uppdatera en arbetsyta

Byt namn på dokument

Åtgärds-ID:

RenameDocument

Byt namn på ett dokument

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	12-siffrigt dokument-ID.
Nytt namn	name	True	string

Byt namn på mapp

Åtgärds-ID:

RenameFolder

Byt namn på en mapp

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Mapp-ID	id	True	string	12-siffrigt mapp-ID.
Nytt namn	name	True	string

Checka in dokument

Åtgärds-ID:

CheckinDoc

Checka in ett utcheckat dokument

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	12-siffrigt dokument-ID.
Dokumenttillägg	extension		string	Inkludera inte den inledande perioden.
Dokumentinnehåll	file		file	Dokumentet i formulär med flera delar.
Lägg till i senaste	addToRecent		boolean	Lägg till i användarens senaste dokumentlista.

Checka ut dokument

Åtgärds-ID:

CheckOutDoc

Kolla in ett dokument

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	12-siffrigt dokument-ID.
Comment	comment		string	Comment
Ladda ned dokument	download		boolean	Returnerar dokumentinnehållet.
Version att ladda ned	version		string	Anger vilken version av innehållet som ska laddas ned. Standardvärdet är den officiella versionen.
Lägg till i senaste	addToRecent		boolean	Lägg till i senaste

Dokumenthistorik

Åtgärds-ID:

GetDocHistory

Hämta en lista över åtgärder som vidtagits i ett dokument

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	12-siffrigt dokument-ID.

Fil- eller avfila dokument till mapp

Åtgärds-ID:

FileFolder

Fila ett objekt i en mapp eller avfilera ett objekt från en mapp.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Mapp-ID	id	True	string	12-siffrigt mapp-ID.
Dokument-ID	item	True	string	12-siffrigt dokument-ID.
Fil eller avfil	action	True	string	Fil eller avfil

Följ dokument

Åtgärds-ID:

FollowDocument

Ta emot aviseringar när dokumentet uppdateras

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	12-siffrigt dokument-ID.
Mottagare	recipients	True	string	En eller flera giltiga e-postadresser avgränsade med semikolon. Dubbletter ignoreras.
Sända	send		string	Vilken kategori av användare som ska få aviseringen.

Följ mapp

Åtgärds-ID:

FollowFolder

Ta emot aviseringar när nytt innehåll läggs till i en mapp

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Mapp-ID	id	True	string	12-siffrigt mapp-ID.
Mottagare	recipients	True	string	En eller flera giltiga e-postadresser avgränsade med semikolon. Dubbletter ignoreras.
Sända	send		string	Vilken kategori av användare som ska få aviseringen.

Hämta aktuell användarinformation

Åtgärds-ID:

GetCurrentUserInfo

Hämta information om aktuell användare, ID krävs inte

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kabinett-ID	cabGuid		string	(Det börjar med NG-)

Returer

Name	Sökväg	Typ	Description
visningsnamn	displayName	string
Mejladress	email	email
Id-nummer	id	string
organisation	organization	string
isRepositoryMember	isRepositoryMember	boolean
primaryCabinet	primaryCabinet	string
sortLookupBy	sortLookupBy	string
extern	external	boolean

Hämta anpassade attribut för kabinett

Åtgärds-ID:

GetCabinetCustomAttributes

Hämta anpassade attribut för kabinett

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kabinett-ID	cabinetID	True	string	(Det börjar med NG-)

Returer

Name	Sökväg	Typ	Description
		array of object
items		object

Hämta användarinformation

Åtgärds-ID:

GetUserInfo

Hämta information om en användare

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Användar-ID	id	True	string	Användar-ID som tilldelats av NetDocuments.
Kabinett-ID	cabGuid		string	(Det börjar med NG-)

Returer

Name	Sökväg	Typ	Description
visningsnamn	displayName	string
Mejladress	email	email
Id-nummer	id	string
organisation	organization	string
isRepositoryMember	isRepositoryMember	boolean
primaryCabinet	primaryCabinet	string
sortLookupBy	sortLookupBy	string
extern	external	boolean

Hämta containerinnehåll

Åtgärds-ID:

GetContainerContents

Hämta innehållet i den valda containern

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Container-ID	containerID	True	string	Container-ID
Information som ska returneras	select	True	string	(Granska dokumentationen för returformatet)
Antal resultat som ska returneras (standardvärdet är 50)	top		integer	(Högst 500 per sida)
Token som används för sidnumrering av resultat	skiptoken		string	Token som används för sidnumrering av resultat
Sortera efter	orderby		string	(Format: field#|desc eller field#|asc)

Hämta dokumentinnehåll

Åtgärds-ID:

GetDocContent

Hämta ett dokument

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	12-siffrigt dokument-ID.
Base64-kodad?	base64		boolean	Base64-kodad?

Hämta dokumentprofil

Åtgärds-ID:

GetDocInfo

Hämta information om ett dokument

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	12-siffrigt dokument-ID.

Hämta dokumentversioner

Åtgärds-ID:

GetDocumentVersions

Hämta dokumentversioner

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	documentID	True	string	12-siffrigt dokument-ID.

Hämta eller skapa en arbetsyta (med ett enda attribut)

Åtgärds-ID:

CreateWorkspaceSingle

Hämta eller skapa en arbetsyta (med ett enda attribut)

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kabinett-ID	cabinetID	True	string	(Det börjar med NG-)
Enda värde	parentID	True	string	Det enda värde som används för att definiera arbetsytor i skåpet.

Returer

Name	Sökväg	Typ	Description
Id-nummer	standardAttributes.id	string

Hämta eller skapa en arbetsyta (med överordnade och underordnade attribut)

Åtgärds-ID:

CreateWorkspaceParentChild

Hämta eller skapa en arbetsyta (med överordnade och underordnade attribut)

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kabinett-ID	cabinetID	True	string	(Det börjar med NG-)
Överordnat värde	parentID	True	string	Det överordnade värdet som används för att definiera arbetsytor i kabinettet.
Underordnat värde	childID	True	string	Det underordnade värde som används för att definiera arbetsytor i skåpet.

Returer

Name	Sökväg	Typ	Description
Id-nummer	standardAttributes.id	string

Hämta en underordnad uppslagstabellpost

Åtgärds-ID:

GetChildEntry

Hämta en underordnad uppslagstabellpost

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Det börjar med CA-)
Underordnat attribut-ID	childAttributeID	True	string	(Ta bort inledande "10")
Överordnad nyckel	parentID	True	string	Överordnad nyckel
Underordnad nyckel	childID	True	string	Underordnad nyckel

Hämta en uppslagstabellpost eller sök efter underordnade tabellposter

Åtgärds-ID:

GetLookupEntry

Hämta en uppslagstabellpost eller sök efter underordnade tabellposter

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Det börjar med CA-)
Attribut-ID	attributeID	True	string	(Ta bort inledande '10'. Om du vill returnera ett enda värde anger du det överordnade attribut-ID:t eller om du vill söka efter underordnade poster anger du det underordnade attribut-ID:t.)
Key	parentID	True	string	(Om du vill returnera ett enda värde anger du nyckeln för det enskilda attributet eller om du vill söka efter underordnade poster anger du den överordnade nyckeln.)
Filter (endast vid sökning)	$filter		string	(Se dokumentationen för tillgängliga filter)
Fält att hämta	$select		string	(Inkludera kommaavgränsad lista över: "nyckel", "beskrivning", "överordnad", "hold", "closed", "defaulting", "type", "user" och/eller "access")
Antal matchande poster att hoppa över	$skip		integer	(Detta används när du hämtar flera resultatblock.)
Maximalt antal poster som ska returneras	$top		integer	Maximalt antal poster som ska returneras
Orderresultat efter	$orderby		string	Orderresultat efter

Hämta gruppinformation

Åtgärds-ID:

GetGroupInformation

Hämta gruppinformation

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
grupp-id	groupID	True	string	Grupp-ID (börjar med UG-).
Medlemskap i gruppkabinett	cabMembership		boolean	(Om värdet är "sant" är kabinetten som dessa grupper är medlem i och standardbehörigheten för dokumentåtkomst för varje kabinett inkluderas.)

Returer

Name	Sökväg	Typ	Description
extern	external	boolean
hidden	hidden	boolean
hideMembership	hideMembership	boolean
Id-nummer	id	string
name	name	string
cabMembership	cabMembership	array of object
Id-nummer	cabMembership.id	string
name	cabMembership.name	string
rättigheter	cabMembership.rights	string

Hämta gruppmedlemskap

Åtgärds-ID:

GetGroupMembership

Hämta gruppmedlemskap

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
grupp-id	groupID	True	string	(Börjar med UG-)

Returer

Name	Sökväg	Typ	Description
		array of object
visningsnamn	displayName	string
Id-nummer	id	string

Hämta information om arbetsytan

Åtgärds-ID:

GetWorkspaceInformation

Hämta information om arbetsytan

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arbetsplats-ID	workspaceID	True	string	Arbetsplats-ID

Hämta information om lagringsplats

Åtgärds-ID:

GetRepositoryInformation

Hämta information om lagringsplats

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Börjar med CA-)

Hämta information om skåpet

Åtgärds-ID:

GetCabinetInformation

Hämta information om skåpet

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kabinett-ID	cabinetID	True	string	(Det börjar med NG-)

Hämta kabinettgrupper

Åtgärds-ID:

GetCabinetGroups

Hämta alla grupper som lagts till i ett kabinett

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kabinett-ID	cabinetID	True	string	(Det börjar med NG-)

Returer

Name	Sökväg	Typ	Description
		array of object
Id	Id	string
Namn	Name	string
External	External	boolean
Dold	Hidden	boolean

Hämta lagringsplatsanvändare

Åtgärds-ID:

GetRepositoryUsers

Hämta lagringsplatsanvändare

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Börjar med CA-)

Returer

Name	Sökväg	Typ	Description
		array of object
visningsnamn	displayName	string
Mejladress	email	string
extern	external	boolean
Id-nummer	id	string
lastLogin	lastLogin	string
registrerat	registered	string

Hämta lagringsplatsgrupper

Åtgärds-ID:

GetRepositoryGroups

Hämta lagringsplatsgrupper

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Det börjar med CA-)
Filter	$filter		string	(Se dokumentationen för filtervillkor)
Antal resultat	$top		string	(Standardvärdet är 5 000. Maximalt 10 000)
Paging	paging		boolean	(Returnera resultatet i sidor, standardvärdet är falskt)
Växlingstoken	$skiptoken		string	(I växlingssyfte returneras av tidigare anrop som "nästa")
Returnera information	returnInfo		string	alla returnerar gruppnamn. Standardvärdet är tomt om du bara vill returnera ID:t

Returer

Name	Sökväg	Typ	Description
		array of string

Hämta lagringsplatslogg

Åtgärds-ID:

GetRepositoryLog

Hämta lagringsplatslogg

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Börjar med CA-)
Startdatum/tid	start		string	(Standardvärdet är 30 dagar; formatera åååå-MM-dd eller åååå-MM-ddThh:mm:ssZ)
Slutdatum/tid	end		string	(Samma format som start, standardvärdet är idag)
Loggtyp	Logtype	True	string	Loggtyp

Hämta lista över användarskåp

Åtgärds-ID:

GetUserCabinets

Hämta användarskåp

Returer

Name	Sökväg	Typ	Description
		array of object
Id-nummer	id	string
isCollaborationSpacesEnabled	isCollaborationSpacesEnabled	string
name	name	string
repositoryId	repositoryId	string
repositoryName (på engelska)	repositoryName	string
wsAttrNum	wsAttrNum	integer
wsOrgAttrNum	wsOrgAttrNum	integer

Hämta mappobjekt

Åtgärds-ID:

GetFldContent

Hämta innehållet i en mapp, inklusive dokument och undermappar

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Mapp-ID	id	True	string	12-siffrigt mapp-ID.
Attribut som ska returneras	$select		string	En kommaavgränsad lista med attributvärden. Mer information finns i REST API-dokumentationen.

Hämta skåpinställningar

Åtgärds-ID:

GetCabinetSettings

Hämta skåpinställningar

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kabinett-ID	cabinetID	True	string	(Det börjar med NG-)

Hämta åtkomsträttigheter för ohämrade kabinettgrupper

Åtgärds-ID:

GetCabinetDefaultAccess

Hämta åtkomsträttigheter för ohämrade kabinettgrupper

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kabinett-ID	cabinetID	True	string	(Det börjar med NG-)

Returer

Name	Sökväg	Typ	Description
		array of object
administrera	administer	boolean
cabDefault	cabDefault	boolean
edit	edit	boolean
name	name	string
noAccess	noAccess	boolean
rektor	principal	string
aktie	share	boolean
view	view	boolean

Lägg till i eller ta bort grupp från kabinettet

Åtgärds-ID:

AddToOrRemoveGroupFromCabinet

Lägg till grupp i kabinettet och standardbehörigheter för åtkomst

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kabinett-ID	cabinetID	True	string	(Det börjar med NG-)
Lägg till eller ta bort grupp	action	True	string	Lägg till eller ta bort grupp
grupp-id	id	True	string	Grupp-ID (börjar med UG-).
Visa rättigheter	view	True	boolean	Visa rättigheter (V) – Endast för tillägg.
Redigera rättigheter	edit	True	boolean	Redigera rättigheter (E) – Endast för tillägg.
Dela rättigheter	share	True	boolean	Dela rättigheter (S) – Endast för tillägg.
Administrera rättigheter	administer	True	boolean	Administrera rättigheter (A) – Endast för tillägg.
Inga åtkomsträttigheter	noAccess	True	boolean	Inga åtkomsträttigheter (N) – Endast för tillägg.

Lägga till eller ta bort användare från lagringsplatsen

Åtgärds-ID:

AddOrRemoveUserRepository

Lägga till eller ta bort användare från lagringsplatsen

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Börjar med CA-)
Lägga till eller ta bort användare	action	True	string	Lägga till eller ta bort användare
Användar-ID	member	True	string	Användar-ID
Användaren är extern	external	True	boolean	Användaren är extern
Ta bort användare (om den är federerad)	deleteIfFederated		boolean	(Gäller endast vid borttagning)

Lägga till eller ta bort gruppmedlem

Åtgärds-ID:

AddOrRemoveGroupMember

Lägga till eller ta bort gruppmedlem

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
grupp-id	groupID	True	string	(Börjar med UG-)
Lägga till eller ta bort användaren	action	True	string	Lägga till eller ta bort användaren
Användar-ID	member	True	string	(Måste redan vara medlem i lagringsplatsen.)

Lås dokument

Åtgärds-ID:

LockDocument

Lås dokument

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	Dokument-ID
Comment	comment		string	Comment

Lås dokumentversion

Åtgärds-ID:

LockDocumentVersion

Lås dokumentversion

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	12-siffrigt dokument-ID.
Dokumentversion	version	True	integer	Dokumentversion
Versionsbeskrivning	description		string	Versionsbeskrivning

Låsa upp dokument

Åtgärds-ID:

UnockDocument

Ta bort dokument

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	Dokument-ID

Skapa användare

Åtgärds-ID:

CreateUser

Skapa en användare på en lagringsplats

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Användarnamn	username	True	email	(Samma som användarens e-postadress)
Förnamn	displayFirstName	True	string	Förnamn
Mellannamn	displayMiddleName		string	Mellannamn
Efternamn	displayLastName	True	string	Efternamn
E-postadress	email	True	email	E-postadress
Användaren är extern	external	True	boolean	(Gäller endast vid tillägg)
Skicka välkomstmeddelande via e-post	sendWelcome	True	boolean	Skicka välkomstmeddelande via e-post
Databas-ID	repository	True	string	(Börjar med CA-)

Returer

Name	Sökväg	Typ	Description
visningsnamn	displayName	string
Mejladress	email	email
Id-nummer	id	string
extern	external	boolean

Skapa collabspace

Åtgärds-ID:

CreateCollabSpace

Skapa ett nytt collabspace

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arbetsplats-ID	workspaceID	True	string	Arbetsplats-ID
CollabSpace-namn	name	True	string	CollabSpace-namn
Description	description		string	Description

Returer

Name	Sökväg	Typ	Description
Id	Id	string
EnvUrl	EnvUrl	string

Skapa dokument

Åtgärds-ID:

CreateDocument

Skapa ett nytt dokument

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Resmål	destination	True	string	12-siffrigt ID eller EnvID för mappen, filtret eller arbetsytan.
Dokumentinnehåll	file	True	file	Placera filnamnet plus tillägget i det medföljande filnamnsfältet.
Lägg till i senaste	addToRecent		boolean	Lägg till i senaste
Dokumentprofil	profile		string	Ange dokumentprofilen (JSON-format)

Returer

Name	Sökväg	Typ	Description
Id-nummer	id	string
utbyggnad	extension	string
name	name	string

Skapa eller uppdatera en post i uppslagstabellen

Åtgärds-ID:

CreateEntry

Skapa eller uppdatera en post i uppslagstabellen

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Det börjar med CA-)
Attribut-ID	attributeID	True	string	(Ta bort inledande "10")
Key	parentID	True	string	Key
Description	description		string
Typ	defaulting		string
Bevarande av rättstvister	hold		boolean
Stängt datum	closed		string	Format '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/'
Filtrerade behörigheter	filtered_permissions	True	boolean
Framtvinga permssions	force_permissions	True	boolean
View	view	True	boolean
Edit	edit	True	boolean
Dela	share	True	boolean
Administrera	administer	True	boolean
Ingen åtkomst	noAccess	True	boolean
Standard för kabinett	cabDefault	True	boolean
Rektor	principal	True	string	(Användar- eller grupp-ID)

Returer

Name	Sökväg	Typ	Description
count	count	integer

Skapa eller uppdatera en underordnad uppslagstabellpost

Åtgärds-ID:

CreateChildEntry

Skapa eller uppdatera en underordnad uppslagstabellpost

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Det börjar med CA-)
Underordnat attribut-ID	childAttributeID	True	string	(Ta bort inledande "10")
Överordnad nyckel	parentID	True	string	Överordnad nyckel
Underordnad nyckel	childID	True	string	Underordnad nyckel
Description	description		string
Typ	defaulting		string
Bevarande av rättstvister	hold		boolean
Stängt datum	closed		string	Format '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/'
Filtrerade behörigheter	filtered_permissions	True	boolean
Framtvinga permssions	force_permissions	True	boolean
View	view	True	boolean
Edit	edit	True	boolean
Dela	share	True	boolean
Administrera	administer	True	boolean
Ingen åtkomst	noAccess	True	boolean
Standard för kabinett	cabDefault	True	boolean
Rektor	principal	True	string	(Användar- eller grupp-ID)

Returer

Name	Sökväg	Typ	Description
count	count	integer

Skapa en extern kabinettgrupp

Åtgärds-ID:

CreateCabinetExternalGroup

Skapa en extern kabinettgrupp

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kabinett-ID	cabinetID	True	string	(Det börjar med NG-)
Gruppnamn	name	True	string	Gruppnamn
Gruppalternativ	options		string	Gruppalternativ
Standardåtkomst för kabinett	access		string	Standardåtkomst för kabinett
CollabSpace-ID	collaborationSpaceId		string	(För att göra detta till en kollabspace-extern grupp)
Åtkomst till CollabSpace	collaborationspaceaccess		string	Åtkomst till CollabSpace
Attributvärde för den översta arbetsytan	topwsattributegroupkey		string	(För vanliga externa kabinettgrupper, för att associera gruppen med ett specifikt attributvärde för den översta arbetsytan)

Returer

Name	Sökväg	Typ	Description
Typ	Type	integer
Id	Id	string
Namn	Name	string
Options	Options	string
Åtkomst	Access	string

Skapa en ny version av ett dokument

Åtgärds-ID:

NewVersion

Skapa en ny version av ett dokument

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	12-siffrigt dokument-ID.
Dokumenttillägg	extension		string	Inkludera inte den inledande perioden.
Versionsbeskrivning	version_description		string	Versionsbeskrivning
Namnet på den nya versionen	verName		string	Namnet på den nya versionen
Gör officiell version	official		boolean	Den nya versionen är inte den officiella versionen om den här parametern inte har angetts.
Lägg till i de senaste dokumenten	addToRecent		boolean	Lägg till i de senaste dokumenten
Källversionsnummer	srcVer		string	Om du kopierar innehållet från en tidigare version, vilken version av dokumentet som ska kopieras.
Skapa som en subversion	allocatesubversion		boolean	Skapa som en subversion i stället för som en fullständig version.
Dokumentinnehåll för ny version	body		binary	Innehållet i den nya versionen, om du inte kopierar en annan version eller den officiella versionen.

Returer

Name	Sökväg	Typ	Description
latestVersionNumber	latestVersionNumber	integer
newVer	newVer	integer
newVersionLabel	newVersionLabel	string
officialVer	officialVer	integer
officialVerName	officialVerName	string
versions	versions	integer

Skapa lagringsplatsgrupp

Åtgärds-ID:

CreateRepositoryGroup

Skapa en lagringsplatsgrupp

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Det börjar med CA-)
Gruppnamn	name	True	string	Gruppnamn
External	external	True	boolean	External
Dölj i listor	hidden	True	boolean	Dölj i listor
Dolt medlemskap	hideMembership	True	boolean	Dolt medlemskap

Returer

Name	Sökväg	Typ	Description
extern	external	boolean
hidden	hidden	boolean
hideMembership	hideMembership	boolean
Id-nummer	id	string
name	name	string

Skapa mapp

Åtgärds-ID:

CreateFolder

Skapa en ny mapp

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Mappnamn	name	True	string	Mappnamn.
Överordnat ID	parent		string	12-siffrigt ID eller EnvID för den nya mappens överordnade container.
Kabinett-ID	cabinet		string	(Det börjar med NG-) Kan utelämnas om en mapp eller ett arbetsyte-ID anges i det överordnade objektet.

Returer

Name	Sökväg	Typ	Description
Id-nummer	standardAttributes.id	string
name	standardAttributes.name	string

Skapa skyddad länk

Åtgärds-ID:

CreateSecuredLink

Generera en länk till ett dokument som kan nås av vem som helst

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	12-siffrigt dokument-ID.
Lösenord för den skyddade länken	password		string	Beroende på kabinettkonfigurationen kan lösenordet vara valfritt eller obligatoriskt.
Förfallodatum för skyddad länk.	expirationdate		string	Indataformat: åå-MM-dd.
Version av dokumentet	version		string	Vilken version av dokumentet som ska delas. Om den är tom delas den officiella versionen.
Ladda ned dokument	download		boolean	Om det är sant kan dokumentet laddas ned av mottagaren.
Meddela mig	notifyme		boolean	Om sant meddelar du avsändaren när den skyddade länken nås.
Lås dokument	lock		boolean	Du kan också låsa den valda versionen av dokumentet. Detta kräver redigeringsrättigheter.

Returer

Name	Sökväg	Typ	Description
view	standardAttributes.view	string
ladda ner	standardAttributes.download	string

Sök efter uppslagstabellposter

Åtgärds-ID:

SearchLookupEntries

Sök efter uppslagstabellposter

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Det börjar med CA-)
Attribut-ID	attributeID	True	string	(Ta bort inledande "10")
Filter	$filter		string	(Se dokumentationen för tillgängliga filter)
Fält att hämta	$select		string	(Inkludera kommaavgränsad lista över: "nyckel", "beskrivning", "överordnad", "hold", "closed", "defaulting", "type", "user" och/eller "access")
Antal matchande poster att hoppa över	$skip		integer	(Detta används när du hämtar flera resultatblock.)
Maximalt antal poster som ska returneras	$top		integer	Maximalt antal poster som ska returneras

Returer

Name	Sökväg	Typ	Description
rader	rows	array of object
Försumliga	rows.defaulting	string
beskrivning	rows.description	string
hålla	rows.hold	boolean
key	rows.key	string
stängd	rows.closed	string
tillträde	rows.access	string

Sök i ett eller flera skåp

Åtgärds-ID:

SearchCabinets

Sök i ett eller flera skåp

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Skåp	cabinets	True	string	(kommaavgränsad)
Query	q	True	string	(Granska dokumentationen för frågeformatet)
Information som ska returneras	select	True	string	(Granska dokumentationen för returformatet)
Sortera efter	orderby		string	(Format: field#|desc eller field#|asc)
Antal resultat som ska returneras (standardvärdet är 50)	top		integer	(Högst 500 per sida)
Antal resultat att hoppa över	skip		integer	Antal resultat att hoppa över
Token som används för sidnumrering av resultat	skiptoken		string	Token som används för sidnumrering av resultat

Söka i ett kabinett och ändra ACL:er

Åtgärds-ID:

SearchCabinetModifyACLs

Söka i ett kabinett och ändra ACL:er

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kabinett-ID	cabinetID	True	string	(Det börjar med NG-)
Query	q	True	string	(Granska dokumentationen för frågeformatet)
Ändra ACL-läge	mode	True	string	Ändra ACL-läge
Ny ACL	newAcl	True	string	(Granska dokumentationen för rätt json-format)
E-postadress	email		email	(Skicka meddelande till den här adressen i stället)
Skicka e-postmeddelanden om slutförande	completionEmail		string	(true = send always (standard), false = don't send, fail = send only on fail)

Ta bort dokument

Åtgärds-ID:

DeleteDoc

Ta bort ett dokument

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	12-siffrigt dokument-ID.
Ta bort permanent	permanent		boolean	Anger att dokumentet ska tas bort permanent i stället för att flyttas till Borttagna objekt.

Ta bort en post i uppslagstabellen

Åtgärds-ID:

DeleteLookupEntry

Ta bort en post i uppslagstabellen

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Det börjar med CA-)
Attribut-ID	attributeID	True	string	(Ta bort inledande "10")
Key	parentID	True	string	Key

Returer

Name	Sökväg	Typ	Description
count	count	integer

Ta bort en underordnad uppslagstabellpost

Åtgärds-ID:

DeleteChildEntry

Ta bort en underordnad uppslagstabellpost

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Det börjar med CA-)
Underordnat attribut-ID	childAttributeID	True	string	(Ta bort inledande "10")
Överordnad nyckel	parentID	True	string	Överordnad nyckel
Underordnad nyckel	childID	True	string	Underordnad nyckel

Returer

Name	Sökväg	Typ	Description
count	count	integer

Ta bort lagringsplatsgrupp

Åtgärds-ID:

DeleteRepositoryGroup

Ta bort en lagringsplatsgrupp

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Databas-ID	repositoryID	True	string	(Det börjar med CA-)
grupp-id	groupID	True	string	(Börjar med UG-)

Ta bort mapp

Åtgärds-ID:

DeleteFolder

Ta bort en mapp

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Mapp-ID	id	True	string	12-siffrigt mapp-ID.
Ta bort permanent	permanent		boolean	Anger att mappen ska tas bort permanent i stället för att flyttas till Borttagna objekt. Innehållet i mappen, inklusive underordnade undermappar, tas inte bort permanent.
Ta bort mappinnehåll	deleteContents		boolean	Anger att dokumenten i den borttagna mappen (och i alla underordnade undermappar) också ska tas bort, i stället för att bara vara ofiltrerade.

Uppdatera dokument

Åtgärds-ID:

UpdateDocument

Uppdatera innehållet i ett dokument

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dokument-ID	id	True	string	12-siffrigt dokument-ID.
Dokumenttillägg	extension		string	Endast nödvändigt om du ändrar dokumentets tillägg. Inkludera inte den inledande perioden.
Base64-kodad?	base64		boolean	Base64-kodad?
Dokumentinnehållet har uppdaterats	body	True	byte	Innehållet i dokumentet.

Uppdatera en arbetsyta

Åtgärds-ID:

RefreshWorkspace

Uppdatera en arbetsyta

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Arbetsplats-ID	workspaceID	True	string	Arbetsplats-ID

Utlösare

Sökskåp

Sök i det angivna kabinettet

Sökskåp

Åtgärds-ID:

SearchCab

Sök i det angivna kabinettet

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kabinett-ID	cabId	True	string	(Det börjar med NG-)
Sökvillkor	q	True	string	Använd samma format och operatorer som i NetDocuments-webbgränssnittet.
Sortera efter	$orderby		string	Sortera efter
Maximalt antal resultat	$top		string	Ett heltal mellan 1 och 500. Standardvärdet är 100.
Attribut som ska returneras	$select		string	En kommaavgränsad lista med attributvärden. Mer information finns i REST API-dokumentationen.