UpdateDocumentTypeDef API¶

Updates the definition of an existing document type. Allows renaming the document type and optionally changing its required property set. Document type definitions are system-wide and affect all documents assigned to that type.

Endpoint¶

/srv.asmx/UpdateDocumentTypeDef

Methods¶

• GET /srv.asmx/UpdateDocumentTypeDef?authenticationTicket=...&documentTypeId=...&newDocumentTypeName=...&newRequiredPropertySetName=...
• POST /srv.asmx/UpdateDocumentTypeDef (form data)
• SOAP Action: http://tempuri.org/UpdateDocumentTypeDef

Parameters¶

Response¶

Success Response¶

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

Error Response¶

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

Required Permissions¶

Only system administrators may call this API. An anonymous caller is refused with 4010, any other non-administrator with 4030, and both before the type is looked up.

Example¶

GET Request¶

GET /srv.asmx/UpdateDocumentTypeDef
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &documentTypeId=5
  &newDocumentTypeName=Financial+Report
  &newRequiredPropertySetName=FinanceProperties
HTTP/1.1

POST Request¶

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&documentTypeId=5
&newDocumentTypeName=Financial Report
&newRequiredPropertySetName=FinanceProperties

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:UpdateDocumentTypeDef>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:documentTypeId>5</tns:documentTypeId>
      <tns:newDocumentTypeName>Financial Report</tns:newDocumentTypeName>
      <tns:newRequiredPropertySetName>FinanceProperties</tns:newRequiredPropertySetName>
    </tns:UpdateDocumentTypeDef>
  </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;
}

Renames a document type and changes the property set it requires.

await call('UpdateDocumentTypeDef', {
  authenticationTicket: ticket,
  DocumentTypeId: 1081,
  NewDocumentTypeName: 'Supplier Invoice',
  NewRequiredPropertySetName: 'INVOICE'      // empty for none
});

Every field is written, so an empty NewRequiredPropertySetName removes the requirement rather than leaving it. Use UpdateDocumentTypeDef1 to set a description or a retention schedule at the same time.

Changing a document type is an administrator's job.

Notes¶

• Renaming a document type affects all documents currently assigned to that type -" they will appear under the new name.
• Changing the required property set may affect compliance validation for documents already assigned to this type.
• Anonymous users cannot call this API (returns an insufficient rights error).
• Use GetDocumentTypes to retrieve all existing document type IDs and names.

Related APIs¶

• GetDocumentTypes - Retrieve all defined document type definitions
• CreateDocumentTypeDef - Create a new document type definition
• UpdateDocumentType - Assign a document type to a specific document

Error Codes¶

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