UploadDocument API¶

Uploads a new document or creates a new version of an existing document at the specified path using a raw byte array. If no document exists at the path, a new document is created. If a document already exists, a new version is added. This is the base upload method; use numbered variants (UploadDocument1 through UploadDocument4) for additional options such as version comments, post-upload checkout, and extended XML parameters.

Endpoint¶

/srv.asmx/UploadDocument

Methods¶

• GET /srv.asmx/UploadDocument?authenticationTicket=...&path=...&fileContent=...
• POST /srv.asmx/UploadDocument (form data -" recommended for binary content)
• SOAP Action: http://tempuri.org/UploadDocument

Parameters¶

Response¶

Success Response¶

<root success="true" DocumentId="12345" VersionId="1000001" />

Error Response¶

<root success="false" error="[901] Session expired or Invalid ticket" />

Required Permissions¶

The calling user must have write (upload) permission on the destination folder.

Example¶

POST Request (recommended for binary files)¶

POST /srv.asmx/UploadDocument HTTP/1.1
Content-Type: multipart/form-data; boundary=----FormBoundary

------FormBoundary
Content-Disposition: form-data; name="authenticationTicket"

3f2504e0-4f89-11d3-9a0c-0305e82c3301
------FormBoundary
Content-Disposition: form-data; name="path"

/Finance/Reports/Q1-2024-Report.pdf
------FormBoundary
Content-Disposition: form-data; name="fileContent"; filename="Q1-2024-Report.pdf"
Content-Type: application/octet-stream

[binary file content]
------FormBoundary--

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:UploadDocument>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:path>/Finance/Reports/Q1-2024-Report.pdf</tns:path>
      <tns:fileContent>JVBERi0xLjQ...</tns:fileContent>
    </tns:UploadDocument>
  </soap:Body>
</soap:Envelope>

Notes¶

• For large files, use the chunked upload approach: CreateUploadHandler -' UploadFileChunk (repeat) -' UploadDocumentWithHandler.
• The file extension in path determines the document's MIME type and thumbnail behavior.
• If a document already exists at the path, a new version is created automatically. The document ID remains the same.
• The folder path component of path must already exist. Use CreateFolder to create missing folders first.
• For uploads with version comments, use UploadDocument1. For post-upload checkout, use UploadDocument2. For all options in XML, use UploadDocument4.

Related APIs¶

• UploadDocument1 - Upload with a version comment
• UploadDocument2 - Upload with post-upload checkout option
• UploadDocument3 - Upload with version comment and checkout
• UploadDocument4 - Upload with extended XML parameters
• CreateUploadHandler - Create a handler for large chunked uploads
• UploadFileChunk - Upload a single chunk to a handler
• UploadDocumentWithHandler - Finalize a chunked upload

Error Codes¶