CreateFolder API¶

Creates a folder at the specified path. Multiple sub-folders can be created in a single call by providing a full path. The top-level folder (domain/library) must already exist -" this API cannot create root-level libraries.

Endpoint¶

/srv.asmx/CreateFolder

Methods¶

• GET /srv.asmx/CreateFolder?authenticationTicket=...&Path=...
• POST /srv.asmx/CreateFolder (form data)
• SOAP Action: http://tempuri.org/CreateFolder

Parameters¶

Response¶

Success Response¶

<response success="true" FolderId="456" FolderName="2024" />

Error Response¶

<response error="Folder not found." />

Required Permissions¶

The calling user must have create subfolder permission on the parent folder.

Example¶

GET Request¶

GET /srv.asmx/CreateFolder
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &Path=/Finance/Reports/2024
HTTP/1.1

POST Request¶

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&Path=/Finance/Reports/2024

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:CreateFolder>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:Path>/Finance/Reports/2024</tns:Path>
    </tns:CreateFolder>
  </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;
}

Creates one folder, named by its full path.

It creates the folders above it as well. The parent is resolved with path creation switched on, so a path whose parent does not exist is not refused - the whole chain is created and the response reports the leaf. If a caller needs "fail when the parent is missing", it has to check with FolderExists first.

The name is cleaned before it is used¶

The folder that appears may not be the one that was asked for, which is why the response reports FolderName rather than echoing the request. Read it back rather than assuming.

So ..Q3 report <final>.. is created as Q3 report _final_.

const root = await call('CreateFolder', {
  authenticationTicket: ticket,
  Path: '/Finance/Reports/2026'
});

console.log(root.getAttribute('FolderId'), root.getAttribute('FolderName'));

A trailing / or \ is ignored, and either separator may be used throughout. Libraries are not created this way: a one-segment path such as /NewLibrary is answered 4041.

Notes¶

• Root-level folders (domains/libraries) cannot be created using this API. Use CreateDomain instead.
• If the full path contains multiple levels that do not exist, all intermediate folders are created automatically.
• Folder names are sanitized (invalid characters are removed or replaced) before creation.
• For creating a folder with a description, use CreateFolder1.

Related APIs¶

• CreateFolder1 - Create a folder with a description
• CreateDomain - Create a top-level domain/library
• DeleteFolder - Delete a folder
• FolderExists - Check whether a folder exists

Error Codes¶

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