Skip to main content
Server path: /netdocuments-admin | Type: Application | PCID required: Yes

Tools


netdocuments_admin_add_or_remove_group_member

Add or remove group member Parameters:
ParameterTypeRequiredDefaultDescription
groupIDstringYes(Starts with UG-)
actionstringYesAdd or remove the user
memberstringYes(Must be a member of the repository already.)

netdocuments_admin_create_collab_space

Create CollabSpace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIDstringYesWorkspace ID
namestringYesCollabSpace name
sanitizeNamebooleanYesSanitize Name
descriptionstringNoThe description value

netdocuments_admin_create_repository_group

Create repository group Parameters:
ParameterTypeRequiredDefaultDescription
repositoryIDstringYes(It starts with CA-)
namestringYesGroup name
externalbooleanYesThe external value
hiddenbooleanYesHide in lists
hideMembershipbooleanYesHidden membership

netdocuments_admin_create_workspace_parent_child

Get or create a workspace (with parent and child attributes) Parameters:
ParameterTypeRequiredDefaultDescription
cabinetIDstringYes(It starts with NG-)
parentIDstringYesThe parent value used to define workspaces in the cabinet.
childIDstringYesThe child value used to define workspaces in the cabinet.

netdocuments_admin_create_workspace_single

Get or create a workspace (with a single attribute) Parameters:
ParameterTypeRequiredDefaultDescription
cabinetIDstringYes(It starts with NG-)
parentIDstringYesThe sole value used to define workspaces in the cabinet.

netdocuments_admin_delete_repository_group

Delete repository group Parameters:
ParameterTypeRequiredDefaultDescription
repositoryIDstringYes(It starts with CA-)
groupIDstringYes(Starts with UG-)

netdocuments_admin_get_cabinet_custom_attributes

Get cabinet custom attributes Parameters:
ParameterTypeRequiredDefaultDescription
cabinetIDstringYes(It starts with NG-)

netdocuments_admin_get_cabinet_groups

Get cabinet groups Parameters:
ParameterTypeRequiredDefaultDescription
cabinetIDstringYes(It starts with NG-)

netdocuments_admin_get_cabinet_information

Get cabinet information Parameters:
ParameterTypeRequiredDefaultDescription
cabinetIDstringYes(It starts with NG-)

netdocuments_admin_get_cabinet_settings

Get cabinet settings Parameters:
ParameterTypeRequiredDefaultDescription
cabinetIDstringYes(It starts with NG-)

netdocuments_admin_get_current_user_info

Get current user info Parameters:
ParameterTypeRequiredDefaultDescription
cabGuidstringNo(It starts with NG-)

netdocuments_admin_get_group_information

Get group information Parameters:
ParameterTypeRequiredDefaultDescription
groupIDstringYesGroup ID (starts with UG-).
cabMembershipbooleanNo(If set to ‘true’ the cabinets this groups is a member of and the default document access rights for each cabinet will be included.)

netdocuments_admin_get_group_membership

Get group membership Parameters:
ParameterTypeRequiredDefaultDescription
groupIDstringYes(Starts with UG-)

netdocuments_admin_get_repository_groups

Get repository groups Parameters:
ParameterTypeRequiredDefaultDescription
repositoryIDstringYes(It starts with CA-)
$filterstringNo(See the documentation for filter criteria)
$topstringNo(Defaults to 5,000. Maximum 10,000)
pagingbooleanNo(Return the results in pages; default is false)
$skiptokenstringNo(For paging purposes; returned by prior calls as ‘next’)
returnInfostringNoall will return group names. Default is blank to return just IDs

netdocuments_admin_get_repository_information

Get repository information Parameters:
ParameterTypeRequiredDefaultDescription
repositoryIDstringYes(Starts with CA-)

netdocuments_admin_get_repository_log

Get repository log Parameters:
ParameterTypeRequiredDefaultDescription
repositoryIDstringYes(Starts with CA-)
formatstringYesThe format value
startstringNo(Defaults to 30 days; format yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ)
endstringNo(Same format as start; defaults to today)
LogtypestringYesLog type

netdocuments_admin_get_repository_users

Get repository users Parameters:
ParameterTypeRequiredDefaultDescription
repositoryIDstringYes(Starts with CA-)

netdocuments_admin_get_user_cabinets

Get list of user cabinets

netdocuments_admin_get_user_info

Get user info Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe user ID assigned by NetDocuments.
cabGuidstringNo(It starts with NG-)

netdocuments_admin_get_workspace_information

Get workspace information Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIDstringYesWorkspace ID

netdocuments_admin_refresh_workspace

Refresh a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIDstringYesWorkspace ID
actionstringYesThe action value