Newer Version Available

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

ContentNote

Represents a note in Salesforce. This object is available in API version 32.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update()

Special Access Rules

  • Notes must be enabled.

Fields

Field Details
Content
Type
base64
Properties
Create, Nillable, Update
Description
The content or body of the note, which can include propertly formatted HTML or plain text. Any special characters within plain text in the Content field must be escaped. You can escape special characters by calling content.escapeHtml4().
ContentSize
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Size of the note in bytes.
CreatedById
Type
reference
Properties
Defaulted on createFilter, Group, Sort
Description
ID of the user who created the note.
CreatedDate
Type
dateTime
Properties
Defaulted on create, Filter, Sort
Description
Date the note was created.
FileExtension
Type
string
Properties
Filter, Group, Nillable, Sort
Description
File extension of the note.
FileType
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Type of file for the note. All notes have a file type of SNOTE.
Id
Type
id
Properties
Defaulted on createFilter, Group, Nillable, Sort
Description
ID of the note.
IsDeleted
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the note has been deleted.
IsReadOnly
Type
boolean
Properties
Defaulted on create, Group, Sort
Description
Indicates whether the note is read only.
LastModifiedById
Type
reference
Properties
Defaulted on create, Filter, Group, Sort
Description
The ID of the user who last modified the note.
LastModifiedDate
Type
dateTime
Properties
Defaulted on create, Filter, Sort
Description
Date the note was last modified. Updates when the Title or Content of the note are updated.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable Sort
Description
Date the note was last viewed. This field is available in API version 35.0 and later.
LatestPublishedVersionId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the ContentVersion for the latest published version of the note.
OwnerId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the owner of the note.
TextPreview
Type
string
Properties
Filter, Group, Nillable, Sort
Description
A preview of the note’s content. This field is available in API version 35.0 and later.
Title
Type
string
Properties
Create, Filter, Group, idLookup, Namefield, Sort, Update
Description
Title of the note.

Usage

  • The ContentNote object represents notes created with the enhanced note taking tool, released in Winter ‘16.
  • Use ContentNote to create, query, retrieve, search, edit, and update notes.
  • ContentNote is built on ContentVersion, and so it has many of the same usages.
  • Not all fields can be set for notes. Only the Content and Title fields can be updated.
  • The maximum file size you can upload via the SOAP API must be less than 50 MB. When a document is uploaded or downloaded via the API, it is converted to base64. This conversion increases the document size by approximately 37%. Account for the base64 conversion increase so that the file you plan to upload is less than 50 MB.
  • SOQL and SOSL queries on the ContentNote return only the most recent version of the note.
  • To relate a note to a record, use ContentDocumentLink.

For example, the following code creates a note and escapes any special characters so they are converted to their HTML equivalents.

1ContentNote cn = new ContentNote();
2cn.Title = 'test1';
3String body = 'Hello World. Before insert/update, escape special characters such as ", ', &, and other standard escape characters.';
4cn.Content = Blob.valueOf(body.escapeHTML4());
5insert(cn);

In this example, the following code creates a note using text that is already formatted as HTML, so it does not need to be escaped.

1ContentNote cn = new ContentNote();
2cn.Title = 'test2';
3String body = '<b>Hello World. Because this text is already formatted as HTML, it does not need to be escaped. 
4Special characters such as &quot;, etc. must already use their HTML equivalents.</b>';
5cn.Content = body;
6insert(cn);