UploadZip API¶

Imports a ZIP archive as a folder and document structure into the specified folder.

Endpoint¶

/srv.asmx/UploadZip

Methods¶

• POST /srv.asmx/UploadZip (form data)
• SOAP Action: http://tempuri.org/UploadZip

Parameters¶

Response¶

Success¶

<root success="true">
  <logs />
</root>

The <logs> element is empty on a fully successful import. Log entries are only written for items that could not be processed.

Failure¶

When the ZIP extraction or import fails, success="false" is returned. The <logs> element contains an entry for each item that could not be processed:

<root success="false">
  <logs>
    <log><item>upload.zip</item><error>Unzip operation failed: invalid ZIP format</error></log>
  </logs>
</root>

Error (authentication or folder not found)¶

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

Required Permissions¶

• User must be authenticated.
• Caller must have document creation permission on the destination folder.
• If the folder rule DisallowNewDocument is set, the import will be rejected.

Example Requests¶

Request (POST)¶

POST /srv.asmx/UploadZip HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=abc123&folderPath=/MyDomain/Imports&zipContent=<base64-encoded-zip>&changedOnly=true&checkOutCheckIn=true&sendEmail=false

Request (SOAP 1.1)¶

POST /srv.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/UploadZip"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UploadZip xmlns="http://tempuri.org/">
      <authenticationTicket>abc123</authenticationTicket>
      <folderPath>/MyDomain/Imports</folderPath>
      <zipContent><!-- Base64-encoded ZIP bytes --></zipContent>
      <changedOnly>true</changedOnly>
      <checkOutCheckIn>true</checkOutCheckIn>
      <sendEmail>false</sendEmail>
    </UploadZip>
  </soap:Body>
</soap:Envelope>

Error Codes¶

The errorCode values this operation returns, checked against a running server:

JavaScript¶

// Anything carrying bytes is POST-only: a byte[] cannot be bound from a query string, and a GET is
// answered HTTP 415 before the operation runs.
async function post(action, fields) {
  const response = await fetch(`/srv.asmx/${action}`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
    body: new URLSearchParams({ authenticationTicket: ticket, ...fields })
  });

  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml').documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

const base64 = bytes => btoa(String.fromCharCode(...bytes));

await post('UploadZip', {
  folderPath: '/Finance/Reports',
  zipContent: base64(zipBytes),
  changedOnly: 'false',
  checkOutCheckIn: 'false',
  sendEmail: 'false'
});

The archive is unpacked into the folder, keeping the paths inside it - so a zip holding reports/Q1.pdf produces a reports folder. changedOnly skips entries whose content matches what is already there, checkOutCheckIn checks documents out and back in around each write, and sendEmail notifies subscribers.

The answer's root element is <root>, not the <response> almost every other operation returns, and what could not be unpacked is listed inside <logs>.

Notes¶

• The ZIP archive's internal folder structure is recreated under the destination folder. Subfolders in the archive become subfolders in infoRouter.
• changedOnly=true implicitly enables checkOutCheckIn behavior.
• The following parameters are always applied with system defaults during import: classification level (NoMarkings), importance (0), retention schedule (none), declassify/downgrade dates (none).
• The response <log> children are always emitted regardless of success or failure and describe each item processed during import.

Related APIs¶

• GetFoldersAndDocuments — Browse folder contents to find the destination folder ID
• UploadDocument — Upload a single document
• CreateFolder — Create a subfolder manually before importing