Partilhar via

NetDocuments

  • Reference

NetDocuments is a cloud content management service for businesses of all sizes to securely create, store, manage and share their document work anywhere, anytime.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
URL https://support.netdocuments.com/hc/en-us
Connector Metadata
Publisher NetDocuments Software, Inc.
Website https://www.netdocuments.com/
Privacy policy https://www.netdocuments.com/privacy-policy/

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Region string Region your net document resides within. True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add or remove group member

Add or remove group member
Add to or remove group from cabinet

Add group to cabinet and default access rights
Add user to or remove user from repository

Add user to or remove user from repository
Check in document

Check in a checked-out document
Check out document

Check out a document
Create a cabinet external group

Create a cabinet external group
Create a new version of a document

Create new version of a document
Create CollabSpace

Create a new CollabSpace
Create document

Create a new document
Create folder

Create a new folder
Create or update a child lookup table entry

Create or update a child lookup table entry
Create or update a lookup table entry

Create or update a lookup table entry
Create repository group

Create a repository group
Create secured link

Generate a link to a document that can be accessed by anyone
Create user

Create a user in a repository
Delete a child lookup table entry

Delete a child lookup table entry
Delete a lookup table entry

Delete a lookup table entry
Delete document

Delete a document
Delete folder

Delete a folder
Delete repository group

Delete a repository group
Document history

Retrieve a list of actions taken on a document
File or unfile document to folder

File an item in a folder or unfile an item from a folder.
Follow document

Receive alerts when the document is updated
Follow folder

Receive alerts when new content is added to a folder
Get a child lookup table entry

Get a child lookup table entry
Get a lookup table entry or search for child table entries

Get a lookup table entry or search for child table entries
Get cabinet custom attributes

Get cabinet custom attributes
Get cabinet groups

Get all of the groups added to a cabinet
Get cabinet information

Get cabinet information
Get cabinet settings

Get cabinet settings
Get container contents

Get the contents of the selected container
Get current user info

Get info about current user, ID isn't required
Get document content

Retrieve a document
Get document profile

Get information about a document
Get document versions

Get document versions
Get folder items

Retrieve the contents of a folder, including documents and subfolders
Get group information

Get group information
Get group membership

Get group membership
Get list of user cabinets

Get User cabinets
Get or create a workspace (with a single attribute)

Get or create a workspace (with a single attribute)
Get or create a workspace (with parent and child attributes)

Get or create a workspace (with parent and child attributes)
Get repository groups

Get repository groups
Get repository information

Get repository information
Get repository log

Get repository log
Get repository users

Get repository users
Get unhidden cabinet groups access rights

Get unhidden cabinet groups access rights
Get user info

Get information about a user
Get workspace information

Get workspace information
Lock document

Lock document
Lock document version

Lock document version
Refresh a workspace

Refresh a workspace
Rename document

Rename a document
Rename folder

Rename a folder
Search a cabinet and modify ACLs

Search a cabinet and modify ACLs
Search for lookup table entries

Search for lookup table entries
Search one or more cabinets

Search one or more cabinets
Unlock document

Unock document
Update document

Update the content of a document

Add or remove group member

Operation ID:
AddOrRemoveGroupMember

Add or remove group member

Parameters

Name Key Required Type Description
Group ID
 groupID True string

(Starts with UG-)
Add or remove the user
 action True string

Add or remove the user
User ID
 member True string

(Must be a member of the repository already.)

Add to or remove group from cabinet

Operation ID:
AddToOrRemoveGroupFromCabinet

Add group to cabinet and default access rights

Parameters

Name Key Required Type Description
Cabinet ID
 cabinetID True string

(It starts with NG-)
Add or remove group
 action True string

Add or remove group
Group ID
 id True string

Group ID (starts with UG-).
View rights
 view True boolean

View rights (V) - Only for add.
Edit rights
 edit True boolean

Edit rights (E) - Only for add.
Share rights
 share True boolean

Share rights (S) - Only for add.
Administer rights
 administer True boolean

Administer rights (A) - Only for add.
No access rights
 noAccess True boolean

No access rights (N) - Only for add.

Add user to or remove user from repository

Operation ID:
AddOrRemoveUserRepository

Add user to or remove user from repository

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(Starts with CA-)
Add or remove user
 action True string

Add or remove user
User ID
 member True string

User ID
User is external
 external True boolean

User is external
Delete user (if federated)
 deleteIfFederated boolean

(Only applicable on remove)

Check in document

Operation ID:
CheckinDoc

Check in a checked-out document

Parameters

Name Key Required Type Description
Document ID
 id True string

12-digit document ID.
Document extension
 extension string

Do not include the leading period.
Document Content
 file file

The document in multi-part form.
Add to recent
 addToRecent boolean

Add to the user's recent documents list.

Check out document

Operation ID:
CheckOutDoc

Check out a document

Parameters

Name Key Required Type Description
Document ID
 id True string

12-digit document ID.
Comment
 comment string

Comment
Download document
 download boolean

Returns the document content.
Version to download
 version string

Specifies which version’s content should be downloaded. Defaults to the official version.
Add to recent
 addToRecent boolean

Add to recent

Create a cabinet external group

Operation ID:
CreateCabinetExternalGroup

Create a cabinet external group

Parameters

Name Key Required Type Description
Cabinet ID
 cabinetID True string

(It starts with NG-)
Group name
 name True string

Group name
Group options
 options string

Group options
Cabinet default access
 access string

Cabinet default access
CollabSpace ID
 collaborationSpaceId string

(To make this a CollabSpace-external group)
CollabSpace access
 collaborationspaceaccess string

CollabSpace access
Top workspace attribute value
 topwsattributegroupkey string

(For regular cabinet external groups; to associate the group with a specific top workspace attribute value)

Returns

Name Path Type Description
Type
 Type integer
Id
 Id string
Name
 Name string
Options
 Options string
Access
 Access string

Create a new version of a document

Operation ID:
NewVersion

Create new version of a document

Parameters

Name Key Required Type Description
Document ID
 id True string

12-digit document ID.
Document extension
 extension string

Do not include the leading period.
Version description
 version_description string

Version description
Name of the new version
 verName string

Name of the new version
Make official version
 official boolean

The new version will not be the official version if this parameter is not set.
Add to recent documents
 addToRecent boolean

Add to recent documents
Source version number
 srcVer string

If copying the content from a prior version, which version of the document to copy.
Create as a subversion
 allocatesubversion boolean

Create as a subversion instead of as a full version.
New version document content
 body binary

The content of the new version, if not copying another version or the official version.

Returns

Name Path Type Description
latestVersionNumber
 latestVersionNumber integer
newVer
 newVer integer
newVersionLabel
 newVersionLabel string
officialVer
 officialVer integer
officialVerName
 officialVerName string
versions
 versions integer

Create CollabSpace

Operation ID:
CreateCollabSpace

Create a new CollabSpace

Parameters

Name Key Required Type Description
Workspace ID
 workspaceID True string

Workspace ID
CollabSpace name
 name True string

CollabSpace name
Description
 description string

Description

Returns

Name Path Type Description
Id
 Id string
EnvUrl
 EnvUrl string

Create document

Operation ID:
CreateDocument

Create a new document

Parameters

Name Key Required Type Description
Destination
 destination True string

The 12-digit ID or EnvID of the folder, filter or workspace.
Document content
 file True file

Put the filename plus extension in the accompanying filename field.
Add to recent
 addToRecent boolean

Add to recent
Document profile
 profile string

Set the document profile (JSON format)

Returns

Name Path Type Description
id
 id string
extension
 extension string
name
 name string

Create folder

Operation ID:
CreateFolder

Create a new folder

Parameters

Name Key Required Type Description
Folder name
 name True string

Folder name.
Parent ID
 parent string

12-digit ID or EnvID of the new folder’s parent container.
Cabinet ID
 cabinet string

(It starts with NG-) Can be omitted if a folder or workspace id is specified in the parent.

Returns

Name Path Type Description
id
 standardAttributes.id string
name
 standardAttributes.name string

Create or update a child lookup table entry

Operation ID:
CreateChildEntry

Create or update a child lookup table entry

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(It starts with CA-)
Child attribute ID
 childAttributeID True string

(Remove the leading '10')
Parent key
 parentID True string

Parent key
Child key
 childID True string

Child key
Description
 description string
Type
 defaulting string
Litigation Hold
 hold boolean
Closed Date
 closed string

Format '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/'
Filtered permissions
 filtered_permissions True boolean
Force permssions
 force_permissions True boolean
View
 view True boolean
Edit
 edit True boolean
Share
 share True boolean
Administer
 administer True boolean
No access
 noAccess True boolean
Cabinet default
 cabDefault True boolean
Principal
 principal True string

(User or group ID)

Returns

Name Path Type Description
count
 count integer

Create or update a lookup table entry

Operation ID:
CreateEntry

Create or update a lookup table entry

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(It starts with CA-)
Attribute ID
 attributeID True string

(Remove the leading '10')
Key
 parentID True string

Key
Description
 description string
Type
 defaulting string
Litigation Hold
 hold boolean
Closed Date
 closed string

Format '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/'
Filtered permissions
 filtered_permissions True boolean
Force permssions
 force_permissions True boolean
View
 view True boolean
Edit
 edit True boolean
Share
 share True boolean
Administer
 administer True boolean
No access
 noAccess True boolean
Cabinet default
 cabDefault True boolean
Principal
 principal True string

(User or group ID)

Returns

Name Path Type Description
count
 count integer

Create repository group

Operation ID:
CreateRepositoryGroup

Create a repository group

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(It starts with CA-)
Group name
 name True string

Group name
External
 external True boolean

External
Hide in lists
 hidden True boolean

Hide in lists
Hidden membership
 hideMembership True boolean

Hidden membership

Returns

Name Path Type Description
external
 external boolean
hidden
 hidden boolean
hideMembership
 hideMembership boolean
id
 id string
name
 name string
Operation ID:
CreateSecuredLink

Generate a link to a document that can be accessed by anyone

Parameters

Name Key Required Type Description
Document ID
 id True string

12-digit document ID.
Password for the secured link
 password string

Depending on the cabinet configuration, the password may be optional or mandatory.
Expiration date for secured link.
 expirationdate string

Input format: yyyy-MM-dd.
Version of the document
 version string

Which version of the document to share. If empty, the official version will be shared.
Download document
 download boolean

If true, the document may be downloaded by the recipient.
Notify me
 notifyme boolean

If true, notify the sender when the secured link is accessed.
Lock document
 lock boolean

Optionally, lock the selected version of the document. This requires Edit rights.

Returns

Name Path Type Description
view
 standardAttributes.view string
download
 standardAttributes.download string

Create user

Operation ID:
CreateUser

Create a user in a repository

Parameters

Name Key Required Type Description
Username
 username True email

(The same as the user's email address)
First name
 displayFirstName True string

First name
Middle name
 displayMiddleName string

Middle name
Last name
 displayLastName True string

Last name
Email address
 email True email

Email address
User is external
 external True boolean

(Only applicable on add)
Send welcome email
 sendWelcome True boolean

Send welcome email
Repository ID
 repository True string

(Starts with CA-)

Returns

Name Path Type Description
displayName
 displayName string
email
 email email
id
 id string
external
 external boolean

Delete a child lookup table entry

Operation ID:
DeleteChildEntry

Delete a child lookup table entry

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(It starts with CA-)
Child attribute ID
 childAttributeID True string

(Remove the leading '10')
Parent key
 parentID True string

Parent key
Child key
 childID True string

Child key

Returns

Name Path Type Description
count
 count integer

Delete a lookup table entry

Operation ID:
DeleteLookupEntry

Delete a lookup table entry

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(It starts with CA-)
Attribute ID
 attributeID True string

(Remove the leading '10')
Key
 parentID True string

Key

Returns

Name Path Type Description
count
 count integer

Delete document

Operation ID:
DeleteDoc

Delete a document

Parameters

Name Key Required Type Description
Document ID
 id True string

12-digit document ID.
Delete permanently
 permanent boolean

Indicates that the document should be permanently deleted, rather than moved to Deleted Items.

Delete folder

Operation ID:
DeleteFolder

Delete a folder

Parameters

Name Key Required Type Description
Folder ID
 id True string

12-digit Folder ID.
Delete permanently
 permanent boolean

Indicates that the folder should be permanently deleted, rather than moved to Deleted Items. The contents of the folder, including descendant subfolders, will not be permanently deleted.
Delete folder contents
 deleteContents boolean

Indicates that the documents in the deleted folder (and in any descendant subfolder) should be deleted also, rather than simply unfiled.

Delete repository group

Operation ID:
DeleteRepositoryGroup

Delete a repository group

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(It starts with CA-)
Group ID
 groupID True string

(Starts with UG-)

Document history

Operation ID:
GetDocHistory

Retrieve a list of actions taken on a document

Parameters

Name Key Required Type Description
Document ID
 id True string

12-digit document ID.

File or unfile document to folder

Operation ID:
FileFolder

File an item in a folder or unfile an item from a folder.

Parameters

Name Key Required Type Description
Folder ID
 id True string

12-digit folder ID.
Document ID
 item True string

12-digit document ID.
File or unfile
 action True string

File or unfile

Follow document

Operation ID:
FollowDocument

Receive alerts when the document is updated

Parameters

Name Key Required Type Description
Document ID
 id True string

12-digit document ID.
Recipients
 recipients True string

One or more valid email addresses separated by semi-colons. Duplicates ignored.
Send
 send string

Which category of users should receive the alert.

Follow folder

Operation ID:
FollowFolder

Receive alerts when new content is added to a folder

Parameters

Name Key Required Type Description
Folder ID
 id True string

12-digit folder ID.
Recipients
 recipients True string

One or more valid email addresses separated by semi-colons. Duplicates ignored.
Send
 send string

Which category of users should receive the alert.

Get a child lookup table entry

Operation ID:
GetChildEntry

Get a child lookup table entry

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(It starts with CA-)
Child attribute ID
 childAttributeID True string

(Remove the leading '10')
Parent key
 parentID True string

Parent key
Child key
 childID True string

Child key

Returns

Get a lookup table entry or search for child table entries

Operation ID:
GetLookupEntry

Get a lookup table entry or search for child table entries

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(It starts with CA-)
Attribute ID
 attributeID True string

(Remove the leading '10'. To return a single value, enter the parent attribute ID, or to search for child entries, enter the child attribute ID.)
Key
 parentID True string

(To return a single value, enter the key of the single attribute, or to search for child entries enter the key of the parent.)
Filter (only when searching)
 $filter string

(See the documentation for the available filters)
Fields to retrieve
 $select string

(Include comma-separated list of: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user', and/or 'access')
Number of matching records to skip
 $skip integer

(This is used when retrieving multiple blocks of results.)
Maximum number of records to return
 $top integer

Maximum number of records to return
Order results by
 $orderby string

Order results by

Get cabinet custom attributes

Operation ID:
GetCabinetCustomAttributes

Get cabinet custom attributes

Parameters

Name Key Required Type Description
Cabinet ID
 cabinetID True string

(It starts with NG-)

Returns

Name Path Type Description
array of object
items
 object

Get cabinet groups

Operation ID:
GetCabinetGroups

Get all of the groups added to a cabinet

Parameters

Name Key Required Type Description
Cabinet ID
 cabinetID True string

(It starts with NG-)

Returns

Name Path Type Description
array of object
Id
 Id string
Name
 Name string
External
 External boolean
Hidden
 Hidden boolean

Get cabinet information

Operation ID:
GetCabinetInformation

Get cabinet information

Parameters

Name Key Required Type Description
Cabinet ID
 cabinetID True string

(It starts with NG-)

Get cabinet settings

Operation ID:
GetCabinetSettings

Get cabinet settings

Parameters

Name Key Required Type Description
Cabinet ID
 cabinetID True string

(It starts with NG-)

Get container contents

Operation ID:
GetContainerContents

Get the contents of the selected container

Parameters

Name Key Required Type Description
Container ID
 containerID True string

Container ID
Information to return
 select True string

(Review the documentation for the return format)
Number of results to return (defaults to 50)
 top integer

(Maximum 500 per page)
Token used for paginating results
 skiptoken string

Token used for paginating results
Order by
 orderby string

(Format: field#|desc or field#|asc)

Get current user info

Operation ID:
GetCurrentUserInfo

Get info about current user, ID isn't required

Parameters

Name Key Required Type Description
Cabinet ID
 cabGuid string

(It starts with NG-)

Returns

Name Path Type Description
displayName
 displayName string
email
 email email
id
 id string
organization
 organization string
isRepositoryMember
 isRepositoryMember boolean
primaryCabinet
 primaryCabinet string
sortLookupBy
 sortLookupBy string
external
 external boolean

Get document content

Operation ID:
GetDocContent

Retrieve a document

Parameters

Name Key Required Type Description
Document ID
 id True string

12-digit document ID.
Base64 encoded?
 base64 boolean

Base64 encoded?

Get document profile

Operation ID:
GetDocInfo

Get information about a document

Parameters

Name Key Required Type Description
Document ID
 id True string

12-digit document ID.

Get document versions

Operation ID:
GetDocumentVersions

Get document versions

Parameters

Name Key Required Type Description
Document ID
 documentID True string

12-digit document ID.

Get folder items

Operation ID:
GetFldContent

Retrieve the contents of a folder, including documents and subfolders

Parameters

Name Key Required Type Description
Folder ID
 id True string

12-digit folder ID.
Attributes to return
 $select string

A comma-separated list of attribute values. See the REST API documentation for more details.

Get group information

Operation ID:
GetGroupInformation

Get group information

Parameters

Name Key Required Type Description
Group ID
 groupID True string

Group ID (starts with UG-).
Group cabinet membership
 cabMembership boolean

(If set to 'true' the cabinets this groups is a member of and the default document access rights for each cabinet will be included.)

Returns

Name Path Type Description
external
 external boolean
hidden
 hidden boolean
hideMembership
 hideMembership boolean
id
 id string
name
 name string
cabMembership
 cabMembership array of object
id
 cabMembership.id string
name
 cabMembership.name string
rights
 cabMembership.rights string

Get group membership

Operation ID:
GetGroupMembership

Get group membership

Parameters

Name Key Required Type Description
Group ID
 groupID True string

(Starts with UG-)

Returns

Name Path Type Description
array of object
displayName
 displayName string
id
 id string

Get list of user cabinets

Operation ID:
GetUserCabinets

Get User cabinets

Returns

Name Path Type Description
array of object
id
 id string
isCollaborationSpacesEnabled
 isCollaborationSpacesEnabled string
name
 name string
repositoryId
 repositoryId string
repositoryName
 repositoryName string
wsAttrNum
 wsAttrNum integer
wsOrgAttrNum
 wsOrgAttrNum integer

Get or create a workspace (with a single attribute)

Operation ID:
CreateWorkspaceSingle

Get or create a workspace (with a single attribute)

Parameters

Name Key Required Type Description
Cabinet ID
 cabinetID True string

(It starts with NG-)
Sole Value
 parentID True string

The sole value used to define workspaces in the cabinet.

Returns

Name Path Type Description
id
 standardAttributes.id string

Get or create a workspace (with parent and child attributes)

Operation ID:
CreateWorkspaceParentChild

Get or create a workspace (with parent and child attributes)

Parameters

Name Key Required Type Description
Cabinet ID
 cabinetID True string

(It starts with NG-)
Parent Value
 parentID True string

The parent value used to define workspaces in the cabinet.
Child Value
 childID True string

The child value used to define workspaces in the cabinet.

Returns

Name Path Type Description
id
 standardAttributes.id string

Get repository groups

Operation ID:
GetRepositoryGroups

Get repository groups

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(It starts with CA-)
Filter
 $filter string

(See the documentation for filter criteria)
Number of results
 $top string

(Defaults to 5,000. Maximum 10,000)
Paging
 paging boolean

(Return the results in pages; default is false)
Paging token
 $skiptoken string

(For paging purposes; returned by prior calls as 'next')
Return info
 returnInfo string

all will return group names. Default is blank to return just IDs

Returns

Name Path Type Description
array of string

Get repository information

Operation ID:
GetRepositoryInformation

Get repository information

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(Starts with CA-)

Get repository log

Operation ID:
GetRepositoryLog

Get repository log

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(Starts with CA-)
Start date/time
 start string

(Defaults to 30 days; format yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ)
End date/time
 end string

(Same format as start; defaults to today)
Log type
 Logtype True string

Log type

Get repository users

Operation ID:
GetRepositoryUsers

Get repository users

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(Starts with CA-)

Returns

Name Path Type Description
array of object
displayName
 displayName string
email
 email string
external
 external boolean
id
 id string
lastLogin
 lastLogin string
registered
 registered string

Get unhidden cabinet groups access rights

Operation ID:
GetCabinetDefaultAccess

Get unhidden cabinet groups access rights

Parameters

Name Key Required Type Description
Cabinet ID
 cabinetID True string

(It starts with NG-)

Returns

Name Path Type Description
array of object
administer
 administer boolean
cabDefault
 cabDefault boolean
edit
 edit boolean
name
 name string
noAccess
 noAccess boolean
principal
 principal string
share
 share boolean
view
 view boolean

Get user info

Operation ID:
GetUserInfo

Get information about a user

Parameters

Name Key Required Type Description
User ID
 id True string

The user ID assigned by NetDocuments.
Cabinet ID
 cabGuid string

(It starts with NG-)

Returns

Name Path Type Description
displayName
 displayName string
email
 email email
id
 id string
organization
 organization string
isRepositoryMember
 isRepositoryMember boolean
primaryCabinet
 primaryCabinet string
sortLookupBy
 sortLookupBy string
external
 external boolean

Get workspace information

Operation ID:
GetWorkspaceInformation

Get workspace information

Parameters

Name Key Required Type Description
Workspace ID
 workspaceID True string

Workspace ID

Lock document

Operation ID:
LockDocument

Lock document

Parameters

Name Key Required Type Description
Document ID
 id True string

Document iD
Comment
 comment string

Comment

Lock document version

Operation ID:
LockDocumentVersion

Lock document version

Parameters

Name Key Required Type Description
Document ID
 id True string

12-digit document ID.
Document version
 version True integer

Document version
Version description
 description string

Version description

Refresh a workspace

Operation ID:
RefreshWorkspace

Refresh a workspace

Parameters

Name Key Required Type Description
Workspace ID
 workspaceID True string

Workspace ID

Rename document

Operation ID:
RenameDocument

Rename a document

Parameters

Name Key Required Type Description
Document ID
 id True string

12-digit document ID.
New name
 name True string

Rename folder

Operation ID:
RenameFolder

Rename a folder

Parameters

Name Key Required Type Description
Folder ID
 id True string

12-digit folder ID.
New name
 name True string

Search a cabinet and modify ACLs

Operation ID:
SearchCabinetModifyACLs

Search a cabinet and modify ACLs

Parameters

Name Key Required Type Description
Cabinet ID
 cabinetID True string

(It starts with NG-)
Query
 q True string

(Review the documentation for the query format)
Modify ACL mode
 mode True string

Modify ACL mode
New ACL
 newAcl True string

(Review the documentation for the proper json format)
Email address
 email email

(Send notification to this address instead)
Send completion emails
 completionEmail string

(true = send always (default), false = don't send, fail = send only on fail)

Search for lookup table entries

Operation ID:
SearchLookupEntries

Search for lookup table entries

Parameters

Name Key Required Type Description
Repository ID
 repositoryID True string

(It starts with CA-)
Attribute ID
 attributeID True string

(Remove the leading '10')
Filter
 $filter string

(See the documentation for the available filters)
Fields to retrieve
 $select string

(Include comma-separated list of: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user', and/or 'access')
Number of matching records to skip
 $skip integer

(This is used when retrieving multiple blocks of results.)
Maximum number of records to return
 $top integer

Maximum number of records to return

Returns

Name Path Type Description
rows
 rows array of object
defaulting
 rows.defaulting string
description
 rows.description string
hold
 rows.hold boolean
key
 rows.key string
closed
 rows.closed string
access
 rows.access string

Search one or more cabinets

Operation ID:
SearchCabinets

Search one or more cabinets

Parameters

Name Key Required Type Description
Cabinets
 cabinets True string

(comma-delimited)
Query
 q True string

(Review the documentation for the query format)
Information to return
 select True string

(Review the documentation for the return format)
Order by
 orderby string

(Format: field#|desc or field#|asc)
Number of results to return (defaults to 50)
 top integer

(Maximum 500 per page)
Number of results to skip
 skip integer

Number of results to skip
Token used for paginating results
 skiptoken string

Token used for paginating results

Unlock document

Operation ID:
UnockDocument

Unock document

Parameters

Name Key Required Type Description
Document ID
 id True string

Document ID

Update document

Operation ID:
UpdateDocument

Update the content of a document

Parameters

Name Key Required Type Description
Document ID
 id True string

12-digit document ID.
Document extension
 extension string

Only necessary if changing the document's extension. Do not include the leading period.
Base64 encoded?
 base64 boolean

Base64 encoded?
Updated document content
 body True byte

The content of the document.

Triggers

Search cabinet

Search the specified cabinet

Search cabinet

Operation ID:
SearchCab

Search the specified cabinet

Parameters

Name Key Required Type Description
Cabinet ID
 cabId True string

(It starts with NG-)
Search criteria
 q True string

Use the same format and operators as in the NetDocuments web interface.
Order by
 $orderby string

Order by
Maximum number of results
 $top string

An integer between 1 and 500. Default is 100.
Attributes to return
 $select string

A comma-separated list of attribute values. See the REST API documentation for more details.