SetRdFreezeFlag API¶

Sets or clears the Retention and Disposition (R&D) freeze flag on a document or folder by path. When frozen, the item is excluded from automatic disposition processing. The path type is auto-detected — document paths update the single document; folder paths recursively update all eligible documents within the folder.

Endpoint¶

/srv.asmx/SetRdFreezeFlag

Methods¶

• GET /srv.asmx/SetRdFreezeFlag?authenticationTicket=...&path=...&rdFreezeFlag=...&actionComment=...
• POST /srv.asmx/SetRdFreezeFlag (form data)
• SOAP Action: http://tempuri.org/SetRdFreezeFlag

Parameters¶

Response¶

Success Response (document, or folder with no per-item errors)¶

<root success="true" />

Success Response (folder with per-item failures)¶

The operation completes but individual items that could not be updated are reported as <log> child elements:

<root success="true">
  <log>
    <item>document-name.pdf</item>
    <error>Document is checked out</error>
  </log>
</root>

Error Response¶

<root success="false" error="Error message" errorCode="4000" />

Required Permissions¶

Either the change retention period right on the document or folder, or membership of [R&D Managers], which stands in for the right on any document or folder. Defining schedules themselves is for R&D Managers only. Up to 8.7 it needed the right and the role. The item must have an R&D schedule, and a document's freeze cannot be lifted while its folder is frozen.

Example¶

Freeze a document (GET)¶

GET /srv.asmx/SetRdFreezeFlag?authenticationTicket=abc123-def456&path=/Library/Records/contract.pdf&rdFreezeFlag=true&actionComment=Under+legal+hold HTTP/1.1

Freeze a folder (POST)¶

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

authenticationTicket=abc123-def456&path=/Library/Records/2020&rdFreezeFlag=true&actionComment=Annual+audit+hold

Request (SOAP 1.1)¶

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SetRdFreezeFlag xmlns="http://tempuri.org/">
      <authenticationTicket>abc123-def456</authenticationTicket>
      <path>/Library/Records/2020</path>
      <rdFreezeFlag>true</rdFreezeFlag>
      <actionComment>Annual audit hold</actionComment>
    </SetRdFreezeFlag>
  </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;
}

Freezes an item against disposition, or releases it. The item has to be under a schedule - there is nothing to freeze otherwise.

await call('SetRdFreezeFlag', {
  authenticationTicket: ticket,
  path: '/Finance/Invoices/inv-1001.pdf',
  rdFreezeFlag: true,
  actionComment: 'Held for the audit'
});

actionComment is optional. Each call is written to the item's freeze log, which GetRdFreezeLogs reads back.

The folder form answers MultiStatus when it could not do all of it. It walks the contents and logs what it could not freeze - "this folder has no retention and disposition schedule", for instance - and answers success="false" with errorCode="2070" when there is at least one such entry. Until 9.0 it reported success="true" even when that was everything.

Notes¶

• The path type is resolved automatically: document paths update the single document; folder paths update all eligible documents within recursively
• For folder paths, per-item failures do not abort the operation — they are reported as <log> child elements alongside success="true"
• A freeze flag history log entry is written for each successfully updated item (see GetRdFreezeLogs)
• Setting rdFreezeFlag=false on an already-unfrozen item completes without error

Related APIs¶

• GetRdFreezeLogs — Get the R&D freeze flag change history for a document or folder
• DisposeItem — Dispose a document or folder by path
• GetAppliedRDScheduleLogs — Get history of R&D schedules applied to a document or folder

Error Codes¶

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