Documentation Index

Check out document to file system

To check out a document to file system POST CheckInActionParameters to the checkoutDocument link in the document. You will recive a CheckOutResult, which contains link for downloading the first section of the document. The name of the downloaded file contains information about the checked out document in specific format(*).

Check in document from file system

Way 1: Check in the file directly.

To check in the file in Docuware you can use checkInFromFileSystem link in the document. You must POST the file and the verison information (e.g version number , version comment) in a single request. The message body must be encoded using “multipart/form-data”.

The first part of the form data must have a media type of “application/xml”, “application/json”, “text/xml”, “text/json” or “application/*+xml” and contains the new version information , which is a CheckInActionParameters element. The second part is the file itself.

Way 2: Upload the document to basket.

When you upload a document to document tray using “documents” link of the document tray, and you set checkFileNameForCheckinInfo parameter to true, the system will check if its file name matches the specific file name format. If so, the server will link the uploaded file with the encoded document entity in a way as this document has been checked out to the basket directly.

(*)Check in/out file name format

  1. The file name starts with the document id encoded as decimal number.
  2. The next character is a plus sign (+).
  3. The next part is the id of the file cabinet. It is formatted as string which contains only characters a-f and digits and dashes ('-'). More specifiy, it is a GUID using the following pattern: 00000000-0000-0000-0000-000000000000.
  4. The next character is a plus sign (+).
  5. Optionally the document name can follow. The document name must consist only of the following characters. Any character not matching these rules is not allowed and must be replaced with an underscore (_).
  6. Each character of the Unicode class letter is allowed.
  7. Any digit (0-9) is allowed.
  8. The white space character with the code 32 is allowed. Also the underscore (_) is allowed.
  9. The file name ends with the file extension, beginning with a period.
  10. The file name length, including the extension, does not exceed 80 characters.