Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Vault CRM.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Vault CRM, along with an indication of whether the procedure succeeded or failed.

CData Power BI Connector for Vault CRM Stored Procedures


Name	Description
AddDocumentRendition	Add a new Rendition to the given documents
AddDocumentToBinder	Add a document to a binder.
CancelJobs	Cancels one or more Vault jobs that are queued or scheduled to run.
CreateBinder	Create The name of the new document.
CreateDocument	Create a single document.
CreateDocumentVersion	Add a new draft version of an existing document. You can choose to either use the existing source file, or a new source file. These actions will increase the document's minor version number. This is analogous to using the Create Draft action in the UI. Note that not all documents are eligible for draft creation. For example, you cannot create a draft of a checked out document.
CreateFileStagingItem	Create a file or folder in the Vault file staging area. Set Type to 'folder' to create a directory, or 'file' to upload a local file.
CreateSchema	Creates a schema file for the specified table or view.
DeleteFileStagingItem	Delete a file or folder from the Vault file staging area. The operation is asynchronous: Vault returns a job id immediately, and the driver polls the job until it completes.
DownloadDirectDataFilePart	Download the specified Direct Data file. You can use the GetDirectDataFiles stored procedure to retrieve a list of available files.
DownloadDocumentFile	Download a document file.
DownloadDocumentRendition	Download a rendition file from the latest version of a document.
DownloadFileStagingItem	Download a file from the Vault file staging area to a local path or output stream.
ExportAttachmentFieldFiles	Exports files stored in Attachment fields for one or more records in the given Vault object.
ExportDocuments	Exports one or more documents to the Vault File Staging Server.
ExportDocumentVersions	Exports specific document versions to the Vault File Staging Server.
GetDeletedAttachments	Retrieve IDs of document or object attachments deleted within a 30 days range.
GetDirectDataFiles	Retrieve a list of all Direct Data files available for download. You can use the DownloadDirectDataFilePart stored procedure to download available files.
GetDocumentRenditions	Retrieve the Links of available renditions for the given document
GetDocumentRenditionTypes	Retrieve the Links of available renditions for the given document
GetDocumentText	Retrieve the plain text of a specific document version. If DocumentMajorVersion and DocumentMinorVersion are not specified, the text for the latest stable document version will be retrieved
GetDocumentWorkflowDetails	Retrieves the details for a specific document workflow.
GetOAuthAccessToken	Gets the OAuth access token from the Azure AD Authentication Provider.
GetOAuthAuthorizationURL	Gets the Azure AD authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to the Azure AD Authentication Provider.
GetObjectWorkflowActionDetails	Retrieve details about a workflow action. For example, the prompts needed to complete a workflow action.
GetObjectWorkflowActions	Retrieve all available workflow actions that can be initiated on a specific object workflow.
GetObjectWorkflows	Retrieve the workflows of an object given the ObjectName and RecordId
GetObjectWorkflowTaskActionDetails	Retrieve the details of a specific workflow task action. The response lists the details of the task action, including all fields required to initiate the action. Note that task actions where esignature is true cannot be initiated via the API.
GetObjectWorkflowTaskActions	Retrieve all available workflow actions that can be initiated on a specific object workflow.
GetObjectWorkflowTasks	Retrieve the workflows of an object given the ObjectName and RecordId
InitiateDocumentWorkflow	Initiate a document workflow on a set of documents.
InitiateObjectWorkflowAction	Initiate a workflow action on a specific workflow.
InitiateObjectWorkflowTaskAction	Initiate a workflow Task action on a specific workflow action, such as complete, cancel the workflow task etc.
ListFileStagingItems	List the files and folders at the specified path in the Vault file staging area.
RefreshOAuthAccessToken	Refreshes the OAuth access token used for authentication with the Azure AD Authentication Provider.
RemoveDocumentFromBinder	Add a document to a binder.
ReplaceDocumentRendition	Replace the rendition of the given document with a new one
UpdateFileStagingItem	Rename or move a file or folder in the Vault file staging area. At least one of Name or ParentPath must be specified. The operation is asynchronous: Vault returns a job id immediately, and the driver polls the job until it completes.
UploadLargeFileStagingItem	Upload a large file to the Vault file staging area using a resumable multi-part upload session. The procedure initiates an upload session, uploads the file in configurable parts, commits the session, and polls the resulting job until it completes. Use this procedure for files larger than 50 MB.