User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
User Interface API Resources
User Interface API Request Bodies
User Interface API Response Bodies
User Interface API Top-Level Response Bodies
Action
App
Apps
Batch Results
Content Document
Content Document Composite
Content Document Link
Content Version
Duplicates
Duplicates Configuration
Favorite
Favorite Collection
List Info
List Record Collection
List UI
List View Summary Collection
Lookup Values
Most Recently Used List Metadata
Most Recently Used List Record Collection
Most Recently Used List UI
Navigation Items
Object Info
Object Info Directory
Picklist Values
Picklist Values Collection
Record
Record Collection
Record Defaults
Record Defaults Template Clone
Record Defaults Template Create
Record Layout
Record UI
Related List Info
Related List Info Summary Collection
Related List Record Collection
Related List Record Count
Simplified Batch Results
Theme
User Interface API Nested Response Bodies
Supported Objects
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Content Version

An instance of a Content Document that represents a different version of the document.
Property Name Type Description Filter Group and Version Available Version
checksum String MD5 checksum for the document. Small, 56.0 56.0
contentBodyId String ID of the content body. Small, 56.0 56.0
contentLocation String Origin of the document. Valid values are:
  • S—Document is located within Salesforce.
  • E—Document is located outside of Salesforce.
  • L—Document is located on a social network and accessed via Social Customer Service.
 Small, 56.0 56.0
contentModifiedById String ID of the user who modified the document. Small, 56.0 56.0
contentModifiedDate String The date when the document was modified. When you upload the first version of a document, this property can be set to the current time or anytime in the past. The date is updated when the document is renamed or a new version is uploaded. Small, 56.0 56.0
contentSize Integer The size of the document in bytes. Small, 56.0 56.0
contentUrl Integer URL for links, which is one of the fields that determines the FileType. The character limit is 1,300. Small, 56.0 56.0
createdById String The ID of the user who uploaded the document. Small, 56.0 56.0
createdDate String The date when the document was uploaded. Small, 56.0 56.0
description String A description of the document version. Small, 56.0 56.0
eTag String A string populated with a hash.

Don’t use this property. Instead, use weakEtag. Because eTag is a string, you can only compare for equality.

 Small, 56.0 56.0
externalDataSourceId String ID of the external document referenced in the external data source. Small, 56.0 56.0
externalDocumentInfo1 String Stores the URL of the file in the external content repository. The integration from the external source determines the content for this string. After the reference or copy is created, the URL of the external file is updated when you:
  • Republish a file reference in Lightning Experience
  • Open the document
  • Create a file reference in Connect REST API with reuseReference set to true.
When the file is updated, the shared link is updated to the most current version.		 Small, 56.0 56.0
externalDocumentInfo2 String Contains the external file ID. Salesforce determines the content for this string, which is private. The content can change without notice, depending on the external system. After the file reference is created, this property isn’t updated, even if the file path changes. Small, 56.0 56.0
featuredContentBoost String Read only. Designates a document as featured. Small, 56.0 56.0
featuredContentDate String Date the document was featured. Small, 56.0 56.0
fileExtension String File extension of the document. Small, 56.0 56.0
fileType String Type of document, determined by the file extension. Small, 56.0 56.0
firstPublishLocationId String ID of the location where the version was first published. The ID can refer to the user who owns the personal library or My Files. In Lightning Experience, if the first version is published into a public library, the field will contain the ID of that library. Accepts all record IDs supported by Content Document Link such as records or groups. Small, 56.0 56.0
id String The ID of this document. Small, 56.0 56.0
isAssetEnabled String Can be specified on creation of Content Version to automatically convert a Content Document into a Content Asset. Small, 56.0 56.0
isEncrypted Boolean Indicates whether files are encrypted using Shield Platform Encryption or not. Small, 56.0 56.0
isLatest Boolean Indicates whether this is the latest version of the document or not. Small, 56.0 56.0
isMajorVersion Boolean Indicates whether this is a major version or not. Major versions can't be replaced. Small, 56.0 56.0
language String The language for the document. This field defaults to the org’s default language unless the multi language setting is enabled. Specifies the language of the labels returned. The value must be a valid user locale (language and country), such as de_DE or en_GB. Small, 56.0 56.0
lastModifiedById String The ID of the user who last updated this record. Small, 56.0 56.0
lastModifiedDate String The date and time when a user last modified this record. Date and time information is in ISO 8601 format. Small, 56.0 56.0
negativeRatingCount Integer Read only. The number of times different users have given the document a thumbs down. Rating counts for the latest version are not version-specific. If Version 1 receives 10 thumbs-down votes, and Version 2 receives 2 thumbs-down votes, the negativeRatingCount on Version 2 is 12. However, rating counts are not retroactive for prior versions. The negativeRatingCount on Version 1 is 10. Small, 56.0 56.0
networkId String ID of the Experience Cloud site that this file originated from. This property is supported for file creation only. Small, 56.0 56.0
origin String The source of the content version. Valid values are:
  • C—The default value. Content document from the user's personal library. The firstPublishLocationId must be the user's ID. If firstPublishLocationId is left blank, it defaults to the user's ID.
  • H—Salesforce file from the user's My Files. The firstPublishLocationId must be the user's ID. If firstPublishLocationId is left blank, it defaults to the user's ID. Origin can only be set to H if Chatter is enabled for your organization.
 Small, 56.0 56.0
ownerId String ID of the owner of this document. Small, 56.0 56.0
pathOnClient String The complete path of the document. One of the fields that determines the fileType. Small, 56.0 56.0
positiveRatingCount Integer Read only. The number of times different users have given the document a thumbs up. Rating counts for the latest version are not version-specific. If Version 1 receives 10 thumbs-up votes, and Version 2 receives 2 thumbs-up votes, the PositiveRatingCount on Version 2 is 12. However, rating counts are not retroactive for prior versions. The PositiveRatingCount on Version 1 is 10. Small, 56.0 56.0
latestPublishedVersionId String The ID of the latest document version (Content Version). Small, 56.0 56.0
ownerId String The ID of the document owner. Small, 56.0 56.0
parentId String The ID of the library that owns the document, which is created automatically when creating a content version via the API the first time. Small, 56.0 56.0
publishStatus String Indicates if and how the document is published. Valid values are:
  • P—The document is published to a public library and is visible to other users.
  • R—The document is published to a personal library and is restricted to the owner.
  • U—The document is not published because publishing was interrupted.
 Small, 56.0 56.0
ratingCount Integer Read only. Total number of positive and negative ratings. Small, 56.0 56.0
reasonForChange String The reason why the document was changed. This field can only be set when inserting a new version of a document. Small, 56.0 56.0
recordTypeId String The record type ID for this record. Small, 56.0 56.0
sharingOption String Controls whether sharing is frozen for a file. Only administrators and file owners with Collaborator access to the file can modify this field. Default is Allowed, which means that new shares are allowed. Set to Restricted to prevent new shares. Small, 56.0 56.0
sharingPrivacy String Controls sharing privacy for a file. Only administrators and file owners with Collaborator access to the file can modify this field. Default is Visible to Anyone With Record Access. When set to Private on Records, the file is private on records but can be shared selectively with others. Small, 56.0 56.0
systemModstamp String The date and time when a user or an automated process (such as a trigger) last modified this record. Date and time information is in ISO 8601 format. Small, 56.0 56.0
tagCsv String Text used to apply tags to a content version. Small, 56.0 56.0
textPreview String A preview of the document. Small, 56.0 56.0
title String The title for the document. Small, 56.0 56.0
versionNumber String The version number. The number increments with each version of the document, for example, 1, 2, 3. Small, 56.0 56.0
weakEtag 64-bit integer (base 10) Compare this value between responses to determine whether a document changed. If the value is larger, the document is newer. If the value is smaller, the document is older. If the value is the same, the documents are the same. Small, 56.0 56.0