Document

Supported Calls

create(), update(), delete(), describeSObjects(), query(), search(), retrieve(), getDeleted(), getUpdated()

Special Access Rules

You must have the “Edit” permission on documents and the appropriate access to the Folder that contains a document in order to create or update a document in that Folder.

Fields

Field	Field Type	Field Properties	Description
AuthorID	reference	Create Defaulted on create Filter Update	ID of the User who is responsible for the Document. For information on IDs, see ID Field Type.
Body	base64	Create Nillable Update	Required. Encoded file data. If specified, then do not specify a URL.
BodyLength	int	Filter	Size of the file (in bytes).
ContentType	string	Create Filter Nillable Update	Type of content. Label is Mime Type. Limit: 120 characters. If the Disallow HTML documents and attachments security setting is enabled for your organization, you cannot upload files with the following file extensions: htm, html, htt, htx, mhtm, mhtml, shtm, shtml, acgi.
Description	textarea	Create Filter Nillable Update	Text description of the Document. Limit: 255 characters.
DeveloperName	string	Create Filter Nillable Update	The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object's name in a managed package and the changes are reflected in a subscriber's organization. Label is Document Unique Name.
FolderId	reference	Create Filter Update	Required. ID of the Folder that contains the Document. See Folder.
IsBodySearchable	boolean	Defaulted on create Filter	Indicates whether the contents of the object can be searched using a SOSL `FIND` call. The `ALL FIELDS` search group includes the content as a searchable field.
IsDeleted	boolean	Defaulted on create Filter	Indicates whether the object has been moved to the Recycle Bin (`true`) or not (`false`). Label is Deleted.
IsInternalUseOnly	boolean	Create Defaulted on create Filter Update	Indicates whether the object is only available for internal use (`true`) or not (`false`). Label is Internal Use Only.
IsPublic	boolean	Create Defaulted on create Filter Update	Indicates whether the object is available for external use (`true`) or not (`false`). Label is Externally Available.
Keywords	string	Create Filter Nillable Update	Keywords. Limit: 255 characters.
Name	string	Create Filter idLookup Update	Required. Name of the document. Label is Document Name.
NamespacePrefix	string	Filter Nillable	The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. The limit is 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This is the namespace prefix of the Developer Edition organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
Type	Create Filter Nillable Update string	Create Filter Nillable Update	File type of the Document. In general, the values match the file extension for the type of Document (such as pdf or jpg). Label is File Extension.
URL	string	Create Filter Nillable Update	URL reference to the file (instead of storing it in the database). If specified, do not specify the Body or BodyLength.

Usage

When calling create() or update() for a document, a client application can specify a value in either the Body or URL fields, but not both.

Encoded Data

The API sends and receives the binary file data encoded as a base64 data type. Prior to create(), clients must encode the binary file data as base64. Upon receiving an API response, clients must decode the base64 data to binary (this conversion is usually handled for you by the SOAP client).

Maximum Document Size

The create() and update() calls restrict documents to a maximum size of 5 MB.