Copy API¶

Copies an existing document or folder to the specified destination path. The copy is placed inside the destination folder under the name derived from DestinationPath. Both documents and folders are supported; the source path is resolved as a document first, and as a folder if no document is found.

Endpoint¶

/srv.asmx/Copy

Methods¶

• GET /srv.asmx/Copy?authenticationTicket=...&SourcePath=...&DestinationPath=...

• POST /srv.asmx/Copy (form data)

• SOAP Action: http://tempuri.org/Copy

Parameters¶

DestinationPath Formats¶

The DestinationPath parameter controls both where the copy is placed and what it is named.

Response¶

Success Response¶

<root success="true" />

Folder Copy -" Partial-failure Response¶

When copying a folder, individual sub-item errors are logged. If any errors occurred the response includes the log:

<Response success="false" error="[log]">

  <item path="/Finance/Reports/locked.pdf" error="Document is locked by another user." />

</Response>

Error Response¶

<root success="false" error="Source: Folder not found" />

<root success="false" error="Destination: Folder not found" />

Error messages are prefixed with Source: or Destination: to indicate which path caused the problem.

Required Permissions¶

• The caller must be an authenticated user with a valid ticket.

• Read access is required on the source document or folder.

• Create Document (or Create Folder) permission is required in the destination folder.

• Copying a document with Confidential or higher classification level requires the caller to have the corresponding classification clearance in the destination domain.

• The destination folder must not have a cutoff date. A folder with any cutoff date, past or future, accepts no new documents or subfolders.

Example¶

GET Request -" Copy a Document¶

GET /srv.asmx/Copy?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301&SourcePath=/Finance/Reports/Q1Report.pdf&DestinationPath=/Finance/Archive/Q1Report_v2.pdf HTTP/1.1

GET Request -" Copy a Document to Folder by ID¶

GET /srv.asmx/Copy?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301&SourcePath=/Finance/Reports/Q1Report.pdf&DestinationPath=~F4201 HTTP/1.1

GET Request -" Copy a Folder¶

GET /srv.asmx/Copy?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301&SourcePath=/Finance/Reports&DestinationPath=/Finance/Archive/Reports HTTP/1.1

POST Request¶

POST /srv.asmx/Copy HTTP/1.1

Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

&SourcePath=/Finance/Reports/Q1Report.pdf

&DestinationPath=/Finance/Archive/Q1Report_copy.pdf

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

               xmlns:tns="http://tempuri.org/">

  <soap:Body>

    <tns:Copy>

      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>

      <tns:SourcePath>/Finance/Reports/Q1Report.pdf</tns:SourcePath>

      <tns:DestinationPath>/Finance/Archive/Q1Report_copy.pdf</tns:DestinationPath>

    </tns:Copy>

  </soap:Body>

</soap:Envelope>

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  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;
}

Copies a document or a folder. Like Move, DestinationPath is the full new path of the copy, not the folder to put it in: copying /a/Q1.pdf into /b means /b/Q1.pdf.

await call('Copy', {
  authenticationTicket: ticket,
  SourcePath: '/Finance/Reports/Q1.pdf',
  DestinationPath: '/Finance/Archive/Q1.pdf'
});

A folder is copied with everything under it. The original is left where it was - that is the only difference from Move.

A successful copy carries no errorCode at all, where most operations report errorCode="0". This is G5 in the defect log, left as it is. A client reading errorCode before checking success sees nothing and must not treat that as a failure.

"It is already there" does not have one code in this family. AddToDownloadQueue reports it as 4000, AddToFavorites as 4090, Copy as 4000 and CreateDocumentShortcut as 4090. Branch on the operation, not on a shared rule.

Notes¶

• Access list. A copied item that was taking its parent's list takes the list of the folder it is copied into; one with a list of its own keeps it, and what is copied under a folder follows the folder's as it did. From 9.0 a copy is one security history entry, on the new folder or document, made by the user copying: at the library it counts everything copied under it (GetSecurityChangeLog). A copied item that keeps a list of its own gets an entry with that list; one that follows its new folder's list gets none, as its history is the folder's. Until 9.0 a copy wrote no security history at all.

• infoRouter Connect. A copied document is queued for whatever the destination folder's AI preferences ask for (SetFolderAIPreferences), as an upload into that folder would be - less what the copy already carries. The copy keeps the source's AI results and its AIEnhanced flags and AIExtractConfidence, so a summary the source already has is not asked for again. Copying a folder does this for each of its documents.

• The source path is resolved as a document first. If no document is found at SourcePath, it is resolved as a folder.

• When using a full DestinationPath, the parent folder of that path must already exist. The copy operation does not create intermediate folders.

• When using the ~F<folderId> short format, the copy retains the original source name. The ~F prefix is case-insensitive.

• Copying a document creates a new independent document -" changes to the copy do not affect the original.

• For folder copies, all accessible sub-folders and documents are recursively copied. Items that cannot be copied (e.g. due to permissions or locks) are skipped and reported in the response log rather than failing the entire operation.

• The DestinationPath parent folder for a document copy is derived by stripping the last path segment. For example, /Finance/Archive/Q1Report_copy.pdf -' destination folder /Finance/Archive/, new name Q1Report_copy.pdf.

• To rename the copy, provide a different file name in DestinationPath. To keep the original name, point DestinationPath to the target folder using the ~F<folderId> format.

Related APIs¶

• Move - Move a document or folder to a different path

• CreateDocumentShortcut - Create a shortcut to a document instead of a full copy

• GetDocument - Retrieve properties of a document

• GetFolder - Retrieve properties of a folder

Error Codes¶

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