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.
EXEC CreateDocumentVersion File = 'C:/Users/Public/document2.docx', DocumentId = '514', CreateDraft = 'uploadedContent', Description = 'This is a description', suppressRendition = 'true'
Input
| Name | Type | Required | Accepts Input Streams | Description |
| DocumentId | String | True | False | The document id field value. |
| File | String | False | False | Optional. If createDraft=uploadedContent, use this parameter to include the new document source file. If your target document is a placeholder, use this parameter to upload a source file and create a new draft version of the document. |
| Content | String | False | True | Optional. Alternative to File. If createDraft=uploadedContent, use this parameter to set an InputStream as the new documents source. |
| FileName | String | False | False | The file name including extension to be used for File or Content input. FileName is optional for File input, and required for Content input. |
| CreateDraft | String | False | False | latestContent - Create a new draft version from the existing document in the vault. This does not require uploading a file. This is analogous to the Copy file from current version option in the Create Draft UI. uploadedContent - Create a new draft version by uploading the document source file. This requires uploading a new source file with an additional file body parameter. The maximum allowed file size is 4GB. This is analogous to the Upload a new file option in the Create Draft UI.
The allowed values are latestContent, uploadedContent. The default value is latestContent. |
| Description | String | False | False | Optional. Add a Version Description for the new draft version. Other users may view this description in the document's Version History. Maximum 1,500 characters. |
| SuppressRendition | String | False | False | Set to true to suppress automatic generation of the viewable rendition. If omitted, defaults to false.
The default value is false. |
Result Set Columns
| Name | Type | Description |
| ResponseStatus | String | Whether the document was created successfully. |
| ResponseMessage | String | The message of the response. |
| MajorVersionNumber | String | The major version number of the document. |
| MinorVersionNumber | String | The minor version number of the document. |