/netdocuments-admin | Type: Application | PCID required: Yes
Tools
netdocuments_admin_add_or_remove_group_member
Add or remove group member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupID | string | Yes | — | (Starts with UG-) |
action | string | Yes | — | Add or remove the user |
member | string | Yes | — | (Must be a member of the repository already.) |
netdocuments_admin_create_collab_space
Create CollabSpace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceID | string | Yes | — | Workspace ID |
name | string | Yes | — | CollabSpace name |
sanitizeName | boolean | Yes | — | Sanitize Name |
description | string | No | — | The description value |
netdocuments_admin_create_repository_group
Create repository group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repositoryID | string | Yes | — | (It starts with CA-) |
name | string | Yes | — | Group name |
external | boolean | Yes | — | The external value |
hidden | boolean | Yes | — | Hide in lists |
hideMembership | boolean | Yes | — | Hidden membership |
netdocuments_admin_create_workspace_parent_child
Get or create a workspace (with parent and child attributes) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cabinetID | string | Yes | — | (It starts with NG-) |
parentID | string | Yes | — | The parent value used to define workspaces in the cabinet. |
childID | string | Yes | — | The child value used to define workspaces in the cabinet. |
netdocuments_admin_create_workspace_single
Get or create a workspace (with a single attribute) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cabinetID | string | Yes | — | (It starts with NG-) |
parentID | string | Yes | — | The sole value used to define workspaces in the cabinet. |
netdocuments_admin_delete_repository_group
Delete repository group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repositoryID | string | Yes | — | (It starts with CA-) |
groupID | string | Yes | — | (Starts with UG-) |
netdocuments_admin_get_cabinet_custom_attributes
Get cabinet custom attributes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cabinetID | string | Yes | — | (It starts with NG-) |
netdocuments_admin_get_cabinet_groups
Get cabinet groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cabinetID | string | Yes | — | (It starts with NG-) |
netdocuments_admin_get_cabinet_information
Get cabinet information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cabinetID | string | Yes | — | (It starts with NG-) |
netdocuments_admin_get_cabinet_settings
Get cabinet settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cabinetID | string | Yes | — | (It starts with NG-) |
netdocuments_admin_get_current_user_info
Get current user info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cabGuid | string | No | — | (It starts with NG-) |
netdocuments_admin_get_group_information
Get group information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupID | string | Yes | — | Group ID (starts with UG-). |
cabMembership | boolean | No | — | (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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupID | string | Yes | — | (Starts with UG-) |
netdocuments_admin_get_repository_groups
Get repository groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repositoryID | string | Yes | — | (It starts with CA-) |
$filter | string | No | — | (See the documentation for filter criteria) |
$top | string | No | — | (Defaults to 5,000. Maximum 10,000) |
paging | boolean | No | — | (Return the results in pages; default is false) |
$skiptoken | string | No | — | (For paging purposes; returned by prior calls as ‘next’) |
returnInfo | string | No | — | all will return group names. Default is blank to return just IDs |
netdocuments_admin_get_repository_information
Get repository information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repositoryID | string | Yes | — | (Starts with CA-) |
netdocuments_admin_get_repository_log
Get repository log Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repositoryID | string | Yes | — | (Starts with CA-) |
format | string | Yes | — | The format value |
start | string | No | — | (Defaults to 30 days; format yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ) |
end | string | No | — | (Same format as start; defaults to today) |
Logtype | string | Yes | — | Log type |
netdocuments_admin_get_repository_users
Get repository users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repositoryID | string | Yes | — | (Starts with CA-) |
netdocuments_admin_get_user_cabinets
Get list of user cabinetsnetdocuments_admin_get_user_info
Get user info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The user ID assigned by NetDocuments. |
cabGuid | string | No | — | (It starts with NG-) |
netdocuments_admin_get_workspace_information
Get workspace information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceID | string | Yes | — | Workspace ID |
netdocuments_admin_refresh_workspace
Refresh a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceID | string | Yes | — | Workspace ID |
action | string | Yes | — | The action value |

