Download RIS document
rillsoft_document_ris_getDownload a document from the open Rillsoft project's document management to a specified local path. Existing files are refused unless overwrite is true; failures leave no partial file.
Instructions
Downloads one document of the open project from the document management of the Rillsoft Integration Server into a local file - the 'Download' button of the documents page, with the target path given instead of asked. An existing file at path is refused unless overwrite:true; on any failure no partial file is left behind. The document itself is not changed; rillsoft_document_ris_list names the ids. Runs with the login of the desktop session. No undo step.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | absolute path of the file to write, including the file name; the file is written, not opened | |
| overwrite | No | true = replace a file that already exists at path | |
| documentId | Yes | id of the document, from rillsoft_document_ris_list |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | file name of the document | |
| path | Yes | path of the file that was written | |
| uuid | Yes | UUID of the element the document hangs on - a task, a subproject or the project itself | |
| fileSize | Yes | size of the stored file in bytes | |
| folderId | Yes | id of the DMS folder the document lies in | |
| createdAt | Yes | time the document was stored, DD.MM.YYYY hh:mm; empty when the server reports none | |
| projectId | Yes | id of the project the document belongs to | |
| documentId | Yes | id of the document on the server; what _get, _update and _delete take | |
| folderPath | Yes | names of the DMS folders from the root, joined by ' / '; empty when the folder is unknown to the tree | |
| description | Yes | description; empty when none is set | |
| elementName | Yes | name of that element | |
| bytesWritten | Yes | bytes written to that file | |
| createdUserName | Yes | user who stored it; empty when the server reports none |