NetDocuments (Preview)

NetDocuments (Preview)

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
Flow Standard All Flow regions except the following:
     -   US Government (GCC)
PowerApps Standard All PowerApps regions except the following:
     -   US Government (GCC)

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Creating a connection

To connect your account, you will need the following information:

Region
string
Region your net document resides within.

Actions

Check in document

Check in a checked-out document

Required Parameters

Document ID
string
12-digit document ID.

Optional Parameters

Document extension
string
Do not include the leading period.
Document Content
file
The document in multi-part form.
Add to recent
boolean
Add to the user's recent documents list.

Check out document

Check out a document

Required Parameters

Document ID
string
12-digit document ID.

Optional Parameters

Comment
string
Optional check-out comment.
Download document
boolean
Returns the document content.
Version to download
string
Specifies which version’s content should be downloaded. Defaults to the official version.
Add to recent
boolean
Add to the user's recent documents list.

Create document

Create a new document

Required Parameters

Destination
string
The 12-digit ID or EnvID of the folder, filter or workspace.
Document content
file
Put the filename plus extension in the accompanying filename field.

Optional Parameters

Add to recent
boolean
Add to the user's recent documents list.

Create folder

Create a new folder

Required Parameters

Folder name
string
Folder name.

Optional Parameters

Parent ID
string
12-digit ID or EnvID of the new folder’s parent folder or workspace.
Cabinet ID
string
Can be omitted if a folder or workspace id is specified in the parent.

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

Required Parameters

Document ID
string
12-digit document ID.

Optional Parameters

Password for the secured link
string
Depending on the cabinet configuration, the password may be optional or mandatory.
Expiration date for secured link.
string
Input format: yyyy-MM-dd.
Version of the document
string
Which version of the document to share. If empty, the official version will be shared.
Download document
boolean
If true, the document may be downloaded by the recipient.
Notify me
boolean
If true, notify the sender when the secured link is accessed.
Lock document
boolean
Optionally, lock the selected version of the document. This requires Edit rights.

Delete document

Delete a document

Required Parameters

Document ID
string
12-digit document ID.

Optional Parameters

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

Document history

Retrieve a list of actions taken on a document

Required Parameters

Document ID
string
12-digit document ID.

File document to folder

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

Required Parameters

Folder ID
string
12-digit folder ID.
Document ID
string
12-digit document ID.
File or unfile
string
Whether to file or unfile the document.

Follow folder

Receive alerts when new content is added to a folder

Required Parameters

Folder ID
string
12-digit folder ID.
Recipients
string
One or more valid email addresses separated by semi-colons. Duplicates ignored.

Optional Parameters

Send
string
Which category of users should receive the alert.

Get current user info

Get info about current user, ID isn't required

Required Parameters

Document ID
string
12-digit document ID.

Optional Parameters

Document extension
string
Do not include the leading period.
Document Content
file
The document in multi-part form.
Add to recent
boolean
Add to the user's recent documents list.

Returns

displayName
string
Get info about current user, ID isn't required
email
email
Get info about current user, ID isn't required
id
string
Get info about current user, ID isn't required
organization
string
Get info about current user, ID isn't required
primaryCabinet
string
Get info about current user, ID isn't required
sortLookupBy
string
Get info about current user, ID isn't required

Get document content

Retrieve a document

Required Parameters

Document ID
string
12-digit document ID.

Optional Parameters

Base64 encoded?
boolean
Encode content.

Get document profile

Get information about a document

Required Parameters

Document ID
string
12-digit document ID.

Get folder items

Retrieve the contents of a folder, including documents and subfolders

Required Parameters

Folder ID
string
12-digit folder ID.

Optional Parameters

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

Get user info

Get information about a user

Required Parameters

User ID
string
The user ID assigned by NetDocuments.

Returns

displayName
string
Get information about a user
email
email
Get information about a user
id
string
Get information about a user
organization
string
Get information about a user
primaryCabinet
string
Get information about a user
sortLookupBy
string
Get information about a user

New version

Create new version of document

Required Parameters

Document ID
string
12-digit document ID.

Optional Parameters

Document extension
string
Do not include the leading period.
Version description
string
Optional version description.
Make official version
boolean
The new version will not be the official version if this parameter is not set.
Add to recent documents
boolean
Add to the user's recent documents list.
Source version number
string
If copying the content from a prior version, which version of the document to copy.
New version document content
binary
The content of the new version, if not copying another version or the official version.

Update document

Update the content of a document

Required Parameters

Document ID
string
12-digit document ID.
Updated document content
byte
The content of the document.

Optional Parameters

Document extension
string
Only necessary if changing the document's extension. Do not include the leading period.
Base64 encoded?
boolean
Encode content.

Triggers

Search cabinet

Search the specified cabinet

Required Parameters

Cabinet ID
string
Cabinet ID.
Search criteria
string
Use the same format and operators as in the NetDocuments web interface.

Optional Parameters

Order by
string
How to order the results.
Maximum number of results
string
An integer between 1 and 500. Default is 100.
Attributes to return
string
A comma-separated list of attribute values. See the REST API documentation for more details.