CreateDocumentTypeDef API¶

Creates a new document type definition in the system. Document types allow documents to be categorized and optionally associated with a required custom property set, enforcing metadata collection for documents of that type.

Endpoint¶

/srv.asmx/CreateDocumentTypeDef

Methods¶

• GET /srv.asmx/CreateDocumentTypeDef?authenticationTicket=...&DocumentTypeName=...&RequiredPropertySetName=...

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

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

Parameters¶

Response¶

Success Response¶

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

Error Response¶

<response success="false" error="Error message" />

Required Permissions¶

Only system administrators may call this API. Non-administrator users receive an error even if they are domain managers.

Example¶

GET Request -" without a property set¶

GET /srv.asmx/CreateDocumentTypeDef

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

  &DocumentTypeName=Contract

  &RequiredPropertySetName=

HTTP/1.1

GET Request -" with a required property set¶

GET /srv.asmx/CreateDocumentTypeDef

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

  &DocumentTypeName=Invoice

  &RequiredPropertySetName=InvoiceMetadata

HTTP/1.1

POST Request¶

POST /srv.asmx/CreateDocumentTypeDef HTTP/1.1

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

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

&DocumentTypeName=Invoice

&RequiredPropertySetName=InvoiceMetadata

SOAP Request¶

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

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

  <soap:Body>

    <tns:CreateDocumentTypeDef>

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

      <tns:DocumentTypeName>Invoice</tns:DocumentTypeName>

      <tns:RequiredPropertySetName>InvoiceMetadata</tns:RequiredPropertySetName>

    </tns:CreateDocumentTypeDef>

  </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 a document type, optionally requiring a property set on documents that use it.

const root = await call('CreateDocumentTypeDef', {
  authenticationTicket: ticket,
  DocumentTypeName: 'Supplier Invoice',
  RequiredPropertySetName: 'INVOICE'      // empty for none
});

console.log(root.getAttribute('DocumentTypeId'));

Creating a document type is an administrator's job: a caller without those rights is refused 4030, not 4010. Use CreateDocumentTypeDef1 to set a description or a retention schedule at the same time; this variant leaves both empty.

Notes¶

• Document type names are case-insensitive for uniqueness checks -" Contract and CONTRACT are treated as the same name.

• The name GENERIC (any casing) is a built-in reserved type and cannot be used as a new document type name.

• If RequiredPropertySetName is provided, the named property set must already exist, must be a global (system-wide) property set, and must be configured to apply to documents. Domain-level or folder-level property sets are not accepted.

• The returned DocumentTypeId can be used with UpdateDocumentTypeDef and DeleteDocumentTypeDef.

• To retrieve all defined document types, use GetDocumentTypes.

Related APIs¶

• GetDocumentTypes - Retrieve all defined document types

• UpdateDocumentTypeDef - Update an existing document type definition

• DeleteDocumentTypeDef - Delete a document type definition

Error Codes¶

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