Interfaces
List of Vault API interfaces
NamedACLsOperations
Name | Description |
---|---|
GetNamedACLs | Gets all named ACLs (replaces 'current user' with the calling user). |
NamedValueStorageOperations
Name | Description |
---|---|
GetNamedValues | Reads the named values with the given namespace from the vault. |
RemoveNamedValues | Removes the given named values from the vault. |
SetNamedValues | Stores the named values to the vault. |
ObjectOperations
Name | Description |
---|---|
AddObjectFile | Adds new document file to a document. |
AddObjectWithFiles | Adds a new object with files. |
ChangeSecurity | Changes the security settings of an object. |
CheckInMultiple | Checks in one or more objects. |
CheckOutMultiple | Checks out one or more objects. |
DestroyObjects | Destroys objects. |
FollowObject | Starts or stops following the specified object. While the object is being followed, the current user will be notified if the object changes. |
GetAutomaticMetadata | Fetches automatic metadata. |
GetDocEventSubscriptions | Gets the event subscriptions of a document (for the current user). |
GetObjectDataOfMultipleObjects | Gets requested information about the specified objects. |
GetObjIDByGUID | Gets the Object ID of the object that is identified by the specified Object GUID. |
GetTemplates | Gets the templates. Note: In the template object the icon and additional classes property are passed as null / empty value for now. This will be handled in future. |
GetWorkflowsForClient | Gets all the workflows in a format suitable for client. |
GetWorkflowStatesAndTransitions | Gets the states and transitions of the given workflow. |
PromoteUnmanagedObject | Promote unmanaged objects to managed. |
RemoveObjectFile | Removes a file from a document. |
RemoveObjects | Removes objects i.e. marks them deleted. |
RenameObjectFile | Renames a document file. |
SetObjectLevelProperty | Sets an object-level property. |
SetPropertiesMultiple | If the object is currently checked in, a new checked-in version is created. If the object is currently checked out, the changes are applied to the checked-out version. |
UndoCheckoutMultiple | Undoes the checkout of one or more objects. |
UploadExistingFiles | Creates temporary copies of existing files accessible via upload ids. |
ObjectTypesOperations
Name | Description |
---|---|
GetObjectTypes | Gets object types (basic data such as IDs and names). |
PropertyDefsOperations
Name | Description |
---|---|
GetObjectClassesAndGroups | Gets all object classes and groups. |
GetPropertyDefs | Gets all property definitions. |
SearchOperations
Name | Description |
---|---|
GetFolderContents | Gets the contents of the specified folder. |
SearchObjects | Searches the document vault for objects that match the given conditions. |
ValueListsOperations
Name | Description |
---|---|
GetValueListItemsWithPermissions | Gets items contained in a given value list, the permissions of the items are included. |
GetValueLists | Gets value lists. |
SearchValueListItemsWithPermissions | Searches for value list items, the permissions of the items are included. |
VaultOperations
Name | Description |
---|---|
GetMetadataStructureItemIdByAlias | Gets metadata structure item ID by alias. |
VaultExtensionMethodsOperations
Name | Description |
---|---|
IsExtensionMethodAvailable | Is the specified vault extension method available. |
RunExtensionMethod | Runs the specified vault extension method. Prefer this method over 'ExecuteExtensionMethod' and 'ExecuteExtensionMethodEx' methods. |
ViewsOperations
Name | Description |
---|---|
DeleteView | Deletes the specified view from the user's view collection. |
GetViews | Returns the user's view collection (common views and user-specific views). |