Stored Procedures
Stored procedures are function-like interfaces that extend the functionality of the add-in beyond simple SELECT/INSERT/UPDATE/DELETE 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 Excel Add-In for Vault CRM Stored Procedures
| Name | Description |
| AddDocumentRendition | Add a new Rendition to the given documents |
| AddDocumentToBinder | Add a document to a binder. |
| 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. |
| CreateSchema | Creates a schema file for the specified table or view. |
| DownloadDocumentFile | Download a document file. |
| DownloadDocumentRendition | Download a rendition file from the latest version of a document. |
| GetDeletedAttachments | Retrieve IDs of document or object attachments deleted within a 30 days range. |
| 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. |
| 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 |
| UpdateDocument | Update editable field values on the latest version of a single document. Deprecated - Perform Update on Documents table instead. |