UpdateDocumentProperties2 API¶

Updates the core properties of the specified document: display name, description, update instructions, source, language, author, and importance level. All fields are optional -" only the fields provided are updated. This is the most complete version of the UpdateDocumentProperties family.

Endpoint¶

/srv.asmx/UpdateDocumentProperties2

Methods¶

• GET /srv.asmx/UpdateDocumentProperties2?authenticationTicket=...&path=...&newDocumentName=...&newDescription=...&newUpdateInstructions=...&newDocumentSource=...&newDocumentLanguage=...&newDocumentAuthor=...&importance=...
• POST /srv.asmx/UpdateDocumentProperties2 (form data)
• SOAP Action: http://tempuri.org/UpdateDocumentProperties2

Parameters¶

Response¶

Success Response¶

<response success="true" error="" />

Error Response¶

<response success="false" error="Document not found." />

Required Permissions¶

The calling user must have write (modify properties) permission on the document or its containing folder.

Example¶

GET Request¶

GET /srv.asmx/UpdateDocumentProperties2
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &path=/Finance/Reports/Q1-2024-Report.pdf
  &newDocumentName=Q1+2024+Financial+Report
  &newDescription=Quarterly+financial+summary
  &newDocumentAuthor=Jane+Smith
  &importance=2
HTTP/1.1

POST Request¶

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&path=/Finance/Reports/Q1-2024-Report.pdf
&newDocumentName=Q1 2024 Financial Report
&newDescription=Quarterly financial summary
&newDocumentAuthor=Jane Smith
&importance=2

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:UpdateDocumentProperties2>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:path>/Finance/Reports/Q1-2024-Report.pdf</tns:path>
      <tns:newDocumentName>Q1 2024 Financial Report</tns:newDocumentName>
      <tns:newDescription>Quarterly financial summary</tns:newDescription>
      <tns:newDocumentAuthor>Jane Smith</tns:newDocumentAuthor>
      <tns:importance>2</tns:importance>
    </tns:UpdateDocumentProperties2>
  </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;
}

UpdateDocumentProperties1 with importance as well.

await call('UpdateDocumentProperties2', {
  authenticationTicket: ticket,
  Path: path,
  NewDocumentName: 'Q1.pdf',
  NewDescription: 'Quarterly results',
  NewUpdateInstructions: '',
  NewDocumentSource: 'Finance system export',
  NewDocumentLanguage: 'en',
  NewDocumentAuthor: 'J Smith',
  importance: 3                 // -1 NoMarkings, 0 Low, 1 Normal, 2 High, 3 Vital
});

importance is nullable here, so leaving it out keeps the current value - the one field in this family that is not overwritten when omitted. GetDocument reads it back as a name (Vital) rather than as the number.

Which of the three to use¶

Each writes every field it takes, so a value left empty is cleared rather than left alone. Read the document with GetDocument first and send back what should survive. Using the wider variant to change one narrow field will empty the fields it adds.

NewDocumentName is nullable, so an empty one reaches the operation and is refused with 4000 "a document must have a name" rather than by model binding. A name carrying any of / \ : * ? " < > | # % & + or a tab is refused 4000 too - unlike creating a document, where such a name is silently cleaned up.

Notes¶

• Passing null for any optional parameter leaves that field unchanged on the document.
• The importance field maps to: -1 = NoMarkings, 0 = Low, 1 = Normal, 2 = High, 3 = Vital. To set importance independently, you can also use SetDocumentImportance.
• Line endings in all text fields are normalized to the server format.
• This is the most complete variant. Use UpdateDocumentProperties or UpdateDocumentProperties1 if you don't need the importance field.

Related APIs¶

• UpdateDocumentProperties - Update name, description, and update instructions only
• UpdateDocumentProperties1 - Update properties including source, language, and author
• SetDocumentImportance - Set the importance level independently
• GetDocument - Get all current document properties

Error Codes¶

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