Document

Represents a file that a user has uploaded. Unlike Attachment records, documents are not attached to a parent object.

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

  • 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.

  • Type: reference

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Description:

    ID of the User who is responsible for the Document.

    This is a relationship field.

  • Relationship name: Author

  • Relationship type: relationship

  • Refers to: User

  • Type: base64
  • Properties: Create, Nillable, Update
  • Description: Required. Encoded file data. If specified, then do not specify a URL.
  • Type: int
  • Properties: Filter, Group, Sort
  • Description: Size of the file (in bytes).

  • Type: string

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 6.0

  • Description:

    Type of content. Label is Mime Type. Limit: 120 characters.

    If the Don't allow HTML uploads as attachments or document records 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, .svg.

  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Text description of the Document. Limit: 255 characters.

  • Type: string

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 14.0

  • Description: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. 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.

    When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

  • Type: reference

  • Properties: Create, Filter, Group, Sort, Update

  • Description:

    Required. ID of the Folder that contains the document.

    This is a relationship field.

  • Relationship name: Folder

  • Relationship type: polymorphic

  • Refers to: Folder, User

  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Introduced: API version 15.0
  • Description: 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.
  • Default value: false
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the object is only available for internal use (true) or not (false). Label is Internal Use Only.
  • Default value: false
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 7.0
  • Description: Indicates whether the object is available for external use (true) or not (false). Label is Externally Available.
  • Default value: false
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Keywords. Limit: 255 characters.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Required. Name of the document. Label is Document Name.

  • Type: string

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 14.0

  • Description:

    The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 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 orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
    • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: 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.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: URL reference to the file (instead of storing it in the database). If specified, do not specify the Body or BodyLength.

When creating or updating a document, you can specify a value in either the Body or Url fields, but not both.

The API sends and receives the binary file data encoded as a base64 data type. Prior to creating a record, 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).

You can only create or update documents to a maximum size of 5 MB.