Connectors Reference

NetDocuments

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

 

Status: Preview

Tier: Standard

Version: 0.3.0

 

Actions:

Name

Summary

GetUserInfo (string id, [advanced][Optional]string cabGuid, [internal]string Accept)

Get user info

GetUserCabinets ([internal]string Accept)

Get list of user cabinets

NewVersion (string id, [Optional]string extension, [Optional]string version_description, [Optional]string verName, [advanced][Optional]boolean official, [advanced][Optional]boolean addToRecent, [advanced][Optional]string srcVer, [advanced][Optional]boolean allocatesubversion, [Optional]string body, [internal]string Accept)

Create a new version of a document

GetDocInfo (string id, [internal]string Accept)

Get document profile

RenameDocument (string id, RenameBody RenameBody, [internal]string Accept)

Rename document

GetDocContent (string id, [Optional]boolean base64)

Get document content

DeleteDoc (string id, [advanced][Optional]boolean permanent, [internal]string Accept)

Delete document

UpdateDocument (string id, [Optional]string extension, [Optional]boolean base64, [internal]string Accept, string body)

Update document

CreateFolder (string name, [internal]boolean sanitizeName, [Optional]string parent, [Optional]string cabinet, [internal]string Accept)

Create folder

GetFldContent (string id, [advanced][Optional]string $select, [internal]string Accept)

Get folder items

FileFolder (string id, string item, string action)

File or unfile document to folder

DeleteFolder (string id, [advanced][Optional]boolean permanent, [advanced][Optional]boolean deleteContents, [internal]string Accept)

Delete folder

RenameFolder (string id, RenameBody RenameBody, [internal]string Accept)

Rename folder

FollowFolder (string id, string recipients, [Optional]string send)

Follow folder

FollowDocument (string id, string recipients, [Optional]string send)

Follow document

GetCurrentUserInfo ([internal]string Accept, [advanced][Optional]string cabGuid)

Get current user info

CheckinDoc ([internal]string Accept, string id, [Optional]string extension, [Optional]file file, [advanced][Optional]boolean addToRecent)

Check in document

CheckOutDoc ([internal]string Accept, string id, [advanced][Optional]string comment, [Optional]boolean download, [Optional]string version, [advanced][Optional]boolean addToRecent)

Check out document

CreateDocument ([internal]string Accept, string destination, file file, [Optional]boolean addToRecent, [Optional]string profile, [internal]boolean partialProfiling)

Create document

LockDocumentVersion ([internal]string Accept, string id, integer version, [Optional]string description)

Lock document version

GetDocumentVersions ([internal]string Accept, string documentID)

Get document versions

CreateSecuredLink ([internal]string Accept, string id, [Optional]string password, [Optional]string expirationdate, [Optional]string version, [Optional]boolean download, [Optional]boolean notifyme, [advanced][Optional]boolean lock)

Create secured link

GetDocHistory (string id, [internal]string Accept)

Document history

CreateWorkspaceParentChild (string cabinetID, string parentID, string childID, [internal]string Accept, [internal]string Content-Type)

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

CreateWorkspaceSingle (string cabinetID, string parentID, [internal]string Accept, [internal]string Content-Type)

Get or create a workspace (with a single attribute)

GetWorkspaceInformation (string workspaceID, [internal]string Accept, [internal]string Content-Type)

Get workspace information

CreateChildEntry (string repositoryID, string childAttributeID, string parentID, string childID, [internal]string Accept, [internal]string Content-Type, LookupEntryBody LookupEntryBody)

Create or update a child lookup table entry

GetChildEntry (string repositoryID, string childAttributeID, string parentID, string childID, [internal]string Accept, [internal]string Content-Type)

Get a child lookup table entry

DeleteChildEntry (string repositoryID, string childAttributeID, string parentID, string childID, [internal]string Accept, [internal]string Content-Type)

Delete a child lookup table entry

CreateEntry (string repositoryID, string attributeID, string parentID, [internal]string Accept, [internal]string Content-Type, LookupEntryBody LookupEntryBody)

Create or update a lookup table entry

GetLookupEntry (string repositoryID, string attributeID, string parentID, [advanced][Optional]string $filter, [advanced][Optional]string $select, [advanced][Optional]integer $skip, [advanced][Optional]integer $top, [advanced][Optional]string $orderby, [internal]string Accept, [internal]string Content-Type)

Get a lookup table entry or search for child table entries

DeleteLookupEntry (string repositoryID, string attributeID, string parentID, [internal]string Accept, [internal]string Content-Type)

Delete a lookup table entry

SearchLookupEntries (string repositoryID, string attributeID, [Optional]string $filter, [advanced][Optional]string $select, [advanced][Optional]integer $skip, [advanced][Optional]integer $top, [internal]string $orderby, [internal]string Accept, [internal]string Content-Type)

Search for lookup table entries

SearchCabinets (string cabinets, string q, string select, [Optional]string orderby, [advanced][Optional]integer top, [advanced][Optional]integer skip, [advanced][Optional]string skiptoken, [internal]string Accept, [internal]string Content-Type)

Search one or more cabinets

RefreshWorkspace (string workspaceID, [internal]string action, [internal]string Accept, [internal]string Content-Type)

Refresh a workspace

LockDocument (string id, [Optional]string comment, [internal]string Accept, [internal]string Content-Type)

Lock document

UnockDocument (string id, [internal]string Accept, [internal]string Content-Type)

Unlock document

GetRepositoryLog (string repositoryID, [internal]string format, [Optional]string start, [Optional]string end, string Logtype, [internal]string Accept, [internal]string Content-Type)

Get repository log

GetRepositoryInformation (string repositoryID, [internal]string Accept, [internal]string Content-Type)

Get repository information

GetRepositoryUsers (string repositoryID, [internal]string Accept, [internal]string Content-Type)

Get repository users

GetRepositoryGroups (string repositoryID, [Optional]string $filter, [advanced][Optional]string $top, [advanced][Optional]boolean paging, [advanced][Optional]string $skiptoken, [advanced][Optional]string returnInfo, [internal]string Accept, [internal]string Content-Type)

Get repository groups

CreateRepositoryGroup (string repositoryID, string name, boolean external, boolean hidden, boolean hideMembership, [internal]string Accept, [internal]string Content-Type)

Create repository group

DeleteRepositoryGroup (string repositoryID, string groupID, [internal]string Accept)

Delete repository group

CreateUser (string username, string displayFirstName, [Optional]string displayMiddleName, string displayLastName, string email, boolean external, boolean sendWelcome, string repository, [internal]string Accept, [internal]string Content-Type)

Create user

AddOrRemoveUserRepository (string repositoryID, string action, string member, boolean external, [advanced][Optional]boolean deleteIfFederated, [internal]string Accept, [internal]string Content-Type)

Add user to or remove user from repository

CreateCollabSpace (string workspaceID, string name, [internal]boolean sanitizeName, [Optional]string description, [internal]string Accept, [internal]string Content-Type)

Create CollabSpace

GetCabinetSettings (string cabinetID, [internal]string Accept, [internal]string Content-Type)

Get cabinet settings

GetCabinetInformation (string cabinetID, [internal]string Accept, [internal]string Content-Type)

Get cabinet information

GetCabinetCustomAttributes (string cabinetID, [internal]string Accept, [internal]string Content-Type)

Get cabinet custom attributes

GetCabinetDefaultAccess (string cabinetID, [internal]string Accept, [internal]string Content-Type)

Get unhidden cabinet groups access rights

AddToOrRemoveGroupFromCabinet (string cabinetID, string action, string id, boolean view, boolean edit, boolean share, boolean administer, boolean noAccess, [internal]string Accept, [internal]string Content-Type)

Add to or remove group from cabinet

GetCabinetGroups (string cabinetID, [internal]string Accept, [internal]string Content-Type)

Get cabinet groups

CreateCabinetExternalGroup (string cabinetID, string name, [Optional]string options, [Optional]string access, [advanced][Optional]string collaborationSpaceId, [advanced][Optional]string collaborationspaceaccess, [advanced][Optional]string topwsattributegroupkey, [internal]string Accept, [internal]string Content-Type)

Create a cabinet external group

SearchCabinetModifyACLs (string cabinetID, [internal]string action, string q, string mode, string newAcl, [advanced][Optional]string email, [advanced][Optional]string completionEmail, [internal]string Accept, [internal]string Content-Type)

Search a cabinet and modify ACLs

GetContainerContents (string containerID, string select, [advanced][Optional]integer top, [advanced][Optional]string skiptoken, [advanced][Optional]string orderby, [internal]string Accept, [internal]string Content-Type)

Get container contents

GetGroupInformation (string groupID, [advanced][Optional]boolean cabMembership, [internal]string Accept, [internal]string Content-Type)

Get group information

GetGroupMembership (string groupID, [internal]string Accept, [internal]string Content-Type)

Get group membership

AddOrRemoveGroupMember (string groupID, string action, string member, [internal]string Accept, [internal]string Content-Type)

Add or remove group member

 

Triggers:

Name

Summary

SearchCab (string cabId, string q, [advanced][Optional]string $orderby, [advanced][Optional]string $top, [Optional]string $select, [internal]string Accept)

Search cabinet

 

Objects:

Name

Summary

CreateCabinetExternalGroupResponse

 

CreateChildEntryResponse

 

CreateCollabSpaceResponse

 

CreateDocumentResponse

 

CreateEntryResponse

 

CreateFolderResponse

 

CreateRepositoryGroupResponse

 

CreateSecuredLinkResponse

 

CreateUserResponse

 

CreateWorkspaceParentChildResponse

 

CreateWorkspaceSingleResponse

 

DeleteChildEntryResponse

 

DeleteLookupEntryResponse

 

file

Document Content

GetCabinetCustomAttributesResponseItem

 

GetCabinetDefaultAccessResponseItem

 

GetCabinetGroupsResponseItem

 

GetChildEntryResponse

 

GetCurrentUserInfoResponse

 

GetGroupInformationResponse

 

GetGroupMembershipResponseItem

 

GetRepositoryUsersResponseItem

 

GetUserCabinetsResponseItem

 

GetUserInfoResponse

 

LookupEntryBody

 

NewVersionResponse

 

RenameBody

 

SearchLookupEntriesResponse

 

 

Actions:

GetUserInfo

Summary: Get user info

Description: Get information about a user

 

Syntax:

NetDocuments.GetUserInfo (string id, [advanced][Optional]string cabGuid, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(User ID)

The user ID assigned by NetDocuments.

True

cabGuid

string

(Cabinet ID)

(It starts with NG-)

False

Accept

string

 

 

True

 

Returns:

††††††††† Type:GetUserInfoResponse

 

GetUserCabinets

Summary: Get list of user cabinets

Description: Get User cabinets

 

Syntax:

NetDocuments.GetUserCabinets ([internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

Accept

string

 

 

True

 

Returns:

††††††††† Type:array of (GetUserCabinetsResponseItem)

 

NewVersion

Summary: Create a new version of a document

Description: Create new version of a document

 

Syntax:

NetDocuments.NewVersion (string id, [Optional]string extension, [Optional]string version_description, [Optional]string verName, [advanced][Optional]boolean official, [advanced][Optional]boolean addToRecent, [advanced][Optional]string srcVer, [advanced][Optional]boolean allocatesubversion, [Optional]string body, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Document ID)

12-digit document ID.

True

extension

string

(Document extension)

Do not include the leading period.

False

version_description

string

(Version description)

Version description

False

verName

string

(Name of the new version)

Name of the new version

False

official

boolean

(Make official version)

The new version will not be the official version if this parameter is not set.

False

addToRecent

boolean

(Add to recent documents)

Add to recent documents

False

srcVer

string

(Source version number)

If copying the content from a prior version, which version of the document to copy.

False

allocatesubversion

boolean

(Create as a subversion)

Create as a subversion instead of as a full version.

False

body

string(binary)

 

 

False

Accept

string

 

 

True

 

Returns:

††††††††† Type:NewVersionResponse

 

GetDocInfo

Summary: Get document profile

Description: Get information about a document

 

Syntax:

NetDocuments.GetDocInfo (string id, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Document ID)

12-digit document ID.

True

Accept

string

 

 

True

 

Returns:

 

RenameDocument

Summary: Rename document

Description: Rename a document

 

Syntax:

NetDocuments.RenameDocument (string id, RenameBody RenameBody, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Document ID)

12-digit document ID.

True

RenameBody

RenameBody

 

 

True

Accept

string

 

 

True

 

Returns:

 

GetDocContent

Summary: Get document content

Description: Retrieve a document

 

Syntax:

NetDocuments.GetDocContent (string id, [Optional]boolean base64)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Document ID)

12-digit document ID.

True

base64

boolean

(Base64 encoded?)

Base64 encoded?

False

 

Returns:

 

DeleteDoc

Summary: Delete document

Description: Delete a document

 

Syntax:

NetDocuments.DeleteDoc (string id, [advanced][Optional]boolean permanent, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Document ID)

12-digit document ID.

True

permanent

boolean

(Delete permanently)

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

False

Accept

string

 

 

True

 

Returns:

 

UpdateDocument

Summary: Update document

Description: Update the content of a document

 

Syntax:

NetDocuments.UpdateDocument (string id, [Optional]string extension, [Optional]boolean base64, [internal]string Accept, string body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Document ID)

12-digit document ID.

True

extension

string

(Document extension)

Only necessary if changing the document's extension.† Do not include the leading period.

False

base64

boolean

(Base64 encoded?)

Base64 encoded?

False

Accept

string

 

 

True

body

string(byte)

 

 

True

 

Returns:

 

CreateFolder

Summary: Create folder

Description: Create a new folder

 

Syntax:

NetDocuments.CreateFolder (string name, [internal]boolean sanitizeName, [Optional]string parent, [Optional]string cabinet, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

name

string

(Folder name)

Folder name.

True

sanitizeName

boolean

(Remove invalid characters)

If true, invalid characters in the name parameter are removed without an error being returned.

True

parent

string

(Parent ID)

12-digit ID or EnvID of the new folderís parent container.

False

cabinet

string

(Cabinet ID)

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

False

Accept

string

 

 

True

 

Returns:

††††††††† Type:CreateFolderResponse

 

GetFldContent

Summary: Get folder items

Description: Retrieve the contents of a folder, including documents and subfolders

 

Syntax:

NetDocuments.GetFldContent (string id, [advanced][Optional]string $select, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Folder ID)

12-digit folder ID.

True

$select

string

(Attributes to return)

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

False

Accept

string

 

 

True

 

Returns:

 

FileFolder

Summary: File or unfile document to folder

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

 

Syntax:

NetDocuments.FileFolder (string id, string item, string action)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Folder ID)

12-digit folder ID.

True

item

string

(Document ID)

12-digit document ID.

True

action

string

(File or unfile)Values: [file, unfile]

File or unfile

True

 

Returns:

 

DeleteFolder

Summary: Delete folder

Description: Delete a folder

 

Syntax:

NetDocuments.DeleteFolder (string id, [advanced][Optional]boolean permanent, [advanced][Optional]boolean deleteContents, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Folder ID)

12-digit Folder ID.

True

permanent

boolean

(Delete permanently)

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.

False

deleteContents

boolean

(Delete folder contents)

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

False

Accept

string

 

 

True

 

Returns:

 

RenameFolder

Summary: Rename folder

Description: Rename a folder

 

Syntax:

NetDocuments.RenameFolder (string id, RenameBody RenameBody, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Folder ID)

12-digit folder ID.

True

RenameBody

RenameBody

 

 

True

Accept

string

 

 

True

 

Returns:

 

FollowFolder

Summary: Follow folder

Description: Receive alerts when new content is added to a folder

 

Syntax:

NetDocuments.FollowFolder (string id, string recipients, [Optional]string send)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Folder ID)

12-digit folder ID.

True

recipients

string

(Recipients)

One or more valid email addresses separated by semi-colons.† Duplicates ignored.

True

send

string

(Send)Values: [ignoreGenerator, ignoreCreator, always]

Which category of users should receive the alert.

False

 

Returns:

 

FollowDocument

Summary: Follow document

Description: Receive alerts when the document is updated

 

Syntax:

NetDocuments.FollowDocument (string id, string recipients, [Optional]string send)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Document ID)

12-digit document ID.

True

recipients

string

(Recipients)

One or more valid email addresses separated by semi-colons.† Duplicates ignored.

True

send

string

(Send)Values: [ignoreGenerator, ignoreCreator, always]

Which category of users should receive the alert.

False

 

Returns:

 

GetCurrentUserInfo

Summary: Get current user info

Description: Get info about current user, ID isn't required

 

Syntax:

NetDocuments.GetCurrentUserInfo ([internal]string Accept, [advanced][Optional]string cabGuid)

 

Parameters:

Name

Type

Summary

Required

Related Action

Accept

string

 

 

True

cabGuid

string

(Cabinet ID)

(It starts with NG-)

False

 

Returns:

††††††††† Type:GetCurrentUserInfoResponse

 

CheckinDoc

Summary: Check in document

Description: Check in a checked-out document

 

Syntax:

NetDocuments.CheckinDoc ([internal]string Accept, string id, [Optional]string extension, [Optional]file file, [advanced][Optional]boolean addToRecent)

 

Parameters:

Name

Type

Summary

Required

Related Action

Accept

string

 

 

True

id

string

(Document ID)

12-digit document ID.

True

extension

string

(Document extension)

Do not include the leading period.

False

file

file

(Document Content)

The document in multi-part form.

False

addToRecent

boolean

(Add to recent)

Add to the user's recent documents list.

False

 

Returns:

 

CheckOutDoc

Summary: Check out document

Description: Check out a document

 

Syntax:

NetDocuments.CheckOutDoc ([internal]string Accept, string id, [advanced][Optional]string comment, [Optional]boolean download, [Optional]string version, [advanced][Optional]boolean addToRecent)

 

Parameters:

Name

Type

Summary

Required

Related Action

Accept

string

 

 

True

id

string

(Document ID)

12-digit document ID.

True

comment

string

(Comment)

Comment

False

download

boolean

(Download document)

Returns the document content.

False

version

string

(Version to download)

Specifies which versionís content should be downloaded.† Defaults to the official version.

False

addToRecent

boolean

(Add to recent)

Add to recent

False

 

Returns:

 

CreateDocument

Summary: Create document

Description: Create a new document

 

Syntax:

NetDocuments.CreateDocument ([internal]string Accept, string destination, file file, [Optional]boolean addToRecent, [Optional]string profile, [internal]boolean partialProfiling)

 

Parameters:

Name

Type

Summary

Required

Related Action

Accept

string

 

 

True

destination

string

(Destination)

The 12-digit ID or EnvID of the folder, filter or workspace.

True

file

file

(Document content)

Put the filename plus extension in the accompanying filename field.

True

addToRecent

boolean

(Add to recent)

Add to recent

False

profile

string

(Document profile)

Set the document profile (JSON format)

False

partialProfiling

boolean

 

 

True

 

Returns:

††††††††† Type:CreateDocumentResponse

 

LockDocumentVersion

Summary: Lock document version

Description: Lock document version

 

Syntax:

NetDocuments.LockDocumentVersion ([internal]string Accept, string id, integer version, [Optional]string description)

 

Parameters:

Name

Type

Summary

Required

Related Action

Accept

string

 

 

True

id

string

(Document ID)

12-digit document ID.

True

version

integer

(Document version)

Document version

True

description

string

(Version description)

Version description

False

 

Returns:

 

GetDocumentVersions

Summary: Get document versions

Description: Get document versions

 

Syntax:

NetDocuments.GetDocumentVersions ([internal]string Accept, string documentID)

 

Parameters:

Name

Type

Summary

Required

Related Action

Accept

string

 

 

True

documentID

string

(Document ID)

12-digit document ID.

True

 

Returns:

 

CreateSecuredLink

Summary: Create secured link

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

 

Syntax:

NetDocuments.CreateSecuredLink ([internal]string Accept, string id, [Optional]string password, [Optional]string expirationdate, [Optional]string version, [Optional]boolean download, [Optional]boolean notifyme, [advanced][Optional]boolean lock)

 

Parameters:

Name

Type

Summary

Required

Related Action

Accept

string

 

 

True

id

string

(Document ID)

12-digit document ID.

True

password

string

(Password for the secured link)

Depending on the cabinet configuration, the password may be optional or mandatory.

False

expirationdate

string

(Expiration date for secured link.)

Input format: yyyy-MM-dd.

False

version

string

(Version of the document)

Which version of the document to share.† If empty, the official version will be shared.

False

download

boolean

(Download document)

If true, the document may be downloaded by the recipient.

False

notifyme

boolean

(Notify me)

If true, notify the sender when the secured link is accessed.

False

lock

boolean

(Lock document)

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

False

 

Returns:

††††††††† Type:CreateSecuredLinkResponse

 

GetDocHistory

Summary: Document history

Description: Retrieve a list of actions taken on a document

 

Syntax:

NetDocuments.GetDocHistory (string id, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Document ID)

12-digit document ID.

True

Accept

string

 

 

True

 

Returns:

 

CreateWorkspaceParentChild

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

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

 

Syntax:

NetDocuments.CreateWorkspaceParentChild (string cabinetID, string parentID, string childID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

cabinetID

string

(Cabinet ID)

(It starts with NG-)

True

parentID

string

(Parent Value)

The parent value used to define workspaces in the cabinet.

True

childID

string

(Child Value)

The child value used to define workspaces in the cabinet.

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:CreateWorkspaceParentChildResponse

 

CreateWorkspaceSingle

Summary: Get or create a workspace (with a single attribute)

Description: Get or create a workspace (with a single attribute)

 

Syntax:

NetDocuments.CreateWorkspaceSingle (string cabinetID, string parentID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

cabinetID

string

(Cabinet ID)

(It starts with NG-)

True

parentID

string

(Sole Value)

The sole value used to define workspaces in the cabinet.

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:CreateWorkspaceSingleResponse

 

GetWorkspaceInformation

Summary: Get workspace information

Description: Get workspace information

 

Syntax:

NetDocuments.GetWorkspaceInformation (string workspaceID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspaceID

string

(Workspace ID)

Workspace ID

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

CreateChildEntry

Summary: Create or update a child lookup table entry

Description: Create or update a child lookup table entry

 

Syntax:

NetDocuments.CreateChildEntry (string repositoryID, string childAttributeID, string parentID, string childID, [internal]string Accept, [internal]string Content-Type, LookupEntryBody LookupEntryBody)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(It starts with CA-)

True

childAttributeID

string

(Child attribute ID)

(Remove the leading '10')

True

parentID

string

(Parent key)

Parent key

True

childID

string

(Child key)

Child key

True

Accept

string

 

 

True

Content-Type

string

 

 

True

LookupEntryBody

LookupEntryBody

 

 

True

 

Returns:

††††††††† Type:CreateChildEntryResponse

 

GetChildEntry

Summary: Get a child lookup table entry

Description: Get a child lookup table entry

 

Syntax:

NetDocuments.GetChildEntry (string repositoryID, string childAttributeID, string parentID, string childID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(It starts with CA-)

True

childAttributeID

string

(Child attribute ID)

(Remove the leading '10')

True

parentID

string

(Parent key)

Parent key

True

childID

string

(Child key)

Child key

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:GetChildEntryResponse

 

DeleteChildEntry

Summary: Delete a child lookup table entry

Description: Delete a child lookup table entry

 

Syntax:

NetDocuments.DeleteChildEntry (string repositoryID, string childAttributeID, string parentID, string childID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(It starts with CA-)

True

childAttributeID

string

(Child attribute ID)

(Remove the leading '10')

True

parentID

string

(Parent key)

Parent key

True

childID

string

(Child key)

Child key

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:DeleteChildEntryResponse

 

CreateEntry

Summary: Create or update a lookup table entry

Description: Create or update a lookup table entry

 

Syntax:

NetDocuments.CreateEntry (string repositoryID, string attributeID, string parentID, [internal]string Accept, [internal]string Content-Type, LookupEntryBody LookupEntryBody)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(It starts with CA-)

True

attributeID

string

(Attribute ID)

(Remove the leading '10')

True

parentID

string

(Key)

Key

True

Accept

string

 

 

True

Content-Type

string

 

 

True

LookupEntryBody

LookupEntryBody

 

 

True

 

Returns:

††††††††† Type:CreateEntryResponse

 

GetLookupEntry

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

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

 

Syntax:

NetDocuments.GetLookupEntry (string repositoryID, string attributeID, string parentID, [advanced][Optional]string $filter, [advanced][Optional]string $select, [advanced][Optional]integer $skip, [advanced][Optional]integer $top, [advanced][Optional]string $orderby, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(It starts with CA-)

True

attributeID

string

(Attribute ID)

(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.)

True

parentID

string

(Key)

(To return a single value, enter the key of the single attribute, or to search for child entries enter the key of the parent.)

True

$filter

string

(Filter (only when searching))

(See the documentation for the available filters)

False

$select

string

(Fields to retrieve)

(Include comma-separated list of: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user', and/or 'access')

False

$skip

integer

(Number of matching records to skip)

(This is used when retrieving multiple blocks of results.)

False

$top

integer

(Maximum number of records to return)

Maximum number of records to return

False

$orderby

string

(Order results by)Values: [key, parent]

Order results by

False

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

DeleteLookupEntry

Summary: Delete a lookup table entry

Description: Delete a lookup table entry

 

Syntax:

NetDocuments.DeleteLookupEntry (string repositoryID, string attributeID, string parentID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(It starts with CA-)

True

attributeID

string

(Attribute ID)

(Remove the leading '10')

True

parentID

string

(Key)

Key

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:DeleteLookupEntryResponse

 

SearchLookupEntries

Summary: Search for lookup table entries

Description: Search for lookup table entries

 

Syntax:

NetDocuments.SearchLookupEntries (string repositoryID, string attributeID, [Optional]string $filter, [advanced][Optional]string $select, [advanced][Optional]integer $skip, [advanced][Optional]integer $top, [internal]string $orderby, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(It starts with CA-)

True

attributeID

string

(Attribute ID)

(Remove the leading '10')

True

$filter

string

(Filter)

(See the documentation for the available filters)

False

$select

string

(Fields to retrieve)

(Include comma-separated list of: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user', and/or 'access')

False

$skip

integer

(Number of matching records to skip)

(This is used when retrieving multiple blocks of results.)

False

$top

integer

(Maximum number of records to return)

Maximum number of records to return

False

$orderby

string

 

 

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:SearchLookupEntriesResponse

 

SearchCabinets

Summary: Search one or more cabinets

Description: Search one or more cabinets

 

Syntax:

NetDocuments.SearchCabinets (string cabinets, string q, string select, [Optional]string orderby, [advanced][Optional]integer top, [advanced][Optional]integer skip, [advanced][Optional]string skiptoken, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

cabinets

string

(Cabinets)

(comma-delimited)

True

q

string

(Query)

(Review the documentation for the query format)

True

select

string

(Information to return)

(Review the documentation for the return format)

True

orderby

string

(Order by)

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

False

top

integer

(Number of results to return (defaults to 50))

(Maximum 500 per page)

False

skip

integer

(Number of results to skip)

Number of results to skip

False

skiptoken

string

(Token used for paginating results)

Token used for paginating results

False

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

RefreshWorkspace

Summary: Refresh a workspace

Description: Refresh a workspace

 

Syntax:

NetDocuments.RefreshWorkspace (string workspaceID, [internal]string action, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspaceID

string

(Workspace ID)

Workspace ID

True

action

string

 

 

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

LockDocument

Summary: Lock document

Description: Lock document

 

Syntax:

NetDocuments.LockDocument (string id, [Optional]string comment, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Document ID)

Document iD

True

comment

string

(Comment)

Comment

False

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

UnockDocument

Summary: Unlock document

Description: Unock document

 

Syntax:

NetDocuments.UnockDocument (string id, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Document ID)

Document ID

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

GetRepositoryLog

Summary: Get repository log

Description: Get repository log

 

Syntax:

NetDocuments.GetRepositoryLog (string repositoryID, [internal]string format, [Optional]string start, [Optional]string end, string Logtype, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(Starts with CA-)

True

format

string

 

 

True

start

string

(Start date/time)

(Defaults to 30 days; format yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ)

False

end

string

(End date/time)

(Same format as start; defaults to today)

False

Logtype

string

(Log type)Values: [consolidated, admin]

Log type

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

GetRepositoryInformation

Summary: Get repository information

Description: Get repository information

 

Syntax:

NetDocuments.GetRepositoryInformation (string repositoryID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(Starts with CA-)

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

GetRepositoryUsers

Summary: Get repository users

Description: Get repository users

 

Syntax:

NetDocuments.GetRepositoryUsers (string repositoryID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(Starts with CA-)

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:array of (GetRepositoryUsersResponseItem)

 

GetRepositoryGroups

Summary: Get repository groups

Description: Get repository groups

 

Syntax:

NetDocuments.GetRepositoryGroups (string repositoryID, [Optional]string $filter, [advanced][Optional]string $top, [advanced][Optional]boolean paging, [advanced][Optional]string $skiptoken, [advanced][Optional]string returnInfo, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(It starts with CA-)

True

$filter

string

(Filter)

(See the documentation for filter criteria)

False

$top

string

(Number of results)

(Defaults to 5,000.† Maximum 10,000)

False

paging

boolean

(Paging)

(Return the results in pages; default is false)

False

$skiptoken

string

(Paging token)

(For paging purposes; returned by prior calls as 'next')

False

returnInfo

string

(Return info)Values: [all, ]

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

False

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:array of (string)

 

CreateRepositoryGroup

Summary: Create repository group

Description: Create a repository group

 

Syntax:

NetDocuments.CreateRepositoryGroup (string repositoryID, string name, boolean external, boolean hidden, boolean hideMembership, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(It starts with CA-)

True

name

string

(Group name)

Group name

True

external

boolean

(External)

External

True

hidden

boolean

(Hide in lists)

Hide in lists

True

hideMembership

boolean

(Hidden membership)

Hidden membership

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:CreateRepositoryGroupResponse

 

DeleteRepositoryGroup

Summary: Delete repository group

Description: Delete a repository group

 

Syntax:

NetDocuments.DeleteRepositoryGroup (string repositoryID, string groupID, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(It starts with CA-)

True

groupID

string

(Group ID)

(Starts with UG-)

True

Accept

string

 

 

True

 

Returns:

 

CreateUser

Summary: Create user

Description: Create a user in a repository

 

Syntax:

NetDocuments.CreateUser (string username, string displayFirstName, [Optional]string displayMiddleName, string displayLastName, string email, boolean external, boolean sendWelcome, string repository, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

username

string(email)

(Username)

(The same as the user's email address)

True

displayFirstName

string

(First name)

First name

True

displayMiddleName

string

(Middle name)

Middle name

False

displayLastName

string

(Last name)

Last name

True

email

string(email)

(Email address)

Email address

True

external

boolean

(User is external)

(Only applicable on add)

True

sendWelcome

boolean

(Send welcome email)

Send welcome email

True

repository

string

(Repository ID)

(Starts with CA-)

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:CreateUserResponse

 

AddOrRemoveUserRepository

Summary: Add user to or remove user from repository

Description: Add user to or remove user from repository

 

Syntax:

NetDocuments.AddOrRemoveUserRepository (string repositoryID, string action, string member, boolean external, [advanced][Optional]boolean deleteIfFederated, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryID

string

(Repository ID)

(Starts with CA-)

True

action

string

(Add or remove user)Values: [add, remove]

Add or remove user

True

member

string

(User ID)

User ID

True

external

boolean

(User is external)

User is external

True

deleteIfFederated

boolean

(Delete user (if federated))

(Only applicable on remove)

False

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

CreateCollabSpace

Summary: Create CollabSpace

Description: Create a new CollabSpace

 

Syntax:

NetDocuments.CreateCollabSpace (string workspaceID, string name, [internal]boolean sanitizeName, [Optional]string description, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspaceID

string

(Workspace ID)

Workspace ID

True

name

string

(CollabSpace name)

CollabSpace name

True

sanitizeName

boolean

 

 

True

description

string

(Description)

Description

False

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:CreateCollabSpaceResponse

 

GetCabinetSettings

Summary: Get cabinet settings

Description: Get cabinet settings

 

Syntax:

NetDocuments.GetCabinetSettings (string cabinetID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

cabinetID

string

(Cabinet ID)

(It starts with NG-)

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

GetCabinetInformation

Summary: Get cabinet information

Description: Get cabinet information

 

Syntax:

NetDocuments.GetCabinetInformation (string cabinetID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

cabinetID

string

(Cabinet ID)

(It starts with NG-)

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

GetCabinetCustomAttributes

Summary: Get cabinet custom attributes

Description: Get cabinet custom attributes

 

Syntax:

NetDocuments.GetCabinetCustomAttributes (string cabinetID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

cabinetID

string

(Cabinet ID)

(It starts with NG-)

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:array of (GetCabinetCustomAttributesResponseItem)

 

GetCabinetDefaultAccess

Summary: Get unhidden cabinet groups access rights

Description: Get unhidden cabinet groups access rights

 

Syntax:

NetDocuments.GetCabinetDefaultAccess (string cabinetID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

cabinetID

string

(Cabinet ID)

(It starts with NG-)

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:array of (GetCabinetDefaultAccessResponseItem)

 

AddToOrRemoveGroupFromCabinet

Summary: Add to or remove group from cabinet

Description: Add group to cabinet and default access rights

 

Syntax:

NetDocuments.AddToOrRemoveGroupFromCabinet (string cabinetID, string action, string id, boolean view, boolean edit, boolean share, boolean administer, boolean noAccess, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

cabinetID

string

(Cabinet ID)

(It starts with NG-)

True

action

string

(Add or remove group)Values: [add, remove]

Add or remove group

True

id

string

(Group ID)

Group ID (starts with UG-).

True

view

boolean

(View rights)

View rights (V) - Only for add.

True

edit

boolean

(Edit rights)

Edit rights (E) - Only for add.

True

share

boolean

(Share rights)

Share rights (S) - Only for add.

True

administer

boolean

(Administer rights)

Administer rights (A) - Only for add.

True

noAccess

boolean

(No access rights)

No access rights (N) - Only for add.

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

GetCabinetGroups

Summary: Get cabinet groups

Description: Get all of the groups added to a cabinet

 

Syntax:

NetDocuments.GetCabinetGroups (string cabinetID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

cabinetID

string

(Cabinet ID)

(It starts with NG-)

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:array of (GetCabinetGroupsResponseItem)

 

CreateCabinetExternalGroup

Summary: Create a cabinet external group

Description: Create a cabinet external group

 

Syntax:

NetDocuments.CreateCabinetExternalGroup (string cabinetID, string name, [Optional]string options, [Optional]string access, [advanced][Optional]string collaborationSpaceId, [advanced][Optional]string collaborationspaceaccess, [advanced][Optional]string topwsattributegroupkey, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

cabinetID

string

(Cabinet ID)

(It starts with NG-)

True

name

string

(Group name)

Group name

True

options

string

(Group options)Values: [hidden, hideMembership, hidden,hideMembership]

Group options

False

access

string

(Cabinet default access)Values: [0, 1, 1,2, 1,4, 1,2,4, 1,2,4,8]

Cabinet default access

False

collaborationSpaceId

string

(CollabSpace ID)

(To make this a CollabSpace-external group)

False

collaborationspaceaccess

string

(CollabSpace access)Values: [0, 1, 1,2, 1,4, 1,2,4, 1,2,4,8]

CollabSpace access

False

topwsattributegroupkey

string

(Top workspace attribute value)

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

False

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:CreateCabinetExternalGroupResponse

 

SearchCabinetModifyACLs

Summary: Search a cabinet and modify ACLs

Description: Search a cabinet and modify ACLs

 

Syntax:

NetDocuments.SearchCabinetModifyACLs (string cabinetID, [internal]string action, string q, string mode, string newAcl, [advanced][Optional]string email, [advanced][Optional]string completionEmail, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

cabinetID

string

(Cabinet ID)

(It starts with NG-)

True

action

string

 

 

True

q

string

(Query)

(Review the documentation for the query format)

True

mode

string

(Modify ACL mode)Values: [add, replace, remove]

Modify ACL mode

True

newAcl

string

(New ACL)

(Review the documentation for the proper json format)

True

email

string(email)

(Email address)

(Send notification to this address instead)

False

completionEmail

string

(Send completion emails)Values: [true, false, fail]

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

False

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

GetContainerContents

Summary: Get container contents

Description: Get the contents of the selected container

 

Syntax:

NetDocuments.GetContainerContents (string containerID, string select, [advanced][Optional]integer top, [advanced][Optional]string skiptoken, [advanced][Optional]string orderby, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

containerID

string

(Container ID)

Container ID

True

select

string

(Information to return)

(Review the documentation for the return format)

True

top

integer

(Number of results to return (defaults to 50))

(Maximum 500 per page)

False

skiptoken

string

(Token used for paginating results)

Token used for paginating results

False

orderby

string

(Order by)

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

False

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

GetGroupInformation

Summary: Get group information

Description: Get group information

 

Syntax:

NetDocuments.GetGroupInformation (string groupID, [advanced][Optional]boolean cabMembership, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupID

string

(Group ID)

Group ID (starts with UG-).

True

cabMembership

boolean

(Group cabinet membership)

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

False

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:GetGroupInformationResponse

 

GetGroupMembership

Summary: Get group membership

Description: Get group membership

 

Syntax:

NetDocuments.GetGroupMembership (string groupID, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupID

string

(Group ID)

(Starts with UG-)

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

††††††††† Type:array of (GetGroupMembershipResponseItem)

 

AddOrRemoveGroupMember

Summary: Add or remove group member

Description: Add or remove group member

 

Syntax:

NetDocuments.AddOrRemoveGroupMember (string groupID, string action, string member, [internal]string Accept, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupID

string

(Group ID)

(Starts with UG-)

True

action

string

(Add or remove the user)Values: [add, remove]

Add or remove the user

True

member

string

(User ID)

(Must be a member of the repository already.)

True

Accept

string

 

 

True

Content-Type

string

 

 

True

 

Returns:

 

Triggers:

Trigger SearchCab

Summary: Search cabinet

Description: Search the specified cabinet

 

Syntax:

NetDocuments.SearchCab (string cabId, string q, [advanced][Optional]string $orderby, [advanced][Optional]string $top, [Optional]string $select, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

cabId

string

(Cabinet ID)

(It starts with NG-)

True

q

string

(Search criteria)

Use the same format and operators as in the NetDocuments web interface.

True

$orderby

string

(Order by)Values: [relevance desc, lastMod desc, name asc, relevance asc, lastMod asc, name desc]

Order by

False

$top

string

(Maximum number of results)

An integer between 1 and 500.† Default is 100.

False

$select

string

(Attributes to return)

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

False

Accept

string

 

 

True

 

Returns:

 


 

CreateCabinetExternalGroupResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

Type

integer

 

 

Id

string

 

 

Name

string

 

 

Options

string

 

 

Access

string

 

 


 

CreateChildEntryResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

count

integer

 

 


 

CreateCollabSpaceResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

Id

string

 

 

EnvUrl

string

 

 


 

CreateDocumentResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

 

extension

string

 

 

name

string

 

 


 

CreateEntryResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

count

integer

 

 


 

CreateFolderResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

standardAttributes

StandardAttributes

 

 

 

StandardAttributes

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 

 


 

CreateRepositoryGroupResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

external

boolean

 

 

hidden

boolean

 

 

hideMembership

boolean

 

 

id

string

 

 

name

string

 

 


 

CreateSecuredLinkResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

standardAttributes

StandardAttributes

 

 

 

StandardAttributes

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

view

string

 

 

download

string

 

 

 


 

CreateUserResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

displayName

string

 

 

email

string(email)

 

 

id

string

 

 

external

boolean

 

 


 

CreateWorkspaceParentChildResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

standardAttributes

StandardAttributes

 

 

 

StandardAttributes

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

 

 


 

CreateWorkspaceSingleResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

standardAttributes

StandardAttributes

 

 

 

StandardAttributes

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

 

 


 

DeleteChildEntryResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

count

integer

 

 


 

DeleteLookupEntryResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

count

integer

 

 


 

file

Summary: Document Content

Description: The document in multi-part form.

 

††††††††† Properties:

Name

Type

Summary


 

GetCabinetCustomAttributesResponseItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary


 

GetCabinetDefaultAccessResponseItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

administer

boolean

 

 

cabDefault

boolean

 

 

edit

boolean

 

 

name

string

 

 

noAccess

boolean

 

 

principal

string

 

 

share

boolean

 

 

view

boolean

 

 


 

GetCabinetGroupsResponseItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

Id

string

 

 

Name

string

 

 

External

boolean

 

 

Hidden

boolean

 

 


 

GetChildEntryResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary


 

GetCurrentUserInfoResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

displayName

string

 

 

email

string(email)

 

 

id

string

 

 

organization

string

 

 

isRepositoryMember

boolean

 

 

primaryCabinet

string

 

 

sortLookupBy

string

 

 

external

boolean

 

 


 

GetGroupInformationResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

external

boolean

 

 

hidden

boolean

 

 

hideMembership

boolean

 

 

id

string

 

 

name

string

 

 

cabMembership

array of (CabMembershipItem)

 

 

 

CabMembershipItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 

rights

string

 

 

 


 

GetGroupMembershipResponseItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

displayName

string

 

 

id

string

 

 


 

GetRepositoryUsersResponseItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

displayName

string

 

 

email

string

 

 

external

boolean

 

 

id

string

 

 

lastLogin

string

 

 

registered

string

 

 


 

GetUserCabinetsResponseItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

 

isCollaborationSpacesEnabled

string

 

 

name

string

 

 

repositoryId

string

 

 

repositoryName

string

 

 

wsAttrNum

integer

 

 

wsOrgAttrNum

integer

 

 


 

GetUserInfoResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

displayName

string

 

 

email

string(email)

 

 

id

string

 

 

organization

string

 

 

isRepositoryMember

boolean

 

 

primaryCabinet

string

 

 

sortLookupBy

string

 

 

external

boolean

 

 


 

LookupEntryBody

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

description

string

Description

 

defaulting

string

Type

 

hold

boolean

Litigation Hold

 

closed

string

Closed Date

Format '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/'

access

Access

 

 

 

Access

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

filtered_permissions

boolean

Filtered permissions

 

force_permissions

boolean

Force permssions

 

permissions

array of (PermissionsItem)

 

 

 

PermissionsItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

view

boolean

View

 

edit

boolean

Edit

 

share

boolean

Share

 

administer

boolean

Administer

 

noAccess

boolean

No access

 

cabDefault

boolean

Cabinet default

 

principal

string

Principal

(User or group ID)

 


 

NewVersionResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

latestVersionNumber

integer

 

 

newVer

integer

 

 

newVersionLabel

string

 

 

officialVer

integer

 

 

officialVerName

string

 

 

versions

integer

 

 


 

RenameBody

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

standardAttributes

StandardAttributes

 

 

 

StandardAttributes

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

name

string

New name

 

 


 

SearchLookupEntriesResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

rows

array of (RowsItem)

 

 

 

RowsItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

defaulting

string

 

 

description

string

 

 

hold

boolean

 

 

key

string

 

 

closed

string

 

 

access

string