Skip to main content

Interfaces

List of Vault API interfaces

NamedACLsOperations

NameDescription
GetNamedACLsGets all named ACLs (replaces 'current user' with the calling user).

NamedValueStorageOperations

NameDescription
GetNamedValuesReads the named values with the given namespace from the vault.
RemoveNamedValuesRemoves the given named values from the vault.
SetNamedValuesStores the named values to the vault.

ObjectOperations

NameDescription
AddObjectFileAdds new document file to a document.
AddObjectWithFilesAdds a new object with files.
ChangeSecurityChanges the security settings of an object.
CheckInMultipleChecks in one or more objects.
CheckOutMultipleChecks out one or more objects.
DestroyObjectsDestroys objects.
FollowObjectStarts or stops following the specified object. While the object is being followed, the current user will be notified if the object changes.
GetAutomaticMetadataFetches automatic metadata.
GetDocEventSubscriptionsGets the event subscriptions of a document (for the current user).
GetObjectDataOfMultipleObjectsGets requested information about the specified objects.
GetObjIDByGUIDGets the Object ID of the object that is identified by the specified Object GUID.
GetTemplatesGets 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.
GetWorkflowsForClientGets all the workflows in a format suitable for client.
GetWorkflowStatesAndTransitionsGets the states and transitions of the given workflow.
PromoteUnmanagedObjectPromote unmanaged objects to managed.
RemoveObjectFileRemoves a file from a document.
RemoveObjectsRemoves objects i.e. marks them deleted.
RenameObjectFileRenames a document file.
SetObjectLevelPropertySets an object-level property.
SetPropertiesMultipleIf 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.
UndoCheckoutMultipleUndoes the checkout of one or more objects.
UploadExistingFilesCreates temporary copies of existing files accessible via upload ids.

ObjectTypesOperations

NameDescription
GetObjectTypesGets object types (basic data such as IDs and names).

PropertyDefsOperations

NameDescription
GetObjectClassesAndGroupsGets all object classes and groups.
GetPropertyDefsGets all property definitions.

SearchOperations

NameDescription
GetFolderContentsGets the contents of the specified folder.
SearchObjectsSearches the document vault for objects that match the given conditions.

ValueListsOperations

NameDescription
GetValueListItemsWithPermissionsGets items contained in a given value list, the permissions of the items are included.
GetValueListsGets value lists.
SearchValueListItemsWithPermissionsSearches for value list items, the permissions of the items are included.

VaultOperations

NameDescription
GetMetadataStructureItemIdByAliasGets metadata structure item ID by alias.

VaultExtensionMethodsOperations

NameDescription
IsExtensionMethodAvailableIs the specified vault extension method available.
RunExtensionMethodRuns the specified vault extension method. Prefer this method over 'ExecuteExtensionMethod' and 'ExecuteExtensionMethodEx' methods.

ViewsOperations

NameDescription
DeleteViewDeletes the specified view from the user's view collection.
GetViewsReturns the user's view collection (common views and user-specific views).