Update RIS document
rillsoft_document_ris_updateUpdate a document's description, DMS folder, or content in Rillsoft Project's document management. Requires modify role; changes apply immediately.
Instructions
Changes the description, the DMS folder and/or the content of one document in the document management of the Rillsoft Integration Server - editing the description in the list, dragging it into a folder and the 'Upload' button of the documents page. At least one of description, folderId and path is required; the element the document hangs on cannot be changed (delete and attach again). Replacing the content with path is destructive: the stored file is overwritten and its name follows the new file. Takes effect on the server at once - no undo step, the project itself is not marked as changed. Without a path and without a difference nothing is sent. Runs with the login of the desktop session; needs the modify role.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | absolute path of a local file whose content replaces the stored file; the document takes that file's name | |
| folderId | No | id of the DMS folder to move the document into | |
| documentId | Yes | id of the document, from rillsoft_document_ris_list | |
| description | No | new description |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | file name of the document | |
| note | No | hints of the product path; missing when there were none | |
| 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 | |
| createdUserName | Yes | user who stored it; empty when the server reports none |