DocumentType

Represents a document type.

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

DocumentType components have the suffix .documentType and are stored in the documentTypes folder.

Version 

Introduced in API version 59.0.

Fields 

description 

  • Type: string
  • Required: No
  • Description: A description of the DocumentType.

externalIdentifier 

  • Type: string
  • Required: No

isActive 

  • Type: boolean

  • Required: Yes

  • Description: Required.

    Specifies whether the DocumentType is active.

masterLabel 

  • Type: string

  • Required: Yes

  • Description: Required.

    The master label of the DocumentType. This internal label doesn’t get translated.

maximumFileSize 

  • Type: int
  • Required: No

maximumFileUploadCount 

  • Type: int
  • Required: No

Declarative Metadata Sample Definition 

The following is an example of a DocumentType component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DocumentType xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>Utility_Bill</description>
4    <isActive>true</isActive>
5    <masterLabel>Utility_Bill</masterLabel>
6</DocumentType>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>DocumentType</name>
6    </types>
7    <version>59.0</version>
8</Package>

Wildcard Support in the Manifest File 

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.