Tip: Though the
tag isn’t supported, you can use
to create lines. • •
• • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example: Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation.
LastModifiedDate
Type dateTime Properties Defaulted on create, Filter, Sort
742
Standard Objects
Field
EventFeed
Details Description Date and time when a user last modified this record. This field is a standard system field. When a feed item is created, LastModifiedDate is the same as CreatedDate. If a FeedComment is inserted on that feed item, then LastModifiedDate becomes the CreatedDate for that FeedComment. Deleting the FeedComment does not change the LastModifiedDate. Ordering by LastModifiedDate DESC sorts the feed by both the most recent feed item or comment.
LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
NetworkScope
Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. NetworkScope can have the following values:
• NetworkId—The ID of the community in which the FeedItem is available. If left empty, the feed item is only available in the default community. • AllNetworks—The feed item is available in all communities. Note the following exceptions for NetworkScope: • Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks. • You can’t filter a FeedItem on the NetworkScope field.
743
Standard Objects
EventFeed
Field
Details
ParentId
Type reference Properties Filter, Group, Sort Description ID of the event record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item: • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval.
744
Standard Objects
Field
EventFeed
Details • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • CaseCommentPost—generated event when a user adds a case comment for a case object • EmailMessageEvent—generated event when an email related to a case object is sent or received • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • ChangeStatusPost—generated event when a user changes the status of a case • AttachArticleEvent—generated event when a user attaches an article to a case Note: If you set Type to ContentPost, also specify ContentData and ContentFileName.
Visibility
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization.
745
Standard Objects
Field
EventLogFile
Details Visibility can have the following values:
• AllUsers—The feed item is available to all users who have permission to see the feed item. • InternalUsers—The feed item is available to internal users only. Note the following exceptions for Visibility: • For record posts, Visibility is set to InternalUsers for all internal users by default. • External users can set Visibility only to AllUsers. • On user and group posts, only internal users can set Visibility to InternalUsers.
Usage Use this object to track changes for an event record. You can only delete a feed if you created it, or if you have the “Modify All Data” permission.
EventLogFile Represents event log files for event monitoring. This object is available in API version 32.0 and later. The event monitoring feature gathers information about your Salesforce org’s operational events, which you can use to analyze usage trends and user behavior. You can interact with event monitoring data by querying fields on the EventLogFile object (like EventType and LogDate). To view the underlying event data, query the LogFile field. The EventType determines the schema of this field. For more information, see Supported Event Types. Note: Log data schema for each EventType can change. With each new release, use the LogFileFieldNames and LogFileFieldTypes fields to validate the schema changes. In the unlikely case where no log files are generated for 24 hours, contact Salesforce. For details about event monitoring, see the Force.com REST API Developer’s Guide.
Special Access Rules Accessing this object requires View Event Log Files and API Enabled user permissions. Users with View All Data permission can view event log files.
Supported Calls query(), retrieve()
746
Standard Objects
EventLogFile
Fields Field
Details
EventType
Type string Properties Filter, Group, Restricted picklist, Sort Description The event type—API, Login, Report, URI, and so forth. Use to determine which files were generated for your org. For the corresponding LogFile schema, see Supported Event Types.
LogDate
Type dateTime Properties Filter, Sort Description The date and time of the log file’s creation.
LogFile
Type base64 Description Encoded file data in .csv format. The EventType field defines the schema for this data.
LogFileContentType
Type string Properties Filter, Group, Sort Description The content type of the log file; always .csv.
LogFileFieldNames
Type string Properties Nillable Description The ordered list of fields in the log file data. Note: LogFileFieldNames and LogFileFieldTypes are specific to each EventType. For example, LogFileFieldNames has a different value for an API EventType and a Login EventType.
LogFileFieldTypes
Type string
747
Standard Objects
Field
EventLogFile
Details Properties Nillable Description The ordered list of field types in the log file data (String, Id, and so forth). Note: LogFileFieldNames and LogFileFieldTypes are specific to each EventType. For example, LogFileFieldTypes has a different value for an API EventType and a Login EventType.
LogFileLength
Type double Properties Filter, Sort Description The log file length in bytes. You can use this field to plan storage needs for your log files.
Supported Event Types The EventType field supports the following events. • Apex Callout • Apex Execution • Apex SOAP • Apex Trigger • API • Asynchronous Report Run • Bulk API • Change Set Operation • Console • Content Distribution • Content Document Link • Content Transfer • Dashboard • Document Attachment Downloads • External Cross-Org Callout Event Type • External Custom Apex Callout Event Type • External OData Callout Event Type • Lightning Error • Lightning Interaction • Lightning Page View • Lightning Performance
748
Standard Objects
EventLogFile
• Login As • Login • Logout • Metadata API Operation • Multiblock Report • Package Install • Queued Execution • Report • Report Export • REST API • Sandbox • Sites • Time-Based Workflow • Transaction Security • UI Tracking • URI • Visualforce Request • Wave Change • Wave Interaction • Wave Performance The following tables serve as a reference for each event and its associated fields. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature. Note: The Login and Logout events are available in supported Salesforce editions at no additional cost. Contact Salesforce to purchase the remaining event types.
Apex Callout Apex Callout events contain details about callouts (external requests) during Apex code execution. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number
749
Standard Objects
EventLogFile
Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring. EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
METHOD
Type String Description The HTTP method of the callout. Example GET, POST, PUT, and so on.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
750
Standard Objects
REQUEST_SIZE
EventLogFile
Type Number Description The size of the callout request body, in bytes.
RESPONSE_SIZE
Type Number Description The size of the callout response, in bytes.
RUN_TIME
Type Number Description Not used for this event type. Use the TIME field instead.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
SUCCESS
Type Boolean Description 1 if the request was successful, and 0 if not.
TIME
Type Number Description The amount of time that the request took in milliseconds (ms).
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime
751
Standard Objects
EventLogFile
Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z TYPE
Type String Description The type of Apex callout. Example REST or AJAX
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
URL
Type String Description The callout endpoint URL. Example www.salesforce.com
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id
752
Standard Objects
EventLogFile
Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
Apex Execution Apex Execution events contain details about Apex classes that are used. Field
Details
CALLOUT_TIME
Type Number Description The execution time of the external Apex calls.
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type Number Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTRY_POINT
Type String Description The entry point for this Apex execution.
753
Standard Objects
EventLogFile
Example • GeneralCloner.cloneAndInsertRecords • VF- /apex/CloneUser EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
EXEC_TIME
Type Number Description The end-to-end Apex execution time.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
NUMBER_SOQL_QUERIES
Type Number Description The number of SOQL queries that were executed during the event.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
QUIDDITY
Type String Description The type of outer execution associated with this event.
754
Standard Objects
EventLogFile
Example • A–Old Batch • C–Scheduled Apex • E–Inbound Email Service • F–Future • H–Apex REST • I–Invocable Action • K–Quick Action • L–Aura • M–Remote Action • P–Parallel Batch Apex • Q–Queuable • R–Synchronous • S–Serial Batch Apex • T–Apex Tests • V–Visualforce • W–SOAP Webservices • X–Execute Anonymous REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
755
Standard Objects
TIMESTAMP
EventLogFile
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
756
Standard Objects
EventLogFile
Apex SOAP Apex SOAP events contain details about Web Services API calls. Field
Details
CLASS_NAME
Type String Description The Apex class name. If the class is part of a managed package, this string includes the package namespace.
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type Number Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LIMIT_USAGE_PERCENT
Type Number
757
Standard Objects
EventLogFile
Description The percentage of Apex SOAP calls that were made against the organization’s limit. LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
METHOD_NAME
Type String Description The name of the calling Apex method.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
QUERY
Type String Description The SOQL query, if one was performed.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type String Description The status of the request for a page view or user interface action.
758
Standard Objects
EventLogFile
Possible Values • S: Success • F: Failure • U: Undefined • A: Authorization Error • R: Redirect • N: Not Found RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request.
759
Standard Objects
EventLogFile
Example /home/home.jsp URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
Apex Trigger Apex Trigger events contain details about triggers that fire in an organization. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the
760
Standard Objects
EventLogFile
app server layer, highlighting pieces of Apex or Visualforce code that need refactoring. DB_TOTAL_TIME
Type Number Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTITY_NAME
Type String Description The name of the object affected by the trigger.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
EXEC_TIME
Type Number Description The end-to-end Apex execution time.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
761
Standard Objects
REQUEST_ID
EventLogFile
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type String Description The status of the request for a page view or user interface action. Possible Values • S: Success • F: Failure • U: Undefined • A: Authorization Error • R: Redirect • N: Not Found
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
762
Standard Objects
TIMESTAMP_DERIVED
EventLogFile
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
TRIGGER_ID
Type String Description The 15-character ID of the trigger that was fired.
TRIGGER_NAME
Type String Description The name of the trigger that was fired.
TRIGGER_TYPE
Type String Description The type of this trigger. Possible Values • AfterInsert • AfterUpdate • BeforeInsert • BeforeUpdate
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id
763
Standard Objects
EventLogFile
Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943 USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
API API events contain details about your organization’s Force.com Web Services API activity. Field
Details
API_TYPE
Type String Description The type of API request. Possible Values • D: Apex Class • E: SOAP Enterprise • I: SOAP Cross Instance • L: Live Agent • M: SOAP Metadata • O: Old SOAP • P: SOAP Partner • R: REST API • S: SOAP Apex • T: SOAP Tooling • X: XmlRPC
API_VERSION
Type String Description The version of the API that’s being used.
764
Standard Objects
EventLogFile
Example 36.0 CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CLIENT_NAME
Type String Description The name of the client that’s using Salesforce services.
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_BLOCKS
Type Number Description Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type Number Description Allows you to monitor trends in database uptime.
DB_TOTAL_TIME
Type Number Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTITY_NAME
Type Set
765
Standard Objects
EventLogFile
Description API objects that are accessed. Example Account, Opportunity, Contact, and so on. EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
METHOD_NAME
Type String Description The name of the calling Apex method.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
766
Standard Objects
REQUEST_SIZE
EventLogFile
Type Number Description The size of the callout request body, in bytes.
REQUEST_STATUS
Type String Description The status of the request for a page view or user interface action. Possible Values • S: Success • F: Failure • U: Undefined • A: Authorization Error • R: Redirect • N: Not Found
RESPONSE_SIZE
Type Number Description The size of the callout response, in bytes.
ROWS_PROCESSED
Type Number Description The number of rows that were processed in the request. Example 150
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
QUERY
Type String Description The SOQL query, if one was performed.
SESSION_KEY
Type String
767
Standard Objects
EventLogFile
Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
768
Standard Objects
USER_ID_DERIVED
EventLogFile
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
Asynchronous Report Run Asynchronous Report Run events are created for reporting requests that are scheduled. This category includes dashboard refreshes, asynchronous reports, schedule reports, and analytics snapshots. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DASHBOARD_ID
Type String Description The 15-character ID of the dashboard that was run.
DASHBOARD_ID_DERIVED
Type String Description The 18-character case insensitive ID of the dashboard that was run.
DB_TOTAL_TIME
Type Number
769
Standard Objects
EventLogFile
Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code. DB_BLOCKS
Type Number Description Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type Number Description Allows you to monitor trends in database uptime.
DISPLAY_TYPE
Type String Description The report display type, indicating the run mode of the report. Possible Values • D: Dashboard • S: Show Details • H: Hide Details
ENTITY_NAME
Type String Description The name of the object affected by the trigger.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type String
770
Standard Objects
EventLogFile
Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I NUMBER_BUCKETS
Type Number Description The number of buckets that were used in the report.
NUMBER_COLUMNS
Type Number Description The number of columns in the report.
NUMBER_EXCEPTION_FILTERS
Type Number Description The number of exception filters that are used in the report.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
RENDERING_TYPE
Type String Description The report rendering type, describing the format of the report output. Possible Values • W: Web (HTML) • E: Email • P: Printable • X: Excel • C: Comma-separated values (CSV) • J: JavaScript Object Notation (JSON)
771
Standard Objects
REPORT_ID
EventLogFile
Type Id Description The 15-character ID of the report that was run.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type String Description The status of the request for a page view or user interface action. Possible Values • S: Success • F: Failure • U: Undefined • A: Authorization Error • R: Redirect • N: Not Found
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
SORT
Type String
772
Standard Objects
EventLogFile
Description The sort column and order that was used in the report. TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id
773
Standard Objects
EventLogFile
Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
Bulk API Bulk API events contain details about Bulk API requests. Field
Details
BATCH_ID
Type String Description The 15-character ID of the Bulk API batch.
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
ENTITY_TYPE
Type String Description The type of entity that the Bulk API used.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
774
Standard Objects
JOB_ID
EventLogFile
Type String Description The 15-character ID of the Bulk API job.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
MESSAGE
Type EscapedString Description Any success or error message that’s associated with the request.
NUMBER_FAILURES
Type Number Description The number of failures that were returned with the request.
OPERATION_TYPE
Type String Description The type of Bulk API operation that was performed.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
775
Standard Objects
EventLogFile
Example 3nWgxWbDKWWDIk0FKfF5DV ROWS_PROCESSED
Type Number Description The number of rows that were processed in the request. Example 150
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
SUCCESS
Type Boolean Description Whether the batch was successful.
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
776
Standard Objects
URI
EventLogFile
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
Change Set Operation Change Set Operation events contain information from change set migrations. Field
Details
CHANGE_SET_NAME
Type String Description The name of the change set.
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number
777
Standard Objects
EventLogFile
Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring. EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
OPERATION
Type String Description The operation that’s being performed. Possible Values • DEPLOY • RETRIEVE • LIST • DESCRIBE
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String
778
Standard Objects
EventLogFile
Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TARGET_ORG_ID
Type Id Description The 15-character ID of the organization that’s receiving the change set.
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String
779
Standard Objects
EventLogFile
Description The URI of the page that’s receiving the request. Example /home/home.jsp URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
Console Console events contain information about the performance and use of Salesforce Consoles. The Console events are logged whenever a Console tab is opened with a sidebar component. Outside of that, when Console tabs are opened, a regular view record detail event is served just like in Salesforce Classic. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
780
Standard Objects
COMPONENT_ID
EventLogFile
Type Id Description The 15-character ID of the component.
COMPONENT_ID_DERIVED
Type Id Description The 18-character, case-insensitive ID of the component.
CONSOLE_ID
Type Id Description The 15-character ID of the console.
CONSOLE_ID_DERIVED
Type Id Description The 18-character, case-insensitive ID of the console.
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type Number Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type String
781
Standard Objects
EventLogFile
Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
RECORD_ID
Type Id Description The 15-character ID of the record that’s associated with the console.
RECORD_ID_DERIVED
Type Id Description The 18-character, case-insensitive ID of the record that’s associated with the console.
RELATED_ENTITY_ID
Type Id Description The 15-character ID of the record that’s associated with the delivery distribution.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type String
782
Standard Objects
EventLogFile
Description The status of the request for a page view or user interface action. Possible Values • S: Success • F: Failure • U: Undefined • A: Authorization Error • R: Redirect • N: Not Found RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String
783
Standard Objects
EventLogFile
Description The URI of the page that’s receiving the request. Example /home/home.jsp URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
Content Distribution Content Distribution events contain information about content distributions and deliveries to users. Field
Details
ACTION
Type String Description The action that’s used when a delivery is viewed. Possible Values • VIEW • INSERT • UPDATE
784
Standard Objects
DELIVERY_ID
EventLogFile
Type Id Description The 15-character ID of the content delivery.
DELIVERY_LOCATION
Type String Description The location of the delivery.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
RELATED_ENTITY_ID
Type Id Description The 15-character ID of the record that’s associated with the delivery distribution.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
TIMESTAMP
Type String Description The access time of Salesforce services.
785
Standard Objects
EventLogFile
Example 20130715233322.670 TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
VERSION_ID
Type Id Description The 15-character ID of the content version.
Content Document Link Content Document Link events contain sharing information for content documents. Field
Details
DOCUMENT_ID
Type Id Description The 15-character ID of the document that’s being shared.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
786
Standard Objects
ORGANIZATION_ID
EventLogFile
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
SHARED_WITH_ENTITY_ID
Type Id Description Who the document was shared with.
SHARING_OPERATION
Type String Description The type of sharing operation on the document. Possible Values • INSERT • UPDATE • DELETE
SHARING_PERMISSION
Type String Description What permissions the document was shared with. Possible Values • V: Viewer • C: Collaborator • I: Inferred—that is, the sharing permissions were inferred from a relationship between the viewer and document. For example, a document’s owner has a sharing permission to the document itself. Or, a document can be a part of a content collection, and the viewer has sharing permissions
787
Standard Objects
EventLogFile
to the collection rather than explicit permissions to the document directly. TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
Content Transfer Content Transfer events contain information about content transfer events, such as downloads, uploads, and previews. Field
Details
DOCUMENT_ID
Type Id Description The 15-character ID of the document that’s being shared.
DOCUMENT_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the document that’s being shared.
788
Standard Objects
EVENT_TYPE
EventLogFile
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
FILE_PREVIEW_TYPE
Type String Description The content type of the file version.
FILE_TYPE
Type String Description The content type of the file preview.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
SIZE_BYTES
Type Number Description The size of the file transfer, in bytes.
TIMESTAMP
Type String Description The access time of Salesforce services.
789
Standard Objects
EventLogFile
Example 20130715233322.670 TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
TRANSACTION_TYPE
Type String Description The operation that was performed. Possible Values • VersionDownloadAction and VersionDownloadApi represent downloads via the user interface and API respectively. • VersionRenditionDownload represents a file preview action. • saveVersion represents a file that’s being uploaded.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
VERSION_ID
Type Id Description The 15-character ID of the content version.
790
Standard Objects
VERSION_ID_DERIVED
EventLogFile
Type Id Description The 18-character case insensitive ID of the content version.
Dashboard Dashboard events contain details about dashboards that users view. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DASHBOARD_COMPONENT_ID
Type Id Description The 15-character ID of the dashboard component.
DASHBOARD_ID
Type String Description The 15-character ID of the dashboard that was run.
DASHBOARD_ID_DERIVED
Type String Description The 18-character case insensitive ID of the dashboard that was run.
791
Standard Objects
DASHBOARD_TYPE
EventLogFile
Type String Description The type of dashboard. Possible Values • R: Run as running user • C: Run as context user • S: Run as specific user
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
IS_SCHEDULED
Type Boolean Description The value is true if the dashboard is a scheduled dashboard.
IS_SUCCESS
Type Boolean Description 1 if the dashboard component ran successfully, 0 if it didn’t.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
792
Standard Objects
REPORT_ID
EventLogFile
Type Id Description The 15-character ID of the report that was run.
REPORT_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the report that was run.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime
793
Standard Objects
EventLogFile
Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
Document Attachment Downloads Document Attachment Downloads events contain details of document and attachment downloads. Field
Details
CLIENT_IP
Type IP
794
Standard Objects
EventLogFile
Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26 ENTITY_ID
Type Id Description The 15-character ID of the entity that’s associated with the document or attachment.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
FILE_NAME
Type String Description The name of the file or attachment.
FILE_TYPE
Type String Description The type of the file or attachment.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
795
Standard Objects
TIMESTAMP
EventLogFile
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
Login As Login As events contain details about what a Salesforce admin did while logged in as another user. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
796
Standard Objects
DELEGATED_USER_ID
EventLogFile
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or API. In this case, the user who’s doing the impersonation.
DELEGATED_USER_ID_DERIVED
Type Id Description The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or API. In this case, the user who’s doing the impersonation.
DELEGATED_USER_NAME
Type String Description The username of the user who’s using Salesforce services through the UI or API. In this case, the user who’s doing the impersonation.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
797
Standard Objects
REQUEST_ID
EventLogFile
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request.
798
Standard Objects
EventLogFile
Example /home/home.jsp URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
Login Login events contain details about your org’s user login history. Field
Details
API_TYPE
Type String Description The type of API request. Possible Values • D: Apex Class • E: SOAP Enterprise • I: SOAP Cross Instance • L: Live Agent • M: SOAP Metadata • O: Old SOAP
799
Standard Objects
EventLogFile
• P: SOAP Partner • R: REST API • S: SOAP Apex • T: SOAP Tooling • X: XmlRPC API_VERSION
Type String Description The version of the API that’s being used. Example 36.0
BROWSER_TYPE
Type String Description The browser used for login. Example Values • 10011000: Internet Explorer Desktop 11 • 10011001: Internet Explorer Mobile 11 • 11035000: Firefox Desktop 35 • 11035001: Firefox Mobile 35 • 13050000: Chrome Desktop 50 • 13050001: Chrome Mobile 50 • 14012000: Safari Desktop 12 • 14012001: Safari Mobile 12
CIPHER_SUITE
Type String Description The TLS cipher suite used for the login. Values are OpenSSL-style cipher suite names, with hyphen delimiters. For more information, see OpenSSL Cryptography and SSL/TLS Toolkit.
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
800
Standard Objects
CLIENT_IP
EventLogFile
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
DB_TOTAL_TIME
Type Number Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
LOGIN_STATUS
Type String Description The status of the login attempt. For successful logins, the value is LOGIN_NO_ERROR. All other values indicate errors or authentication issues. For details, see Login Event Type — LOGIN_STATUS Values on page 907.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
801
Standard Objects
REQUEST_ID
EventLogFile
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type String Description The status of the request for a page view or user interface action. Possible Values • S: Success • F: Failure • U: Undefined • A: Authorization Error • R: Redirect • N: Not Found
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
SOURCE_IP
Type IP Description The source IP of the login request.
TIMESTAMP
Type String
802
Standard Objects
EventLogFile
Description The access time of Salesforce services. Example 20130715233322.670 TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
TLS_PROTOCOL
Type String Description The TLS protocol used for the login. Example There are 3 possible values. • 1.0 • 1.1 • 1.2
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
803
Standard Objects
USER_ID_DERIVED
EventLogFile
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
USER_NAME
Type String Description The username that’s used for login.
Logout Logout events contain details of user logouts. Field
Details
API_TYPE
Type String Description The type of API request. Possible Values • D: Apex Class • E: SOAP Enterprise • I: SOAP Cross Instance • L: Live Agent • M: SOAP Metadata • O: Old SOAP • P: SOAP Partner • R: REST API • S: SOAP Apex • T: SOAP Tooling • X: XmlRPC
API_VERSION
Type String Description The version of the API that’s being used.
804
Standard Objects
EventLogFile
Example 36.0 APP_TYPE
Type Number Description The application type that was in use upon logging out. Example Values • 1007: SFDC Application • 1014: Live Agent • 2501: CTI • 2514: OAuth • 3475: SFDC Partner Portal
BROWSER_TYPE
Type String Description The browser used for login. Example Values • 10011000: Internet Explorer Desktop 11 • 10011001: Internet Explorer Mobile 11 • 11035000: Firefox Desktop 35 • 11035001: Firefox Mobile 35 • 13050000: Chrome Desktop 50 • 13050001: Chrome Mobile 50 • 14012000: Safari Desktop 12 • 14012001: Safari Mobile 12
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CLIENT_VERSION
Type Number Description The version of the client that was in use upon logging out.
805
Standard Objects
EVENT_TYPE
EventLogFile
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
PLATFORM_TYPE
Type Number Description The code for the client platform. If a timeout caused the logout, this field is null. Example Values • 1000: Windows • 2003: Macintosh/Apple OSX • 5005: Android • 5006: iPhone • 5007: iPad
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
RESOLUTION_TYPE
Type Number Description The screen resolution of the client. If a timeout caused the logout, this field is null.
SESSION_LEVEL
Type String
806
Standard Objects
EventLogFile
Description The security level of the session that was used when logging out. Possible Values • 1: Standard Session • 2: High-Assurance Session SESSION_TYPE
Type String Description The session type that was used when logging out. Possible Values • A: API • I: APIOnlyUser • N: ChatterNetworks • Z: ChatterNetworksAPIOnly • C: Content • P: OauthApprovalUI • O: Oauth2 • T: SiteStudio • R: SitePreview • S: SubstituteUser • B: TempContentExchange • G: TempOauthAccessTokenFrontdoor • Y: TempVisualforceExchange • F: TempUIFrontdoor • U: UI • E: UserSite • V: Visualforce • W: WDC_API
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime
807
Standard Objects
EventLogFile
Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_INITIATED_LOGOUT
Type Boolean Description The value is 1 if the user intentionally logged out of the organization by clicking the Logout button. If the user’s session timed out due to inactivity or another implicit logout action, the value is 0.
USER_NAME
Type String Description The username that’s used for login.
USER_TYPE
Type String Description The category of user license of the user that logged out. Possible Values • S: Standard • P: Partner • p: Customer Portal Manager • C: Customer Portal User • O: Power Custom • o: Custom • L: Package License Manager • X: Black Tab User • N: Salesforce to Salesforce • G: Guest
808
Standard Objects
EventLogFile
• D: External Who • A: Automated Process • b: High Volume Portal • n: CSN Only • F: Self-Service
Metadata API Operation Metadata API Operation events contain details of Metadata API retrieval and deployment requests. Field
Details
API_VERSION
Type String Description The version of the API that’s being used. Example 36.0
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type String
809
Standard Objects
EventLogFile
Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I OPERATION
Type String Description The operation that’s being performed. Possible Values • DEPLOY • RETRIEVE • LIST • DESCRIBE
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String
810
Standard Objects
EventLogFile
Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
811
Standard Objects
USER_ID_DERIVED
EventLogFile
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
Multiblock Report Multiblock Report events contain details about Joined Report reports. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type Number Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
812
Standard Objects
HAS_CHART
EventLogFile
Type Boolean Description True if the report has a chart.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
MASTER_REPORT_ID
Type String Description The 15-character ID of the master report.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type String Description The status of the request for a page view or user interface action. Possible Values • S: Success • F: Failure
813
Standard Objects
EventLogFile
• U: Undefined • A: Authorization Error • R: Redirect • N: Not Found RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID
814
Standard Objects
EventLogFile
Description The 18-character case insensitive ID of the URI of the page that’s receiving the request. USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
Package Install Package Install events contain details about package installation in the organization. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVENT_TYPE
Type String
815
Standard Objects
EventLogFile
Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on. FAILURE_TYPE
Type String Description A general categorization of any error that’s encountered.
IS_MANAGED
Type Boolean Description True if the operation is performed on a managed package.
IS_PUSH
Type Boolean Description True if the package was installed as a result of a push upgrade.
IS_RELEASED
Type Boolean Description True if the operation is performed on a released package.
IS_SUCCESSFUL
Type Boolean Description True if the package was successfully installed.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
OPERATION_TYPE
Type String Description The type of package operation.
816
Standard Objects
EventLogFile
Possible Values • INSTALL • UPGRADE • EXPORT • UNINSTALL • VALIDATE_PACKAGE • INIT_EXPORT_PKG_CONTROLLER ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
PACKAGE_NAME
Type String Description The name of the package that’s being installed.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
817
Standard Objects
TIMESTAMP
EventLogFile
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
818
Standard Objects
EventLogFile
Queued Execution Queued Execution events contain details about queued executions—for example, batch Apex. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds that it took to complete the batch apex request. This field indicates the amount of activity taking place in the app server layer, allowing you to identify pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type Number Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTRY_POINT
Type String Description The name of the Apex class that serves as the execution point for the batch job. Example TaskPhoneExtensionBatchUpdate
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
JOB_ID
Type String
819
Standard Objects
Field
EventLogFile
Details Description The ID of the batch Apex job. Example 7073000000lDquo
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
820
Standard Objects
Field
EventLogFile
Details Example d7DEq/ANa7nNZZVD
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
821
Standard Objects
EventLogFile
Report Export Report Export events contain details about reports that a user exported. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CLIENT_INFO
Type String Description Information about the client that’s using Salesforce services.
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type Id
822
Standard Objects
EventLogFile
Description The 15-character ID of the organization. Example 00D000000000123 REPORT_DESCRIPTION
Type String Description Information about the report that was run.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime
823
Standard Objects
EventLogFile
Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
REST API REST API events contain details about REST-specific requests. Field
Details
CLIENT_IP
Type IP
824
Standard Objects
EventLogFile
Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26 CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_BLOCKS
Type Number Description Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type Number Description Allows you to monitor trends in database uptime.
DB_TOTAL_TIME
Type Number Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTITY_NAME
Type Set Description API objects that are accessed. Example Account, Opportunity, Contact, and so on.
EVENT_TYPE
Type String Description The type of event.
825
Standard Objects
EventLogFile
Example ReportExport, URI, UITracking, API, RestApi, and so on. LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
MEDIA_TYPE
Type String Description The media type of the response.
METHOD
Type String Description The HTTP method of the request—GET, POST, PUT, and so on.
NUMBER_FIELDS
Type Number Description The number of fields or columns, where applicable.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REQUEST_STATUS
Type String Description The status of the request for a page view or user interface action. Possible Values • S: Success • F: Failure • U: Undefined
826
Standard Objects
EventLogFile
• A: Authorization Error • R: Redirect • N: Not Found REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
ROWS_PROCESSED
Type Number Description The number of rows that were processed in the request. Example 150
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
STATUS_CODE
Type Number Description The HTTP status code for the response.
TIMESTAMP
Type String Description The access time of Salesforce services.
827
Standard Objects
EventLogFile
Example 20130715233322.670 TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_AGENT
Type Number Description The numeric code for the type of client used to make the request (for example, the browser, application, or API).
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
828
Standard Objects
EventLogFile
Example 00590000000I1SNIA0
Sandbox Sandbox events contain details about sandbox copies. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CURRENT_SANDBOX_ORG_ID
Type Id Description The 15-character ID of the current sandbox organization.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
PENDING_SANDBOX_ORG_ID
Type Id Description The 15-character ID of the target sandbox org.
REQUEST_ID
Type String
829
Standard Objects
EventLogFile
Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV SANDBOX_ID
Type Id Description The 15-character ID of the sandbox organization.
STATUS
Type String Description The status of the sandbox copy.
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
Sites Sites events contain details of Site.com requests. Requests can originate from the browser (UI) or the API.
830
Standard Objects
EventLogFile
Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type Number Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
HTTP_HEADERS
Type String Description The HTTP headers that were sent in the request.
METHOD
Type String Description The HTTP method of the request—GET, POST, PUT, and so on.
IS_API
Type Boolean
831
Standard Objects
EventLogFile
Description True if this page was an API or Web Services request. IS_ERROR
Type Boolean Description True if this page was an error page.
IS_FIRST_REQUEST
Type Boolean Description 1 if this page is the first Visualforce transaction in the request, or 0 if it isn't.
IS_GUEST
Type Boolean Description True if this page was a guest (unauthenticated) request.
IS_SECURE
Type Boolean Description True if this request is secure.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
PAGE_NAME
Type String
832
Standard Objects
EventLogFile
Description The name of the Visualforce page that was requested. QUERY
Type String Description The SOQL query, if one was performed.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type String Description The status of the request for a page view or user interface action. Possible Values • S: Success • F: Failure • U: Undefined • A: Authorization Error • R: Redirect • N: Not Found
REQUEST_TYPE
Type String Description The request type. Possible Values • page: a normal request for a page • content_UI: a content request for a page that originated in the user interface • content_apex: a content request initiated by an Apex call • PDF_UI: a request for a page in PDF format through the user interface
833
Standard Objects
EventLogFile
• PDF_apex: a request for PDF format by an Apex call (usually a Web Service call) RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
SITE_ID
Type Id Description The 15-character ID of the Site.com site.
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
834
Standard Objects
URI_ID_DERIVED
EventLogFile
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
Time-Based Workflow Time-Based Workflow events contain details about queue activity monitoring. Field
Details
DATA
Type String Description The record details of time queue activity.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOG_GROUP_ID
Type String
835
Standard Objects
EventLogFile
Description Marks log records that are committed or rolled back. NUMBER_OF_RECORDS
Type Number Description The number of processed records.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
TYPE
Type String Description The type of Apex callout.
836
Standard Objects
EventLogFile
Example REST or AJAX
Transaction Security Transaction Security events contain details about policy execution. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVALUATION_TIME_MS
Type Number Description The time in milliseconds used to evaluate the policy.
EVENT_TIMESTAMP
Type String Description The time at which the Transaction Security event was generated in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). This value might be earlier than TIMESTAMP_DERIVED by the amount of time taken to log the event. Example 2015-07-27T11:32:59.555Z
EVENT_TYPE
Type String Description The type of event.
837
Standard Objects
EventLogFile
Example ReportExport, URI, UITracking, API, RestApi, and so on. LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
POLICY_ID
Type Id Description The 15-character ID of the policy being evaluated. Example 00530000009M943
POLICY_ID_DERIVED
Type Id Description The 18-character case-insensitive ID of the policy being evaluated. Example 00590000000I1SNIA0
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
838
Standard Objects
RESULT
EventLogFile
Type String Description The outcome of evaluating the policy. Example TRIGGERED or NOT TRIGGERED
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The time the event was logged in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). This value may be later than EVENT_TIMESTAMP by the amount of time between when the event occurred and when it was logged. Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request.
839
Standard Objects
EventLogFile
Example /home/home.jsp URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
UI Tracking UI Tracking events contain details about user interactions with the mobile UI. Field
Details
ACTION
Type EscapedString Description The hierarchical user action.
ACTION_LOCATION
Type String Description The name of the component where the user action occurred.
ACTION_TYPE
Type String
840
Standard Objects
EventLogFile
Description The database action that’s associated with the user action. Possible Values Database actions, including: • Create • Update • Delete • Convert APP_NAME
Type EscapedString Description The name of the application that the user accessed.
BROWSER_NAME
Type String Description The name of the browser that's accessed by the user.
BROWSER_VERSION
Type String Description The browser version that's accessed by the user.
CARRIER
Type String Description The name of the cellular service provider.
CLIENT
Type EscapedString Description The context of access. Example Phone, tablet, desktop, and so on.
CLIENT_ID
Type String Description The API client ID.
CLIENT_IP
Type IP
841
Standard Objects
EventLogFile
Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26 CONNECTION_TYPE
Type String Description The type of the connection. Possible Values • WIFI • CDMA1x • CDMA • EDGE • EVDO0 • EVDOA • EVDOB • GPRS • HSDPA • HSUPA • HRPD • LTE
DELTA
Type Number Description The elapsed time between the start (START_TIME) and end (END_TIME) of the event in milliseconds.
DEVICE_ID
Type String Description The unique identifier used to identify a device when tracking events. DEVICE_ID is a generated value that’s created when the app is initially run after installation.
END_TIME
Type Number
842
Standard Objects
EventLogFile
Description The end time of the event in Unix time (milliseconds since 00:00:00 UTC on January 1, 1970). EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOCATION
Type EscapedString Description The hierarchical location.
NETWORK_ID
Type Id Description The network ID of the request.
NUMBER1
Type Number Description The record of a numeric value based on the operation. For example, the number of results returned by a search.
NUMBER2
Type Number Description The record of a numeric value based on operation, but for multiple values. Example NUMBER1 items selected in a list containing NUMBER2 items.
OBJECT_TYPE
Type String Description The API name of the record in the action.
ORGANIZATION_ID
Type Id
843
Standard Objects
EventLogFile
Description The 15-character ID of the organization. Example 00D000000000123 OS_NAME
Type String Description The operating system name.
OS_VERSION
Type String Description The operating system version.
PAGE_OPTION
Type String Description A comma-separated list of additional information about the current page. Example isVisualforce
RECORD_ID
Type Id Description The ID of the record the user accessed.
RECORD_TYPE_ID
Type Id Description The ID of the record type the user accessed.
REFERRER
Type EscapedString Description The HTTP referrer header.
REQUEST_METHOD
Type String Description The HTTP request method.
844
Standard Objects
SDK_APP_NAME
EventLogFile
Type String Description The name of the mobile SDK application that’s installed on the device. Example Salesforce1
SDK_APP_TYPE
Type String Description The mobile SDK application type. Example Native, hybrid, and so on.
SDK_APP_VERSION
Type String Description The mobile SDK application version. Example 5.0
SDK_MODEL
Type String Description The model of the mobile SDK application that’s installed on the device. Example Salesforce1
SDK_VERSION
Type String Description The mobile SDK version. Example 2.1.0
SESSION_ID
Type String Description The user’s unique session ID. You can use the ID to identify all UI Tracking events within a session.
845
Standard Objects
EventLogFile
Example [C@2f71c8e1 SIGNAL_STRENGTH
Type Number Description The cellular signal strength.
START_TIME
Type Number Description The start time of the event in Unix time (milliseconds since 00:00:00 UTC on January 1, 1970).
STATUS
Type Boolean Description Indicates whether an error was logged. Information is logged in data.
TARGET
Type EscapedString Description The request target.
TARGET2
Type EscapedString Description Additional information for the request target.
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
846
Standard Objects
EventLogFile
Example 2015-07-27T11:32:59.555Z UNIQUE_PAGE_ID
Type String Description The unique request ID for all the requests from 1 page.
USAGE_TIMESTAMP
Type String Description The time when the usage occurred. Format: YYYYMMDDHHMM SS.sss.
USER_AGENT
Type Escaped String Description The numeric code for the type of client used to make the request (for example, the browser, application, or API) as a string.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
USER_TYPE
Type String Description The user license of the user who’s accessing Salesforce services through the UI or the API.
847
Standard Objects
EventLogFile
Possible Values • S: Standard • P: Partner • p: Customer Portal Manager • C: Customer Portal User • O: Power Custom • o: Custom • L: Package License Manager • X: Black Tab User • N: Salesforce to Salesforce • G: Guest • D: External Who • A: Automated Process • b: High Volume Portal • n: CSN Only • F: Self-Service
URI URI events contain details about user interaction with the web browser UI. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_BLOCKS
Type Number
848
Standard Objects
EventLogFile
Description Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance. DB_CPU_TIME
Type Number Description Allows you to monitor trends in database uptime.
DB_TOTAL_TIME
Type Number Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
REFERRER_URI
Type String Description The referring URI of the page that’s receiving the request.
849
Standard Objects
REQUEST_ID
EventLogFile
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type String Description The status of the request for a page view or user interface action. Possible Values • S: Success • F: Failure • U: Undefined • A: Authorization Error • R: Redirect • N: Not Found
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
850
Standard Objects
TIMESTAMP_DERIVED
EventLogFile
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request. For more granular URI information for Lightning Experience and Salesforce1, see the Lightning Error, Lightning Interaction, Lightning Page View, and Lightning Performance event types. Examples /aura (Lightning Experience), /app/one.app (Lightning Experience), /home/home.jsp (Salesforce Classic)
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
851
Standard Objects
EventLogFile
Visualforce Request VISUALFORCE__REQUEST_EVENT events contain details of Visualforce requests. Requests can originate from the browser (UI) or
the API. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CONTROLLER_TYPE
Type Number Description The type of controller that’s used by the requested Visualforce page.
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_BLOCKS
Type Number Description Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type Number Description Allows you to monitor trends in database uptime.
DB_TOTAL_TIME
Type Number
852
Standard Objects
EventLogFile
Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code. EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
HTTP_METHOD
Type String Description The HTTP method of the request—GET, POST, PUT, and so on.
IS_AJAX_REQUEST
Type Boolean Description The value is true if the request is a partial page request.
IS_FIRST_REQUEST
Type Boolean Description 1 if this page is the first Visualforce transaction in the request, or 0 if it isn't.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
MANAGED_PACKAGE_NAMESPACE
Type String Description If the page is part of a managed package, the namespace of that package.
853
Standard Objects
ORGANIZATION_ID
EventLogFile
Type Id Description The 15-character ID of the organization. Example 00D000000000123
PAGE_NAME
Type String Description The name of the Visualforce page that was requested.
QUERY
Type String Description The SOQL query, if one was performed.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
REQUEST_SIZE
Type Number Description The size of the request body, in bytes.
REQUEST_STATUS
Type String Description The status of the request for a page view or user interface action. Possible Values • S: Success • F: Failure • U: Undefined • A: Authorization Error • R: Redirect
854
Standard Objects
EventLogFile
• N: Not Found REQUEST_TYPE
Type String Description The request type. Possible Values • page: a normal request for a page • content_UI: a content request for a page that originated in the user interface • content_apex: a content request initiated by an Apex call • PDF_UI: a request for a page in PDF format through the user interface • PDF_apex: a request for PDF format by an Apex call (usually a Web Service call)
RESPONSE_SIZE
Type Number Description The size of the response, in bytes.
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
855
Standard Objects
TIMESTAMP_DERIVED
EventLogFile
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_AGENT
Type Number Description The numeric code for the type of client used to make the request (for example, the browser, application, or API).
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
VIEW_STATE_SIZE
Type Number Description The size of the Visualforce view state, in bytes.
Wave Change Wave Change events represent route or page changes made in the Salesforce Analytics user interface.
856
Standard Objects
EventLogFile
Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
IS_NEW
Type Boolean Description If the change routes to a new page, the value of this field is true. If it routes to an existing page, this field is false.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization.
857
Standard Objects
EventLogFile
Example 00D000000000123 RECORD_ID
Type String Description The Salesforce ID of the Analytics object.
REOPEN_COUNT
Type Number Description If IS_NEW is false, the number of times that an existing page opens.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
858
Standard Objects
TIMESTAMP_DERIVED
EventLogFile
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
TYPE
Type String Description The Analytics object type.
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
WAVE_SESSION_ID
Type String Description The ID of a particular session of Wave. Use this field to determine which log lines originated from a particular session.
WAVE_TIMESTAMP
Type Number
859
Standard Objects
EventLogFile
Description The time at which this log line was generated.
Wave Interaction Wave Interaction events track user interactions with the Analytics user interface made via the browser. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
NUM_CLICKS
Type Number
860
Standard Objects
EventLogFile
Description The number of clicks performed on a page in the Wave user interface. NUM_SESSIONS
Type Number Description The number of times a user returned to a particular page.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
READ_TIME
Type Number Description The amount of time a user spent on a particular tab.
RECORD_ID
Type String Description The Salesforce ID of the Analytics object.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String
861
Standard Objects
EventLogFile
Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
TOTAL_TIME
Type Number Description The total amount of time a tab was open in milliseconds.
TYPE
Type String Description The Analytics object type.
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID
862
Standard Objects
EventLogFile
Description The 18-character case insensitive ID of the URI of the page that’s receiving the request. USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
WAVE_SESSION_ID
Type String Description The ID of a particular session of Wave.
WAVE_TIMESTAMP
Type Number Description The time at which this log line was generated.
Wave Performance Wave Performance events help you track trends in your Analytics performance. Field
Details
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
863
Standard Objects
EPT
EventLogFile
Type Number Description The experienced page time in milliseconds.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type String Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
NAME
Type String Description The asset title or query string.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
QUERY_ID
Type String Description The ID of the Wave query.
RECORD_ID
Type String Description The Salesforce ID of the Analytics object.
864
Standard Objects
REQUEST_ID
EventLogFile
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
TAB_ID
Type String Description The ID of the particular Wave tab in the user interface.
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
865
Standard Objects
TYPE
EventLogFile
Type String Description The Analytics object type.
UI_RENDER_TIME
Type String Description The amount of time that it took for the user interface to render.
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
WAVE_SESSION_ID
Type String Description The ID of a particular session of Wave.
WAVE_TIMESTAMP
Type Number Description The time at which this log line was generated.
866
Standard Objects
External Cross-Org Callout Event Type
External Cross-Org Callout Event Type External Cross-Org Callout events represent external data callouts via the cross-org adapter for Salesforce Connect. This event type is available in the EventLogFile object in API version 40.0 and later. For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer Guide. Note: For the cross-org adapter for Salesforce Connect, event monitoring currently doesn’t track search callouts. We provide Salesforce Connect Callout Event Monitoring to customers through a public pilot program. The pilot event types are available in orgs that use Salesforce Connect and Event Monitoring. If your org doesn't have these features, contact your Salesforce account executive to participate in the pilot. Salesforce Connect Callout Event Monitoring is subject to change and isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for Salesforce Connect Callout Event Monitoring in the Salesforce Connect group in the Success Community.
Fields Field
Details
ACTION
Type String Description Action performed by the callout. Possible Values • query • upsert • delete
ENTITY
Type String Description Name of the external object being accessed. Example Order
EVENT_TYPE
Type String Description Type of event. Value is always ExternalCrossOrgCallout.
EXECUTE_MS
Type Number
867
Standard Objects
Field
External Cross-Org Callout Event Type
Details Description Reserved for future use.
FETCH_MS
Type Number Description Reserved for future use.
FILTER
Type Text Description Field expressions to filter which rows to return. Corresponds to WHERE in SOQL queries. Example WHERE CustomerId='123456'
HAVING
Type Text Description Reserved for future use.
LIMIT
Type Number Description Maximum number of rows to return for a query. Corresponds to LIMIT in SOQL queries. Example 200
MESSAGE
Type String Description Error or warning message associated with the failed query callout. Value is always empty for upsert and delete callouts. Example System.UnexpectedException: Query is either selecting too many fields or the filter conditions are too complicated
OFFSET
Type Number Description Number of rows to skip when paging through a result set. Corresponds to OFFSET in SOQL queries. If a SOQL query doesn’t define an OFFSET, the value is -1.
868
Standard Objects
Field
External Cross-Org Callout Event Type
Details Example 0 (default)
ORDERBY
Type String Description Field or column to use for sorting query results, and whether to sort the results in ascending (default) or descending order. Corresponds to ORDER BY in SOQL queries. Examples • ORDER BY ShipName • ORDER BY ShipName DESC
ORGANIZATION_ID
Type Id Description 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String Description Unique ID of a transaction. A transaction can contain one or more events. All events in a transaction have the same REQUEST_ID. Example 4A13-HSKv3CKs-0FKfceaV
ROWS
Type Number Description Total number of records in the result set. Value is always 0 for upsert and delete callouts. Example 200
SELECT
Type String Description Comma-separated list of fields being queried. Corresponds to SELECT in SOQL queries. Example SELECT Id,Name,CustomerID,OrderDate
869
Standard Objects
External Cross-Org Callout Event Type
Field
Details
STATUS
Type Boolean Description Whether the query was successful. Value is always empty for upsert and delete callouts. Possible Values • 1—Success • 0—Failed
SUBQUERIES
Type Number Description The number of subqueries that the query is split into.
THROUGHPUT
Type Number Description Reserved for future use.
TIMESTAMP
Type String Description When the event occurred. Example 20150101000000.000
TIMESTAMP_DERIVED
Type DateTime Description When the event occurred in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). Example 2015-07-27T11:32:59.555Z
TOTAL_MS
Type Number Description How long it took (in milliseconds) to prepare and execute the query and to retrieve the query results.
USER_ID
Type Id
870
Standard Objects
Field
External Custom Apex Callout Event Type
Details Description 15-character ID of the user accessing the external system. Example 00530000009M943
USING_MRU
Type Boolean Description Reserved for future use.
SEE ALSO: EventLogFile
External Custom Apex Callout Event Type External Custom Apex Callout events represent external data callouts via custom adapters for Salesforce Connect This event type is available in the EventLogFile object in API version 40.0 and later. For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer Guide. Note: We provide Salesforce Connect Callout Event Monitoring to customers through a public pilot program. The pilot event types are available in orgs that use Salesforce Connect and Event Monitoring. If your org doesn't have these features, contact your Salesforce account executive to participate in the pilot. Salesforce Connect Callout Event Monitoring is subject to change and isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for Salesforce Connect Callout Event Monitoring in the Salesforce Connect group in the Success Community.
Fields Field
Details
ACTION
Type String Description Action performed by the callout. Possible Values • query • upsert • delete
871
Standard Objects
External Custom Apex Callout Event Type
Field
Details
ENTITY
Type String Description Name of the external object being accessed. Example Order
EVENT_TYPE
Type String Description Type of event. Value is always ExternalCustomApexCallout.
EXECUTE_MS
Type Number Description Reserved for future use.
FETCH_MS
Type Number Description Reserved for future use.
FILTER
Type Text Description Field expressions to filter which rows to return. Corresponds to WHERE in SOQL queries. Example Filter:[columnName=CustomerID, columnValue=537, subfilters=null, tableName=Order, type=EQUALS]
LIMIT
Type Number Description Maximum number of rows to return for a query. Corresponds to LIMIT in SOQL queries. Example 200
OFFSET
Type Number Description Number of rows to skip when paging through a result set. Corresponds to OFFSET in SOQL queries.
872
Standard Objects
Field
External Custom Apex Callout Event Type
Details Example 0 (default)
ORDERBY
Type String Description Field or column to use for sorting query results, and whether to sort the results in ascending (default) or descending order. Corresponds to ORDER BY in SOQL queries. Examples (Order:[columnName=OrderDate, direction=ASCENDING, tableName=Order])
ORGANIZATION_ID
Type Id Description 15-character ID of the organization. Example 00D000000000123
REQUEST_ID
Type String Description Unique ID of a transaction. A transaction can contain one or more events. All events in a transaction have the same REQUEST_ID. Example 4A13-HSKv3CKs-0FKfceaV
ROWS
Type Number Description Total number of records in the result set. The value is always -1 if the custom adapter’s DataSource.Provider class doesn’t declare the QUERY_TOTAL_SIZE capability. Example 200
SELECT
Type String Description Comma-separated list of fields being queried. Corresponds to SELECT in SOQL queries.
873
Standard Objects
Field
External Custom Apex Callout Event Type
Details Example (ColumnSelection:[aggregation=NONE, columnName=Name, tableName=Order], ColumnSelection:[aggregation=NONE, columnName=CustomerID, tableName=Order], ColumnSelection:[aggregation=NONE, columnName=OrderDate, tableName=Order])
STATUS
Type Boolean Description Whether the query was successful. Possible Values • 1—Success • 0—Failed • Empty—Failed with no logged status or message
THROUGHPUT
Type Number Description Reserved for future use.
TIMESTAMP
Type String Description When the event occurred. Example 20150101000000.000
MESSAGE
Type String Description Error or warning message associated with the failed call. Example System.UnexpectedException: Query is either selecting too many fields or the filter conditions are too complicated
SUBQUERIES
Type Number Description Reserved for future use.
TIMESTAMP_DERIVED
Type DateTime
874
Standard Objects
Field
External OData Callout Event Type
Details Description When the event occurred in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). Example 2015-07-27T11:32:59.555Z
TOTAL_MS
Type Number Description How long it took (in milliseconds) to prepare and execute the query and to retrieve the query results.
USER_ID
Type Id Description 15-character ID of the user accessing the external system. Example 00530000009M943
SEE ALSO: EventLogFile
External OData Callout Event Type External OData Callout events represent external data callouts via the OData 2.0 and OData 4.0 adapters for Salesforce Connect. This event type is available in the EventLogFile object in API version 40.0 and later. For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer Guide. Note: We provide Salesforce Connect Callout Event Monitoring to customers through a public pilot program. The pilot event types are available in orgs that use Salesforce Connect and Event Monitoring. If your org doesn't have these features, contact your Salesforce account executive to participate in the pilot. Salesforce Connect Callout Event Monitoring is subject to change and isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for Salesforce Connect Callout Event Monitoring in the Salesforce Connect group in the Success Community.
Fields Field
Details
ACTION
Type String
875
Standard Objects
Field
External OData Callout Event Type
Details Description Action performed by the callout. Possible Values • query • upsert • delete
BYTES
Type Number Description Size of the result set in bytes.
ENTITY
Type String Description Name of the external object being accessed. Example Order
EVENT_TYPE
Type String Description Type of event. Value is always ExternalODataCallout.
EXECUTE_MS
Type Number Description Reserved for future use.
EXPAND
Type String Description Reserved for future use.
FETCH_MS
Type Number Description Reserved for future use.
FILTER
Type Text
876
Standard Objects
Field
External OData Callout Event Type
Details Description Field expressions to filter which rows to return. Corresponds to WHERE in SOQL queries and $filter in OData queries. Example CustomerID eq 12345
LIBRARY
Type String Description Reserved for future use.
LIMIT
Type Number Description Maximum number of rows to return for a query. Corresponds to LIMIT in SOQL queries and $top in OData queries. Example 200
MESSAGE
Type String Description Error or warning message associated with the failed call. Example The OData query result was too large, so the external data didn’t load.
OFFSET
Type Number Description Number of rows to skip when paging through a result set. Corresponds to OFFSET in SOQL queries and $skip in OData queries. Example 10
ORDERBY
Type String Description Field or column to use for sorting query results, and whether to sort the results in ascending (default) or descending order. Corresponds to ORDER BY in SOQL queries and $orderby in OData queries.
877
Standard Objects
Field
External OData Callout Event Type
Details Examples • ShipName • ShipName desc
ORGANIZATION_ID
Type Id Description 15-character ID of the organization. Example 00D000000000123
PROVIDER_TYPE
Type String Description Whether the OData 2.0 or OData 4.0 adapter made the callout. Possible Values • OData—OData 2.0 adapter • OData4—OData 4.0 adapter
RATE_LIMIT_USAGE_PERCENT Type
Number Description Consumed percentage of the org’s limit of OData callouts per hour. Example 2.5—2.5% of the hourly callout limit has been consumed REQUEST_ID
Type String Description Unique ID of a transaction. A transaction can contain one or more events. All events in a transaction have the same REQUEST_ID. Example 4A13-HSKv3CKs-0FKfceaV
REQUESTS
Type Number Description Reserved for future use.
ROWS
Type Number
878
Standard Objects
Field
External OData Callout Event Type
Details Description Reserved for future use.
SEARCH
Type String Description Search query string. Corresponds to condition expressions in SOSL. Example contains(CustomerID,'10248') eq true or contains(ShipName,'10248') eq true
SELECT
Type String Description Comma-separated list of fields being queried. Corresponds to SELECT in SOQL queries and $select in OData queries. Example CustomerID,OrderDate,OrderID,ShipCity,ShipCountry
STATUS
Type Boolean Description Whether the query was successful. Possible Values • 1—Success • 0—Failed
THROUGHPUT
Type Number Description Reserved for future use.
TIMESTAMP
Type String Description When the event occurred. Example 20150101000000.000
TIMESTAMP_DERIVED
Type DateTime
879
Standard Objects
Field
Lightning Error Event Type
Details Description When the event occurred in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). Example 2015-07-27T11:32:59.555Z
TOTAL_MS
Type Number Description How long it took (in milliseconds) to prepare and execute the query and to retrieve the query results.
USER_ID
Type Id Description 15-character ID of the user accessing the external system. Example 00530000009M943
SEE ALSO: EventLogFile
Lightning Error Event Type Lightning Error events represent errors that occurred during user interactions with Lightning Experience. This event type is available in the EventLogFile object in API version 39.0 and later. For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer’s Guide.
Fields Field
Details
APP_NAME
Type String Description The name of the application that the user accessed.
BROWSER_NAME
Type String Description The name of the browser that the user accessed.
880
Standard Objects
Field
Lightning Error Event Type
Details Example Chrome, IE, Safari, Gecko
BROWSER_VERSION
Type String Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version.
CLIENT_ID
Type String Description The API client ID.
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CONNECTION_TYPE
Type String Description The type of connection. Possible Values • CDMA1x • CDMA • EDGE • EVDO0 • EVDOA • EVDOB • GPRS • HRPD • HSDPA • HSUPA • LTE • WIFI
DEVICE_ID
Type String
881
Standard Objects
Field
Lightning Error Event Type
Details Description The unique identifier used to identify a device when tracking events. DEVICE_ID is a generated value that’s created when the mobile app is initially run after installation.
DEVICE_MODEL
Type String Description The name of the device model. Example iPad, iPhone
DEVICE_PLATFORM
Type String Description The type of application experience in name:experience:form format. Possible Values Name • APP_BUILDER • CUSTOM • S1 • SFX Experience • BROWSER • HYBRID Form • DESKTOP • PHONE • TABLET
DEVICE_SESSION_ID
Type Id Description The unique identifier of the user’s session based on page load time. If the user reloads a page, it starts a new session. Example 321a1ddfaf924803a075f1e69fc87bc06f53ccd0
LOGIN_KEY
Type String
882
Standard Objects
Field
Lightning Error Event Type
Details Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type String Description The 15-character ID of the org. Example 00D000000000123
OS_NAME
Type String Description The operating system name, derived from USER_AGENT. Example Android, iOS, OSX, Windows
OS_VERSION
Type String Description The operating system version, derived from USER_AGENT.
PAGE_START_TIME
Type Number Description The time when the page was initially loaded, measured in milliseconds. Example 1471564788642
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
SDK_APP_TYPE
Type String
883
Standard Objects
Field
Lightning Error Event Type
Details Description The mobile SDK application type. Possible Values • HYBRID • HYBRIDLOCAL • HYBRIDREMOTE • NATIVE • REACTNATIVE
SDK_APP_VERSION
Type String Description The mobile SDK application version number. Example 5.0
SDK_VERSION
Type String Description The mobile SDK version number. Example 2.1.0
SESSION_KEY
Type String Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When a user logs out and logs in again, a new session is started. Example cdd09305cb6babf34059e27f70e47f1b11dec868
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
UI_EVENT_SEQUENCE_NUM
Type Number
884
Standard Objects
Field
Lightning Error Event Type
Details Description An auto-incremented sequence number of the current event since the session started.
UI_EVENT_SOURCE
Type String Description Event source of the error. Example AuraError
UI_EVENT_TIMESTAMP
Type Number Description The time at which this event occurred, measured in milliseconds. Example 1479769912796
UI_EVENT_TYPE
Type String Description The type of error. Example Error, warning, information
USER_AGENT
Type String Description The numeric code for the type of client used to make the request (for example, browser, application, or API) as a string.
USER_ID
Type String Description The 15-character ID of the user accessing Salesforce services through the UI or API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API.
885
Standard Objects
Field
Lightning Interaction Event Type
Details Example 00590000000I1SNIA0
USER_TYPE
Type String Description The category of user license of the user accessing Salesforce services through the UI or API. Possible Values • A: Automated Process • b: High Volume Portal • C: Customer Portal User • D: External Who • F: Self Service • G: Guest • L: Package License Manager • N: Salesforce to Salesforce • n: CSN Only • O: Power Custom • o: Custom • P: Partner • p: Customer Portal Manager • S: Standard • X: Black Tab User
SEE ALSO: EventLogFile
Lightning Interaction Event Type Lightning Interaction events track user interactions with Lightning Experience. This event type is available in the EventLogFile object in API version 39.0 and later. For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer’s Guide.
Fields Field
Details
APP_NAME
Type String
886
Standard Objects
Field
Lightning Interaction Event Type
Details Description The name of the application that the user accessed.
BROWSER_NAME
Type String Description The name of the browser that the user accessed. Example Chrome, IE, Safari, Gecko
BROWSER_VERSION
Type String Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version.
CLIENT_ID
Type String Description The API client ID.
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CONNECTION_TYPE
Type String Description The type of connection. Possible Values • CDMA1x • CDMA • EDGE • EVDO0 • EVDOA • EVDOB • GPRS • HRPD
887
Standard Objects
Field
Lightning Interaction Event Type
Details • HSDPA • HSUPA • LTE • WIFI
DEVICE_ID
Type String Description The unique identifier used to identify a device when tracking events. DEVICE_ID is a generated value that’s created when the mobile app is initially run after installation.
DEVICE_MODEL
Type String Description The name of the device model. Example iPad, iPhone
DEVICE_PLATFORM
Type String Description The type of application experience in name:experience:form format. Possible Values Name • APP_BUILDER • CUSTOM • S1 • SFX Experience • BROWSER • HYBRID Form • DESKTOP • PHONE • TABLET
DEVICE_SESSION_ID
Type Id
888
Standard Objects
Field
Lightning Interaction Event Type
Details Description The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started. Example 321a1ddfaf924803a075f1e69fc87bc06f53ccd0
DURATION
Type Number Description The duration in milliseconds since the page start time.
GRANDPARENT_UI_ELEMENT
Type String Description Grandparent scope of the page element where the event occurred.
LOGIN_KEY
Type String Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type String Description The 15-character ID of the org. Example 00D000000000123
OS_NAME
Type String Description The operating system name, derived from USER_AGENT. Example Android, iOS, OSX, Windows
OS_VERSION
Type String Description The operating system version, derived from USER_AGENT.
889
Standard Objects
Lightning Interaction Event Type
Field
Details
PAGE_CONTEXT
Type String Description Context of the page where the event occurred.
PAGE_ENTITY_ID
Type Id Description The unique entity identifier of the event. Example 0013000000I3zJAAAZ
PAGE_ENTITY_TYPE
Type String Description The entity type of the event. Example Task, contacts
PAGE_START_TIME
Type Number Description The time when the page was initially loaded, measured in milliseconds. Example 1471564788642
PARENT_UI_ELEMENT
Type String Description Parent scope of the page element where the event occurred.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
SDK_APP_TYPE
Type String
890
Standard Objects
Field
Lightning Interaction Event Type
Details Description The mobile SDK application type. Possible Values • HYBRID • HYBRIDLOCAL • HYBRIDREMOTE • NATIVE • REACTNATIVE
SDK_APP_VERSION
Type String Description The mobile SDK application version number. Example 5.0
SDK_VERSION
Type String Description The mobile SDK version number. Example 2.1.0
SESSION_KEY
Type String Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session is started. Example cdd09305cb6babf34059e27f70e47f1b11dec868
TARGET_UI_ELEMENT
Type String Description The target page element where the event occurred. Example label bBody truncate, tabitem-link
TIMESTAMP
Type String
891
Standard Objects
Field
Lightning Interaction Event Type
Details Description The access time of Salesforce services. Example 20130715233322.670
UI_EVENT_SEQUENCE_NUM
Type Number Description An auto-incremented sequence number of the current event since the session started.
UI_EVENT_SOURCE
Type String Description The event source of the error. Example AuraError
UI_EVENT_TIMESTAMP
Type Number Description The time at which this event occurred, measured in milliseconds. Example 1479769912796
UI_EVENT_TYPE
Type String Description The type of interaction. Example User, system, error
USER_AGENT
Type String Description The numeric code for the type of client used to make the request (for example, the browser, application, or API) as a string.
USER_ID
Type String Description The 15-character ID of the user accessing Salesforce services through the UI or API.
892
Standard Objects
Field
Lightning Page View Event Type
Details Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
USER_TYPE
Type String Description The category of user license of the user accessing Salesforce services through the UI or API. Possible Values • A: Automated Process • b: High Volume Portal • C: Customer Portal User • D: External Who • F: Self Service • G: Guest • L: Package License Manager • N: Salesforce to Salesforce • n: CSN Only • O: Power Custom • o: Custom • P: Partner • p: Customer Portal Manager • S: Standard • X: Black Tab User
SEE ALSO: EventLogFile
Lightning Page View Event Type Lightning Page View events represent information about the page on which the event occurred in Lightning Experience. This event type is available in the EventLogFile object in API version 39.0 and later.
893
Standard Objects
Lightning Page View Event Type
For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer’s Guide.
Fields Field
Details
APP_NAME
Type String Description The name of the application that the user accessed.
BROWSER_NAME
Type String Description The name of the browser that the user accessed. Example Chrome, IE, Safari, Gecko
BROWSER_VERSION
Type String Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version.
CLIENT_ID
Type String Description The API client ID.
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CONNECTION_TYPE
Type String Description The type of connection. Possible Values • CDMA1x • CDMA
894
Standard Objects
Field
Lightning Page View Event Type
Details • EDGE • EVDO0 • EVDOA • EVDOB • GPRS • HRPD • HSDPA • HSUPA • LTE • WIFI
DEVICE_ID
Type String Description The unique identifier used to identify a device when tracking events. DEVICE_ID is a generated value that’s created when the mobile app is initially run after installation.
DEVICE_MODEL
Type String Description The name of the device model. Example iPad, iPhone
DEVICE_PLATFORM
Type String Description The type of application experience in name:experience:form format. Possible Values Name • APP_BUILDER • CUSTOM • S1 • SFX Experience • BROWSER • HYBRID Form • DESKTOP • PHONE
895
Standard Objects
Field
Lightning Page View Event Type
Details • TABLET
DEVICE_SESSION_ID
Type Id Description The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started. Example 321a1ddfaf924803a075f1e69fc87bc06f53ccd0
DURATION
Type Number Description The duration in milliseconds since the page start time.
EPT
Type Number Description The effective page time indicating how long it took for the page to load.
GRANDPARENT_UI_ELEMENT
Type String Description The grandparent scope of the page element where the event occurred.
LOGIN_KEY
Type String Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type String Description The 15-character ID of the org. Example 00D000000000123
OS_NAME
Type String
896
Standard Objects
Field
Lightning Page View Event Type
Details Description The operating system name, derived from USER_AGENT. Example Android, iOS, OSX, Windows
OS_VERSION
Type String Description The operating system version, derived from USER_AGENT.
PAGE_CONTEXT
Type String Description The context of the page where the event occurred.
PAGE_ENTITY_ID
Type Id Description The unique entity identifier of the event. Example 0013000000I3zJAAAZ
PAGE_ENTITY_TYPE
Type String Description The entity type of the event. Example Task, contacts
PAGE_START_TIME
Type Number Description The time when the page was initially loaded, measured in milliseconds. Example 1471564788642
PARENT_UI_ELEMENT
Type String Description The parent scope of the page element where the event occurred.
897
Standard Objects
Lightning Page View Event Type
Field
Details
PREVPAGE_CONTEXT
Type String Description The context of the previous page where the event occurred.
PREVPAGE_ENTITY_ID
Type Id Description The unique previous page entity identifier of the event.
PREVPAGE_ENTITY_TYPE
Type String Description The previous page entity type of the event. Example Task, contacts
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
SDK_APP_TYPE
Type String Description The mobile SDK application type. Possible Values • HYBRID • HYBRIDLOCAL • HYBRIDREMOTE • NATIVE • REACTNATIVE
SDK_APP_VERSION
Type String Description The mobile SDK application version number.
898
Standard Objects
Field
Lightning Page View Event Type
Details Example 5.0
SDK_VERSION
Type String Description The mobile SDK version number. Example 2.1.0
SESSION_KEY
Type String Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session is started. Example cdd09305cb6babf34059e27f70e47f1b11dec868
TARGET_UI_ELEMENT
Type String Description The target page element where the event occurred. Example label bBody truncate, tabitem-link
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
UI_EVENT_SEQUENCE_NUM
Type Number Description An auto-incremented sequence number of the current event since the session started.
UI_EVENT_SOURCE
Type String Description The event source of the error.
899
Standard Objects
Field
Lightning Page View Event Type
Details Example AuraError
UI_EVENT_TIMESTAMP
Type Number Description The time at which this event occurred, measured in milliseconds. Example 1479769912796
UI_EVENT_TYPE
Type String Description The type of interaction. Example User, system, error
USER_AGENT
Type String Description The numeric code for the type of client used to make the request (for example, the browser, application, or API) as a string.
USER_ID
Type String Description The 15-character ID of the user accessing Salesforce services through the UI or API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
USER_TYPE
Type String Description The category of user license of the user accessing Salesforce services through the UI or API.
900
Standard Objects
Field
Lightning Performance Event Type
Details Possible Values • A: Automated Process • b: High Volume Portal • C: Customer Portal User • D: External Who • F: Self Service • G: Guest • L: Package License Manager • N: Salesforce to Salesforce • n: CSN Only • O: Power Custom • o: Custom • P: Partner • p: Customer Portal Manager • S: Standard • X: Black Tab User
SEE ALSO: EventLogFile
Lightning Performance Event Type Lightning Performance events track trends in your Lightning Experience performance. This event type is available in the EventLogFile object in API version 39.0 and later. For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer’s Guide.
Fields Field
Details
APP_NAME
Type String Description The name of the application that the user accessed.
BROWSER_NAME
Type String Description The name of the browser that the user accessed.
901
Standard Objects
Field
Lightning Performance Event Type
Details Example Chrome, IE, Safari, Gecko
BROWSER_VERSION
Type String Description The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version.
CLIENT_ID
Type String Description The API client ID.
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CONNECTION_TYPE
Type String Description The type of connection. Possible Values • CDMA1x • CDMA • EDGE • EVDO0 • EVDOA • EVDOB • GPRS • HRPD • HSDPA • HSUPA • LTE • WIFI
DEVICE_ID
Type String
902
Standard Objects
Field
Lightning Performance Event Type
Details Description The unique identifier used to identify a device when tracking events. DEVICE_ID is a generated value that’s created when the mobile app is initially run after installation.
DEVICE_MODEL
Type String Description The name of the device model. Example iPad, iPhone
DEVICE_PLATFORM
Type String Description The type of application experience in name:experience:form format. Possible Values Name • APP_BUILDER • CUSTOM • S1 • SFX Experience • BROWSER • HYBRID Form • DESKTOP • PHONE • TABLET
DEVICE_SESSION_ID
Type Id Description The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started. Example 321a1ddfaf924803a075f1e69fc87bc06f53ccd0
DURATION
Type Number
903
Standard Objects
Field
Lightning Performance Event Type
Details Description The duration in milliseconds since the page start time.
LOGIN_KEY
Type String Description The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type String Description The 15-character ID of the org. Example 00D000000000123
OS_NAME
Type String Description The operating system name, derived from USER_AGENT. Example Android, iOS, OSX, Windows
OS_VERSION
Type String Description The operating system version, derived from USER_AGENT.
PAGE_START_TIME
Type Number Description The time when the page was initially loaded, measured in milliseconds. Example 1471564788642
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
904
Standard Objects
Field
Lightning Performance Event Type
Details Example 3nWgxWbDKWWDIk0FKfF5DV
SDK_APP_TYPE
Type String Description The mobile SDK application type. Possible Values • HYBRID • HYBRIDLOCAL • HYBRIDREMOTE • NATIVE • REACTNATIVE
SDK_APP_VERSION
Type String Description The mobile SDK application version number. Example 5.0
SDK_VERSION
Type String Description The mobile SDK version number. Example 2.1.0
SESSION_KEY
Type String Description The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session is started. Example cdd09305cb6babf34059e27f70e47f1b11dec868
TIMESTAMP
Type String Description The access time of Salesforce services.
905
Standard Objects
Field
Lightning Performance Event Type
Details Example 20130715233322.670
UI_EVENT_SOURCE
Type String Description The event source of the error. Example AuraError
UI_EVENT_TIMESTAMP
Type Number Description The time at which this event occurred, measured in milliseconds. Example 1479769912796
UI_EVENT_TYPE
Type String Description The type of interaction. Example User, system, error
USER_AGENT
Type String Description The numeric code for the type of client used to make the request (for example, browser, application, or API) as a string.
USER_ID
Type String Description The 15-character ID of the user accessing Salesforce services through the UI or API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API.
906
Standard Objects
Field
Login Event Type — LOGIN_STATUS Values
Details Example 00590000000I1SNIA0
USER_TYPE
Type String Description The category of user license of the user accessing Salesforce services through the UI or API. Possible Values • A: Automated Process • b: High Volume Portal • C: Customer Portal User • D: External Who • F: Self Service • G: Guest • L: Package License Manager • N: Salesforce to Salesforce • n: CSN Only • O: Power Custom • o: Custom • P: Partner • p: Customer Portal Manager • S: Standard • X: Black Tab User
SEE ALSO: EventLogFile
Login Event Type — LOGIN_STATUS Values When users attempt to log in to your org, the success or failure of their login attempts is tracked in event log file data. Specifically, the LOGIN_STATUS field in the Login event type contains the result of these login attempts. The data in LOGIN_STATUS can help you determine whether your users’ login attempts were successful. This field is available in the Login event type in the EventLogFile object in API version 39.0 and later. For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer’s Guide. API Error Code
Details (If Available)
LOGIN_CHALLENGE_ISSUED
Failed: Computer activation required
LOGIN_CHALLENGE_PENDING
Failed: Computer activation pending
907
Standard Objects
API Error Code
Login Event Type — LOGIN_STATUS Values
Details (If Available)
LOGIN_DATA_DOWNLOAD_ONLY LOGIN_END_SESSION_TXN_SECURITY_POLICY LOGIN_ERROR_APPEXCHANGE_DOWN
Unable to process your login request
LOGIN_ERROR_ASYNC_USER_CREATE LOGIN_ERROR_AVANTGO_DISABLED LOGIN_ERROR_AVANTGO_TRIAL_EXP LOGIN_ERROR_CLIENT_NO_ACCESS LOGIN_ERROR_CLIENT_REQ_UPDATE
Failed: Client update required
LOGIN_ERROR_CSS_FROZEN LOGIN_ERROR_CSS_PW_LOCKOUT LOGIN_ERROR_DUPLICATE_USERNAME LOGIN_ERROR_EXPORT_RESTRICTED
Restricted country
LOGIN_ERROR_GLOBAL_BLOCK_DOMAIN
Restricted domain
LOGIN_ERROR_HT_DOWN LOGIN_ERROR_HTP_METHD_INVALID
Failed: Invalid HTTP method
LOGIN_ERROR_INSECURE_LOGIN
Failed: Login over insecure channel
LOGIN_ERROR_INVALID_GATEWAY
Invalid gateway
LOGIN_ERROR_INVALID_ID_FIELD LOGIN_ERROR_INVALID_PASSWORD
Invalid password
LOGIN_ERROR_INVALID_USERNAME
Invalid login
LOGIN_ERROR_LOGINS_EXCEEDED
Maximum logins exceeded
LOGIN_ERROR_MUST_USE_API_TOKEN
Failed: API security token required
LOGIN_ERROR_MUTUAL_AUTHENTICATION
Mutual authentication failed
LOGIN_ERROR_NETWORK_INACTIVE
Invalid - community offline
LOGIN_ERROR_NO_HT_ACCESS LOGIN_ERROR_NO_NETWORK_ACCESS
No community access
LOGIN_ERROR_NO_NETWORK_INFO LOGIN_ERROR_NO_PORTAL_ACCESS
Invalid profile association
LOGIN_ERROR_NO_SET_COOKIES LOGIN_ERROR_OFFLINE_DISABLED
Offline disabled
908
Standard Objects
Login Event Type — LOGIN_STATUS Values
API Error Code
Details (If Available)
LOGIN_ERROR_OFFLINE_TRIAL_EXP
Offline trial expired
LOGIN_ERROR_ORG_CLOSED
Organization closed
LOGIN_ERROR_ORG_DOMAIN_ONLY
Restricted domain
LOGIN_ERROR_ORG_IN_MAINTENANCE
Organization is in maintenance
LOGIN_ERROR_ORG_INACTIVE
Organization is inactive
LOGIN_ERROR_ORG_IS_DOT_ORG
Organization is a DOT
LOGIN_ERROR_ORG_LOCKOUT
Organization locked
LOGIN_ERROR_ORG_SIGNING_UP LOGIN_ERROR_ORG_SUSPENDED
Organization suspended
LOGIN_ERROR_OUTLOOK_DISABLED
Outlook integration disabled
LOGIN_ERROR_PAGE_REQUIRES_LOGIN LOGIN_ERROR_PASSWORD_EMPTY LOGIN_ERROR_PASSWORD_LOCKOUT
Password lockout
LOGIN_ERROR_PORTAL_INACTIVE
Invalid - Portal disabled
LOGIN_ERROR_RATE_EXCEEDED
Login rate exceeded
LOGIN_ERROR_RESTRICTED_DOMAIN
Restricted IP
LOGIN_ERROR_RESTRICTED_TIME
Restricted time
LOGIN_ERROR_SESSION_TIMEOUT LOGIN_ERROR_SSO_PWD_INVALID
Invalid password
LOGIN_ERROR_SSO_SVC_DOWN
Your company's authentication service is down
LOGIN_ERROR_SSO_URL_INVALID
The Single Sign-On Gateway URL is invalid
LOGIN_ERROR_STORE LOGIN_ERROR_STORE_DOWN LOGIN_ERROR_SWITCH_SFDC_INSTANCE LOGIN_ERROR_SWITCH_SFDC_LOGIN LOGIN_ERROR_SYNCOFFLINE_DISBLD
Failed: Mobile disabled
LOGIN_ERROR_SYSTEM_DOWN LOGIN_ERROR_UNKNOWN_ERROR
Login invalid
LOGIN_ERROR_USER_API_ONLY
Failed: API-only user
LOGIN_ERROR_USER_FROZEN
User is frozen
909
Standard Objects
Login Event Type — LOGIN_STATUS Values
API Error Code
Details (If Available)
LOGIN_ERROR_USER_INACTIVE
User is inactive
LOGIN_ERROR_USER_NON_MOBILE
Failed: Mobile license required
LOGIN_ERROR_USER_STORE_ACCESS LOGIN_ERROR_USERNAME_EMPTY LOGIN_ERROR_WIRELESS_DISABLED
Wireless disabled
LOGIN_ERROR_WIRELESS_TRIAL_EXP
Wireless trial expired
LOGIN_LIGHTNING_LOGIN
Lightning Login required
LOGIN_NO_ERROR LOGIN_OAUTH_API_DISABLED
Failed: OAuth API access disabled
LOGIN_OAUTH_CONSUMER_DELETED
Failed: Consumer Deleted
LOGIN_OAUTH_DS_NOT_EXPECTED
Failed: Activation secret not expected
LOGIN_OAUTH_EXCEED_GET_AT_LMT
Failed: Get Access Token Limit Exceeded
LOGIN_OAUTH_INVALID_CODE_CHALLENGE
Failed: Invalid Code Challenge
LOGIN_OAUTH_INVALID_CODE_VERIFIER
Failed: Invalid Code Verifier
LOGIN_OAUTH_INVALID_DEVICE
Failed: Device Id missing or not registered
LOGIN_OAUTH_INVALID_DS
Failed: Activation secret invalid
LOGIN_OAUTH_INVALID_DSIG
Failed: Signature Invalid
LOGIN_OAUTH_INVALID_IP
Failed: IP Address Not Allowed
LOGIN_OAUTH_INVALID_NONCE
Failed: Invalid Nonce
LOGIN_OAUTH_INVALID_SIG_METHOD
Failed: Invalid Signature Method
LOGIN_OAUTH_INVALID_TIMESTAMP
Failed: Invalid Timestamp
LOGIN_OAUTH_INVALID_TOKEN
Failed: Invalid Token
LOGIN_OAUTH_INVALID_VERIFIER
Failed: Invalid Verifier
LOGIN_OAUTH_INVALID_VERSION
Failed: Version Not Supported
LOGIN_OAUTH_MISSING_DS
Activation secret missing
LOGIN_OAUTH_NO_CALLBACK_URL
Failed: Invalid Callback URL
LOGIN_OAUTH_NO_CONSUMER
Missing Consumer Key Parameter
LOGIN_OAUTH_NO_TOKEN
Missing OAuth Token Parameter
LOGIN_OAUTH_NONCE_REPLAY
Failed: Nonce Replay Detected
LOGIN_OAUTH_PACKAGE_MISSING
Package for this consumer is not installed in your organization
910
Standard Objects
Login Event Type — LOGIN_STATUS Values
API Error Code
Details (If Available)
LOGIN_OAUTH_PACKAGE_OLD
Installed package for this consumer is out of date
LOGIN_OAUTH_UNEXPECTED_PARAM
Failed: Unexpected parameter
LOGIN_ORG_TRIAL_EXP
Trial Expired
LOGIN_READONLY_CANNOT_VALIDATE LOGIN_SAML_INVALID_AUDIENCE
Failed: Audience Invalid
LOGIN_SAML_INVALID_CONFIG
Failed: Configuration Error/Perm Disabled
LOGIN_SAML_INVALID_FORMAT
Failed: Assertion Invalid
LOGIN_SAML_INVALID_IN_RES_TO
Failed: InResponseTo Invalid
LOGIN_SAML_INVALID_ISSUER
Failed: Issuer Mismatched
LOGIN_SAML_INVALID_ORG_ID
Failed: Invalid Organization Id
LOGIN_SAML_INVALID_PORTAL_ID
Failed: Invalid Portal Id
LOGIN_SAML_INVALID_RECIPIENT
Failed: Recipient Mismatched
LOGIN_SAML_INVALID_SESSION_LEVEL LOGIN_SAML_INVALID_SIGNATURE
Failed: Signature Invalid
LOGIN_SAML_INVALID_SITE_URL
Failed: Invalid Site URL
LOGIN_SAML_INVALID_STATUS
Failed: Status Invalid
LOGIN_SAML_INVALID_SUB_CONFIRM
Failed: Subject Confirmation Error
LOGIN_SAML_INVALID_TIMESTAMP
Failed: Assertion Expired
LOGIN_SAML_INVALID_USERNAME
Failed: Username Or SSO Id Invalid
LOGIN_SAML_INVALID_VERSION LOGIN_SAML_MISMATCH_CERT
Failed: Signature Invalid/Configured Certificate Mismatch
LOGIN_SAML_MISSING_ORG_ID
Failed: Missing Organization Id for Portal login
LOGIN_SAML_MISSING_PORTAL_ID
Failed: Missing Portal Id
LOGIN_SAML_PROVISION_ERROR
Failed: SAML Provision Error
LOGIN_SAML_REPLAY_ATTEMPTED
Failed: Replay Detected
LOGIN_SAML_SITE_INACTIVE
Failed: Specified Site is Inactive
LOGIN_TWOFACTOR_REQ
Two-factor required
Usage Use LOGIN_STATUS to determine whether your users’ login attempts were successful. For example, you can determine whether a departed employee attempted to log in successfully or unsuccessfully.
911
Standard Objects
Report Event Type
SEE ALSO: EventLogFile
Report Event Type Report events contain information about what happened when a user ran a report. For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer’s Guide.
Fields Field
Details
AVERAGE_ROW_SIZE
Type Number Description The average row size of all rows in the Report event, in bytes. A large average size, coupled with a high ROW_COUNT, can indicate that a user is downloading information for fraudulent purposes. For example, a salesperson who downloads all sales leads before departing for a competitor. Example 700
CLIENT_IP
Type IP Description The IP address of the client that’s using Salesforce services. Example 96.43.144.26
CPU_TIME
Type Number Description The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
912
Standard Objects
DB_BLOCKS
Report Event Type
Type Number Description Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type Number Description Allows you to monitor trends in database uptime.
DB_TOTAL_TIME
Type Number Description The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
DISPLAY_TYPE
Type String Description The report display type, indicating the run mode of the report. Possible Values • D: Dashboard • S: Show Details • H: Hide Details
ENTITY_NAME
Type String Description The name of the object affected by the trigger.
EVENT_TYPE
Type String Description The type of event. Example ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type String
913
Standard Objects
Report Event Type
Description The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring. Example GeJCsym5eyvtEK2I NUMBER_BUCKETS
Type Number Description The number of buckets that were used in the report.
NUMBER_COLUMNS
Type Number Description The number of columns in the report.
NUMBER_EXCEPTION_FILTERS
Type Number Description The number of exception filters that are used in the report.
ORGANIZATION_ID
Type Id Description The 15-character ID of the organization. Example 00D000000000123
RENDERING_TYPE
Type String Description The report rendering type, describing the format of the report output. Possible Values • W: Web (HTML) • E: Email • P: Printable • X: Excel • C: Comma-separated values (CSV) • J: JavaScript Object Notation (JSON)
914
Standard Objects
REPORT_ID
Report Event Type
Type Id Description The 15-character ID of the report that was run.
REPORT_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the report that was run.
REQUEST_ID
Type String Description The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID. Example 3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type String Description The status of the request for a page view or user interface action. Possible Values • S: Success • F: Failure • U: Undefined • A: Authorization Error • R: Redirect • N: Not Found
ROW_COUNT
Type Number Description The number of rows that were processed in the Report event. High row counts, coupled with a high AVERAGE_ROW_SIZE, can indicate that a user is downloading information for fraudulent purposes. For example, a salesperson who downloads all sales leads before departing for a competitor. Example 150
915
Standard Objects
RUN_TIME
Report Event Type
Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY
Type String Description The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page. Example d7DEq/ANa7nNZZVD
SORT
Type String Description The sort column and order that was used in the report.
TIMESTAMP
Type String Description The access time of Salesforce services. Example 20130715233322.670
TIMESTAMP_DERIVED
Type Datetime Description The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ) Example 2015-07-27T11:32:59.555Z
URI
Type String Description The URI of the page that’s receiving the request. Example /home/home.jsp
URI_ID_DERIVED
Type ID
916
Standard Objects
EventRelation
Description The 18-character case insensitive ID of the URI of the page that’s receiving the request. USER_ID
Type Id Description The 15-character ID of the user who’s using Salesforce services through the UI or the API. Example 00530000009M943
USER_ID_DERIVED
Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. Example 00590000000I1SNIA0
Usage Example: Identify Large Report Exports by User Get Report event type data from the EventLogFile object using REST: /services/data/v40.0/query?q=SELECT+Id+,+EventType+,+LogFile+,+LogDate+,+LogFileLength+FROM+EventLogFile+WHERE+ LogDate+>+Yesterday+AND+EventType+=+'Report'
After you download the report data to a ReportData database table, query it and filter on reports that were exported with high row counts and size: SELECT USER_ID FROM ReportData WHERE (RENDERING_TYPE=C OR RENDERING_TYPE=X OR RENDERING_TYPE=P) AND ROW_COUNT>150000 AND AVERAGE_ROW_SIZE>1500
SEE ALSO: EventLogFile
EventRelation Represents a person (a user, lead, or contact) or a resource (such as a conference room) invited to an event. This object lets you add or remove invitees from an event and use the API to manage invitees’ responses to invitations. If Shared Activities is enabled, EventRelation can also represent other objects that are related to an event. EventRelation does not support triggers, workflow, or data validation rules. EventRelation allows a variable number of relationships and handles deleted events differently, depending on whether Shared Activities is enabled.
917
Standard Objects
EventRelation
A non-recurring event can have up to 1,000 invitees. A recurring event can have up to 100 invitees. If Shared Activities Isn’t Enabled • EventRelation records only represent invitees (contacts, users, and resources). • An event can be related to one contact or lead. If Shared Activities Is Enabled • EventRelation records can represent: – Invitees (IsInvitee= is set to true) OR – Related contacts or lead (IsParent is set to true) • An event can be related to up to 50 contacts or one lead. These people may or may not be invitees. The number of allowed invitees is not affected by the number of related contacts. If a contact or lead is also an invitee, there is one EventRelation record for that person with IsInvitee and IsParent are set to true. • An event can be related to a lead, contact, resource, account, or opportunity. • An event can be related to a custom object that has the HasActivities attribute set to true. • If you delete an event, then relations between the event and any specified contacts, leads, and other records are also deleted. • If you delete the EventRelation record representing a relation then the corresponding relation field may be cleared on the event. • If you delete the EventRelation record representing the WhoId on an event, then another Who, if any, from the event’s EventWhoIds field will be promoted to the WhoId. • If you restore a deleted event, relations between the event and any specified contacts, leads, and records are also restored. The WhoId, WhatId, and AccountId field values are recalculated using the field values on EventRelation. Whether or not Shared Activities is enabled, an event can be related to one other kind of record, such as an account, an opportunity, or a custom object. Note: • With API versions 26.0 and later, the EventRelation object replaces the EventAttendee object, and the EventAttendee object is no longer visible. You can still query the EventAttendee object using packages that support API versions 25.0 and earlier, or by using Apex. • An EventRelation object can’t be created for a child event. • EventRelation includes deactivated users. • In API versions 25.0 and earlier, you can’t use query(), delete(), or update() with events related to more than one contact.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), queryAll(), retrieve(), update(), upsert()
918
Standard Objects
EventRelation
Fields Field
Details
AccountId
Type reference Properties Filter, Group, Nillable, Sort Description Contains the Account ID of the relation. For information on IDs, see ID Field Type. AccountId is visible when Shared Activities is enabled.
EventId
Type reference Properties Create, Filter, Group, Sort Description Contains the ID of the event. This value can’t be changed after it’s been specified.
IsDeleted
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
IsInvitee
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the relation is an invitee. • IsInvitee is visible while Shared Activities is being enabled, after it has been enabled, and while it is being disabled. • IsInvitee defaults to true while Shared Activities is being enabled, after it has been enabled, and while it is being disabled if IsInvitee, IsParent, and IsWhat are not set. This configuration ensures compatibility when Shared Activities isn’t enabled and EventRelation represents event invitees only. • IsInvitee defaults to false when Shared Activities is enabled if IsParent is set to true.
IsParent
Type boolean
919
Standard Objects
Field
EventRelation
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update Description IsParent is visible only when Shared Activities is enabled. When false, indicates that the relation is an invitee (a contact, lead, or user). When true, indicates that the relation is a Who or What, as determined by IsWhat field.
IsWhat
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description IsWhat is visible only when Shared Activities is enabled. The value is relevant only if IsParent is true. When IsWhat is true, the relation specified by RelationId is a What (an account, opportunity, custom object, etc.). When IsWhat is false, the relation specified by RelationId is a Who (a contact,
lead, or user). RelationId
Type reference Properties Create, Filter, Group, Sort Description Contains the ID of the person (User, Contact, or Lead) or the resource invited to an event. When Shared Activities is enabled, RelationId can also contain the ID of an account, opportunity, or other object related to an event. This value can’t be changed after it’s been specified.
RespondedDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the most recent date and time when the invitee responded to an invitation to an event.
Response
Type string Properties Create, Filter, Group, Nillable, Sort, Update
920
Standard Objects
Field
EventRelation
Details Description Contains optional text that the invitee can enter when responding to an invitation to an event.
Status
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the invitee status with one of the following values: • New: Invitee has received the invitation but hasn’t yet responded. This value is the default. • Declined: Invitee has declined the invitation. • Accepted: Invitee has accepted the invitation. Note: Uninvited and Maybe aren’t currently supported.
Usage • Invitee related lists display slightly different content. In Salesforce1, the invitee related list includes invitees only, whereas in the full site, it also includes the event owner. To reproduce the full site functionality in Salesforce1, use the following API queries. If you use Shared Activities in your Salesforce org, use this query: SELECT RelationId FROM EventRelation WHERE isInvitee = true AND eventId='[Event_Id]'
where Event_Id is the child event’s ID. If you don’t use Shared Activities, use this query: SELECT RelationId FROM EventRelation WHERE eventId='[Event_Id]'
These queries get the main event’s relations and display them for the given child event. To further filter the results, add a WHERE clause. Send email notifications To send email notifications for a given event, query EventRelation for the event, iterate through the list, examine the status, and send email notifications to every person who accepted the invitation. Determine what events a given invitee is attending To determine all the events that a particular person is attending during a given time period (for example, next week), you can have a client application query the Event object for a given date range, iterate through the results, and, for each event, query the EventRelation object to determine whether the particular person (RelationId) has accepted an invitation to that event. Create an invitee if Shared Activities is enabled (or during the process of enabling it or rolling back) If the invitee is already a contact or lead, update IsInvitee to true. If the invitee is not already a contact or lead, create an EventRelation object for the invitee with IsInvitee set to true.
921
Standard Objects
EventRelation
Create an invitee if Shared Activities is not enabled Create an EventRelation object for the invitee. Query relations to a contact or a lead List whoRelations = [SELECT Id, Relation.Name FROM EventRelation WHERE EventId = '00UD0000005zijD' AND isParent = true AND isWhat = false];
Query invitee relations List inviteeRelations = [SELECT Id, Relation.Name FROM EventRelation WHERE EventId = '00UD0000005zijD' AND isInvitee = true];
Update an invitee relation to a contact or lead invitee relation EventRelation er = [SELECT Id FROM EventRelation WHERE EventId = '00UD0000005zijD' AND isInvitee = true and isParent = false LIMIT 1]; er.isParent = true; update er;
Update a contact or lead relation to a contact or lead invitee relation EventRelation er = [SELECT Id FROM EventRelation WHERE EventId = '00UD0000005zijD' AND isParent = true and isInvitee = false LIMIT 1]; er.isInvitee = true; update er;
Insert a contact or lead relation EventRelation er = new EventRelation(EventId = '00UD0000005zijH', RelationId = '003D000000Q8aeV', isParent = true, isInvitee = false); insert er;
Insert an invitee relation If isParent, isWhat and IsInvitee are not set, and RelationId is a contact, lead, user, or calendar, IsInvitee defaults to true. This means if an EventRelation isn’t specifically inserted as a relation to a contact or lead, it’s treated as an Invitee relation by default. EventRelation er = new EventRelation(EventId = '00UD0000005zijH', RelationId = '003D000000Q8adV'); insert er;
Reproduce invitee related list functionality in Salesforce1 Invitee related lists display slightly different content in Salesforce1 and the full site. In Salesforce1, the invitee related list includes invitees only, whereas in the full site, it also includes the event owner. If you use Shared Activities in your Salesforce org, use the following query to reproduce the full site functionality in Salesforce1: SELECT RelationId FROM EventRelation WHERE isInvitee = true AND eventId='[Event_Id]'
where Event_Id is the child event’s ID. If you don’t use Shared Activities, use this query: SELECT RelationId FROM EventRelation WHERE eventId='[Event_Id]'
922
Standard Objects
EventTag
These queries get the main event’s relations and display them for the given child event. To further filter the results, add a WHERE clause. SEE ALSO: Event EventWhoRelation Object Basics
EventTag Associates a word or short phrase with an Event.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve()
Fields Field Name
Details
ItemId
Type reference Properties Create, Filter Description ID of the tagged item.
Name
Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically.
TagDefinitionId
Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag.
923
Standard Objects
EventWhoRelation
Field Name
Details
Type
Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: • Public—The tag can be viewed and manipulated by all users in an organization. • Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId.
Usage EventTag stores the relationship between its parent TagDefinition and the Event being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries.
EventWhoRelation Represents the relationship between an event and a lead or contacts. This derived object is a filtered version of the EventRelation on page 917 object; that is, IsParent is true and IsWhat is false. It doesn’t represent relationships to invitees or to accounts, opportunities, or other objects. This object is available in API versions 29.0 and later. EventWhoRelation allows a variable number of relationships: one lead or up to 50 contacts. Available only if you’ve enabled Shared Activities for your organization. Note: EventWhoRelation objects aren’t created for child events.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
EventId
Type reference Properties Filter, Group, Nillable, Sort
924
Standard Objects
Field Name
ExternalDataSource
Details Description Indicates the ID of the event.
RelationId
Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the contacts or lead related to the event.
Type
Type string Properties Filter, Group, Nillable, Sort Description Indicates whether the person related to the event is a contact or lead.
Usage Apex example that queries relations to a contact or lead List whoRelations = [SELECT Id, Relation.Name FROM EventWhoRelation WHERE EventId = '00UD0000005zijD'];
SEE ALSO: Event EventRelation
ExternalDataSource Represents an external data source, which defines connection details for integration with data and content that are stored outside the Salesforce org. This object is available in API version 27.0 and later.
Supported Calls describeSObjects(), query(), retrieve()
925
Standard Objects
ExternalDataSource
Fields Field Name
Details
AuthProviderId
Type reference Properties Filter, Group, Nillable, Sort Description Salesforce ID of the authentication provider, which defines the service that provides the login process and approves access to the external system. Only users with the “Customize Application” and “Manage AuthProviders” permissions can view this field. This field is available in API version 39.0 and later.
CustomConfiguration
Type textarea Properties Nillable Description A JSON-encoded configuration string that defines parameters specific to the type of external data source.
DeveloperName
Type string Properties Filter, Group, Sort 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. Note: 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.
Endpoint
Type textarea Properties Nillable
926
Standard Objects
Field Name
ExternalDataSource
Details Description The URL of the external system, or if that URL is defined in a named credential, the named credential URL. A named credential URL contains the scheme callout:, the name of the named credential, and an optional path. For example: callout:My_Named_Credential/some_path. You can append a query string to a named credential URL. Use a question mark (?) as the separator between the named credential URL and the query string. For example: callout:My_Named_Credential/some_path?format=json.
isWritable
Type boolean Properties Defaulted on create, Filter, Group, Query, Sort Description Lets the Force.com platform and users in this org create, update, and delete records for external objects associated with the external data source. The external object data is stored outside the org. By default, external objects are read only. Available only for Salesforce Connect external data sources. Available in API version 35.0 and later. However, with the cross-org adapter for Salesforce Connect, you can set this field to true only in API version 39.0 and later.
Language
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the MasterLabel.
MasterLabel
Type string Properties Filter, Group, Sort Description Master label for the external data source. This internal label doesn’t get translated.
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can
927
Standard Objects
Field Name
ExternalDataSource
Details refer to a component in a managed package by using the namespacePrefix__componentName notation.
PrincipalType
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Specifies whether the org uses one set (NamedUser), multiple sets (PerUser), or no (Anonymous) credentials to access the external system. Each set of credentials corresponds to a login account on the external system. Corresponds to Identity Type in the user interface.
Protocol
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Specifies whether to use OAuth, password authentication, or no authentication to access the external system. Some types of external data sources support only one value. • For cloud-based Files Connect external systems, select Oauth 2.0. • For on-premises systems, select Password Authentication. • For Simple URL data sources, select No Authentication.
Repository
Type string Properties Filter, Group, Nillable, Sort Description Used for SharePoint Online. An optional name of the repository in the data source. Not applicable to all data source types.
Type
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Specifies the adapter that connects to the external system.
928
Standard Objects
ExternalDataUserAuth
Usage Define an external data source to connect to data or content that’s stored outside the Salesforce org. Then create external objects, which map to the external system’s data and behave similarly to custom objects. SEE ALSO: ExternalDataUserAuth NamedCredential
ExternalDataUserAuth Stores authentication settings for a Salesforce user to access an external system. The external system must be defined in an external data source or a named credential that’s configured to use per-user authentication. This object is available in API version 27.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
AuthProviderId
Type reference Properties Filter, Group, Nillable, Sort Description Salesforce ID of the authentication provider, which defines the service that provides the login process and approves access to the external system. Only users with the “Customize Application” and “Manage AuthProviders” permissions can view this field. This field is available in API version 39.0 and later.
ExternalDataSourceId
Type reference Properties Create, Filter, Group, Sort Description Salesforce ID of the external data source or named credential that defines the external system.
Password
Type encrypted string
929
Standard Objects
Field Name
ExternalDataUserAuth
Details Properties Create, Nillable, Update Description Password portion of the credentials for the Salesforce user to access the external system.
Protocol
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether to use OAuth, password authentication, or no authentication when the user accesses the external system.
UserId
Type reference Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description ID of the Salesforce user who’s accessing the external system.
Username
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Username portion of the credentials for the Salesforce user to access the external system.
Usage These authentication settings enable a Salesforce user to access an external system. The external system is defined in Salesforce as one of the following. • External data source—Provides access to external objects, whose data is stored outside the Salesforce organization. • Named credential—Enables the user’s actions to trigger authenticated callouts to the endpoint that’s specified in the named credential.
930
Standard Objects
FeedAttachment
If you grant users access to the external data source or named credential via permission sets or profiles, those users can manage their own authentication settings. See “Store Authentication Settings for External Systems” in the Salesforce Help. SEE ALSO: ExternalDataSource NamedCredential
FeedAttachment Represents an attachment to a feed item, such as a file attachment or a link. Use FeedAttachment to add various attachments to one feed item. This object is available in API version 36.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Special Access Rules • You can read, create, update, or delete a FeedAttachment only if you have the corresponding access to the associated FeedItem. • Inline images aren’t creatable, updatable, or deletable through SOAP API.
Fields Field Name
Details
FeedEntityId
Type reference Properties Create, Filter, Group, Sort Description The ID of the associated feed entity that contains this attachment. Currently, the only feed entity supported is FeedItem.
RecordId
Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the record that this feed attachment contains. For inline images, RecordId is a ContentDocument ID. For content attachments, RecordId is a ContentVersion ID.
Title
Type string
931
Standard Objects
Field Name
FeedAttachment
Details Properties Create, Filter, Group, Nillable, Sort, Update Description The title of this feed attachment. When Type is Link, Title value is the label for the attachment link. Otherwise, Title value isn’t used.
Type
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of this feed attachment. Valid values are: • Content—A content attachment. • FeedEntity—A feed entity, for example, a post that is shared. Available in API version 39 and later in Lightning Experience. • InlineImage—An inline image. The system creates an inline image attachment when an image is added to the body of the associated FeedItem. You can’t add an inline image directly by using FeedAttachment. • Link—A link.
Value
Type string Properties Create, Filter, Nillable, Sort, Update Description The string value of this FeedAttachment. This field is optional. If the feed attachment is a Link FeedAttachment, the value is the link URL string.
Usage • This Apex example shows how to add an attachment to a Lead using API version 36.0 and later. First, post a feed item. //create and insert post FeedItem post = new FeedItem(); post.Body = 'HelloThere'; post.ParentId = 'ID_OF_LEAD_ENTITY'; post.Title = 'FileName'; insert post;
Then insert the attachment. //create and associate a content attachment to the post FeedAttachment feedAttachment = new FeedAttachment(); feedAttachment.FeedEntityId = post.Id;
932
Standard Objects
FeedComment
feedAttachment.RecordId = 'ID_OF_CONTENT_VERSION'; feedAttachment.Title = 'FileName'; feedAttachment.Type = 'CONTENT'; insert feedAttachment;
• You can only create one link attachment (FeedAttachment of type Link) per feed item. • If the feed item type is one of the following, you can add content or link feed attachments to a FeedItem. – AdvancedTextPost – TextPost – ContentPost – LinkPost – QuestionPost • When a FeedAttachment is added or removed from a feed item, Salesforce updates the type of the feed item to its most appropriate value, as follows. – If all content feed attachments are removed from a feed item of type ContentPost, the type of this feed item is updated to TextPost. – Conversely, if a content feed attachment is added to a feed item of type TextPost, the type of this feed item is updated to ContentPost. – If all link feed attachments are removed from a feed item of type LinkPost, the type of this feed item is updated to TextPost. – Conversely, if a link feed attachment is added to a feed item of type TextPost, the type of this feed item is updated to LinkPost. – The type of all other feed items, such as QuestionPost or AdvancedTextPost feed items, doesn’t change when any feed attachments are added or removed. – If a content feed attachment is added to a feed item of type LinkPost, the feed item type is updated to ContentPost. – If all content attachments are removed from a feed item of type ContentPost, but there's also a link attachment, the feed item type is updated to LinkPost. • Those without administrator privileges can’t retrieve a FeedAttachment by its ID in a SOQL query. They can retrieve attachments by specifying the associated FeedEntityId, as follows: SELECT Id FROM FeedAttachment WHERE FeedEntityId = 'some_feedItem_id'
• Alternatively, retrieve attachments by using a SOQL query on FeedItem with a subquery on the FeedAttachments child relationship, as follows. SELECT Body, (SELECT RecordId, Title, Type, Value FROM FeedAttachments) FROM FeedItem WHERE Id = 'some_feedItem_id'
• FeedAttachment is not a triggerable object. You can access feed attachments in FeedItem update triggers by retrieving them through a SOQL query. For a trigger example, and to learn about trigger considerations for FeedAttachment, see Triggers for Chatter Objects in the Apex Developer Guide.
FeedComment Represents a comment added to a feed by a user. This object is available in API version 18.0 and later.
933
Standard Objects
FeedComment
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), search(), update(), upsert()
Special Access Rules Note the following when working with feed comments. • You must have read access to the feed’s parent type to see a FeedComment record. • You must have access to the feed to add a comment. • If the comment is related to a user record, the user can delete the comment. For example, if John Smith makes a comment about Sasha Jones, Sasha can delete the comment. • If the logged-in user has the “Insert System Field Values for Chatter Feeds” user permission, the create field property is available on CreatedBy and CreatedDate system fields. During migration, the logged-in user can set these fields to the original post’s author and creation date. The fields can’t be updated after migration. You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the object associated with the feed and delete permission on the parent feed • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see. • “Manage Unlisted Groups” Only users with this permission can delete items in unlisted groups.
Fields Field
Details
CommentBody
Type textarea Properties Create, Filter, Sort, Update Description The text in the comment.
CommentType
Type reference Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of comment: • ContentComment—an uploaded file on a comment • TextComment—a direct text entry on a comment
934
Standard Objects
Field
FeedComment
Details Before API version 24.0, a text entry was required on a comment. As of version 24.0, a text entry is optional if the CommentType is ContentComment.
FeedItemId
Type reference Properties Create, Filter, Group, Sort Description ID of the feed containing the comment.
InsertedById
Type reference Properties Filter, Group, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the feed CommentBody contains rich text. Set IsRichText to true if you post a rich text feed comment using the SOAP API. Otherwise, the comment is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • • • • - •
935
Standard Objects
Field
FeedComment
Details The tag is accessible only through the API and must reference files in Salesforce similar to this example: Note: This attribute is available as of API version 38.0. In API version 38.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 37.0 and prior, all rich text appears as a plain-text representation.
LastEditById
Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the user who last edited the feed comment.
LastEditDate
Type datetime Properties Create, Filter, Nillable, Sort Description The date the feed comment was last edited.
ParentId
Type reference Properties Filter, Group, Nillable, Sort Description ID of a record associated with the feed comment. For example, if you are commenting on a change to a field on Account, ParentId is set to the account ID.
RelatedRecordId
Type reference Properties Create, Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentComment. This field is null for all comments except ContentComment. For example, set this field to an existing ContentVersion and post it to a comment as a FeedComment object of CommentTypeContentComment.
Revision
Type int Properties Create, Filter, Group, Nillable, Sort
936
Standard Objects
Field
FeedComment
Details Description The number of times the comment was revised.
Status
Type picklist Properties Create, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether this feed comment is published and visible to all who have access to the parent feed item. To make changes to a comment’s status, the comment’s parent feed item must be in a published state. This field is available in API version 38.0 and later. Possible values are: • Published—The comment is visible to all who have access to the parent feed item. • PendingReview—The comment is visible to its author and to users who can see the parent feed item and have “ViewAllData” or “CanApproveFeedPostAndComment” permission. The comment can be deleted by its author and users who can see the comment and have "CanApproveFeedPostAndComment" or "ModifyAllData" permission. If the parent feed item is published, the comment can be edited by its author and users who can see the comment and have "CanApproveFeedPostAndComment" or "ModifyAllData" permission. Comment status can be changed from Published to PendingReview and from PendingReview to Published by users who have "CanApproveFeedPostAndComment" or "ModifyAllData" permission. Some actions are blocked when a feed comment is pending review: – Select as Best—When a feed comment that is marked as best answer becomes unpublished, it’s removed as the best answer. If the comment is published, its best answer status is not restored. – Like and unlike
SystemModstamp
Type dateTime Properties Defaulted on create, Filter Description Date and time when a user or automated process (such as a trigger) last modified this record. SystemModstamp is a read-only system field, available in FeedComment as of API version 37.0.
Usage • As of API version 23.0 and later, if you have “View All Data” permission, you can query FeedComment records directly without an ID filter. If you don’t have “View All Data” permission, you can’t query FeedComment records directly, with or without an ID filter.
937
Standard Objects
FeedItem
For example, the following query returns general information about a feed: SELECT ID, CreatedDate, CreatedById, CreatedBy.FirstName, CreatedBy.LastName, ParentId, Parent.Name, Body FROM FeedItem WHERE CreatedDate > LAST_MONTH ORDER BY CreatedDate DESC, Id DESC
• You can search for text in comments using SOSL. For example, the following Java class uses search() to find the string “foo” in any field of a record: public void searchSample() { try { SearchResult sr = connection.search("find {foo} in all fields " + "returning feedcomment(Id, FeedItemId, CommentBody)"); // Put the results into an array of SearchRecords SearchRecord[] records = sr.getSearchRecords(); // Check the length of the returned array of records to see // if the search found anything if (records != null && records.length > 0) { System.out.println("Found " + records.length + " comments: "); // Display each comment for (SearchRecord record : records) { FeedComment comment = (FeedComment) record.getRecord(); System.out.println(comment.getId() + ": " + comment.getCommentBody()); } } else { System.out.println("No records were found for the search."); } } catch (ConnectionException ce) { ce.printStackTrace(); } }
• If you use an Apex trigger to modify the Body of a FeedComment object, all mentions hyperlinks are converted to plain text. The mentioned users don't get email notifications. Note: This object is hard deleted. It isn’t sent to the Recycle Bin.
SEE ALSO: NewsFeed UserProfileFeed
FeedItem FeedItem represents an entry in the feed, such as changes in a record feed, including text posts, link posts, and content posts. This object is available in API version 21.0 and later. This object replaces FeedPost.
938
Standard Objects
FeedItem
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert()
Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see. • “Manage Unlisted Groups” Only users with this permission can delete items in unlisted groups. Only users with the “Modify All Data” permission can delete a FeedItem of Type TrackedChange. If the logged-in user has the “Insert System Field Values for Chatter Feeds” user permission, the create field property is available on CreatedBy and CreatedDate system fields. During migration, the logged-in user can set these fields to the original post’s author and creation date. The fields can’t be updated after migration.
Fields Field Name
Details
BestCommentId
Type reference Properties Filter, Group, Nillable, Sort Description The Id of the comment marked as best answer on a question post.
Body
Type textarea Properties Create, Nillable, Sort, Update on page 17 Description The content of the FeedItem. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed. Tip: See the IsRichText field for a list of HTML tags supported in the body of rich text posts.
CommentCount
Type int
939
Standard Objects
Field Name
FeedItem
Details Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item. Tip: In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only one. In a moderated feed, your comment isn’t counted until it's approved by an admin or a person with “CanApproveFeedPostAndComment” or “ModifyAllData” permission. This has implications for how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until end of comments is returned.
ConnectionId
Type reference Properties Filter, Group, Nillable, Sort Description When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization.
ContentData
Type base64 Properties Create, Nillable Description This field was removed in API version 35.0, and is available in earlier versions for backward compatibility only. This field is required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Create, Nillable, Sort
940
Standard Objects
Field Name
FeedItem
Details Description This field was removed in API version 35.0, and is available in earlier versions for backward compatibility only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Create, Group, Nillable, Sort Description This field was removed in API version 35.0, and is available in earlier versions for backward compatibility only. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description This field was removed in API version 35.0, and is available in earlier versions for backward compatibility only. This field is the size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.
ContentType
Type string Properties Group, Nillable, Sort Description This field was removed in API version 35.0, and is available in earlier versions for backward compatibility only. This field is the MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.
FeedPostId
Type reference Properties Filter, Group, Nillable, Sort Description This field was removed in API version 22.0, and is available in earlier versions for backward compatibility only. ID of the associated FeedPost. A FeedPost represents the following types of changes in an FeedItem: changes to tracked fields, text posts, link posts, and content posts.
941
Standard Objects
FeedItem
Field Name
Details
HasContent
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item has content.
HasFeedEntity
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item has a feed entity, for example, a post, as an attachment. Available in API version 39 and later when sharing a feed entity in Lightning Experience.
HasLink
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item has a link attached.
InsertedById
Type reference Properties Filter, Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
IsDeleted
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Standard system field. Indicates whether the record has been moved to the Recycle Bin (true) or not (false).
IsRichText
Type boolean
942
Standard Objects
Field Name
FeedItem
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LastEditById
Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the user who last edited the feed item.
LastEditDate
Type datetime Properties Create, Filter, Nillable, Sort Description The date the feed item was last edited.
943
Standard Objects
FeedItem
Field Name
Details
LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Create, Nillable, Sort Description The URL of a LinkPost.
NetworkScope
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. NetworkScope can have the following values:
• NetworkId—The ID of the community in which the FeedItem is available. If left empty, the feed item is only available in the default community. • AllNetworks—The feed item is available in all communities. Note the following exceptions for NetworkScope: • Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks. • You can’t filter a FeedItem on the NetworkScope field. ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the object type to which the FeedItem object is related. For example, set this field to a UserId to post to someone’s profile feed, or an AccountId to post to a specific account.
944
Standard Objects
FeedItem
Field Name
Details
RelatedRecordId
Type reference Properties Create, Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. For Work.com thanks posts, it’s the ID of the WorkThanks object associated with a RypplePost. This field is typically null for all posts except ContentPost and RypplePost. For example, set this field to an existing ContentVersion and post it to a feed as a FeedItem object of Type ContentPost.
Revision
Type int Properties Create, Filter, Group, Nillable, Sort Description The revision number of the feed item.
Status
Type picklist Properties Create, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether this feed item is published and visible to all who have access to the feed. This field is available in API version 37.0 and later. Possible values are: • Published—The feed item is visible to all who have access to the feed. • PendingReview—The feed item is visible to its author and to users who can see the item and have “ViewAllData” or “CanApproveFeedPostAndComment” permission. The feed item can be deleted and edited by its author and users who can see the item and have "CanApproveFeedPostAndComment" or "ModifyAllData" permission. Some actions are blocked when a feed item is pending review: – Comment – Like/unlike – Bookmark – Share
Title
Type string
945
Standard Objects
Field Name
FeedItem
Details Properties Create, Group, Nillable, Sort, Update Description The title of the FeedItem. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name. The Title field can be updated on posts of Type QuestionPost.
Type
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of FeedItem. Except for ContentPost, LinkPost, and TextPost, don’t create FeedItem types directly from the API. • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed.
946
Standard Objects
Field Name
FeedItem
Details • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • AttachArticleEvent—generated event when a user attaches an article to a case. • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • CaseCommentPost—generated event when a user adds a case comment for a case object. • ChangeStatusPost—generated event when a user changes the status of a case. • ChatTranscriptPost—generated event when Live Agent transcript is saved to a case. • EmailMessageEvent—generated event when an email related to a case object is sent or received. • FacebookPost—generated when a Facebook post is created from a case. Deprecated. • MilestoneEvent—generated when a case milestone is completed or reaches violation status. • SocialPost—generated when a social post is created from a case. Note: If you set Type to ContentPost, also specify ContentData and ContentFileName.
Visibility
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. Visibility can have the following values:
947
Standard Objects
Field Name
FeedItem
Details • AllUsers—The feed item is available to all users who have permission to see the feed item. • InternalUsers—The feed item is available to internal users only. Note the following exceptions for Visibility: • For record posts, Visibility is set to InternalUsers for all internal users by default. • External users can set Visibility only to AllUsers. • Visibility can be updated on record posts. • The Update property is supported only for feed items posted on records.
Usage • This Apex example shows how to add an attachment to a Lead using API version 36.0 and later. First, post a feed item. //create and insert post FeedItem post = new FeedItem(); post.Body = 'HelloThere'; post.ParentId = 'ID_OF_LEAD_ENTITY'; post.Title = 'FileName'; insert post;
Then insert the attachment. //create and associate a content attachment to the post FeedAttachment feedAttachment = new FeedAttachment(); feedAttachment.FeedEntityId = post.Id; feedAttachment.RecordId = 'ID_OF_CONTENT_VERSION'; feedAttachment.Title = 'FileName'; feedAttachment.Type = 'CONTENT'; insert feedAttachment;
• If you are using API version 23.0 or later and have “View All Data” permission, you can directly query for a FeedItem. The following example returns the 20 most recent feed items. SELECT ID, CreatedDate, CreatedById, CreatedBy.FirstName, CreatedBy.LastName, ParentId, Parent.Name, Body, (SELECT ID, FieldName, OldValue, NewValue FROM FeedTrackedChanges ORDER BY ID DESC) FROM FeedItem WHERE CreatedDate > LAST_MONTH ORDER BY CreatedDate DESC
• If you are using an earlier API version than version 23.0, query FeedItem objects through a feed (such as AccountFeed or OpportunityFeed). The following example returns all feed items for a given account, ordered by date descending: SELECT Id, Type, FeedItem.Body FROM AccountFeed WHERE ParentId = AccountId ORDER BY CreatedDate DESC
948
Standard Objects
FeedLike
Note: Provide the ParentId for API version 22.0 and earlier. • A FeedItem of type UserStatus is automatically created when a user adds a post to update the status. You can’t explicitly create a FeedItem of type UserStatus. • The FeedItem object doesn’t support aggregate functions in queries. • If the logged-in user has the “Insert System Field Values for Chatter Feeds” user permission, the create field property is available on CreatedBy and CreatedDate system fields. During migration, the logged-in user can set these fields to the original post’s author and creation date. The fields can’t be updated after migration. • The size limit for an attachment on a profile or news feed is 25 MB. • The size limit for an attachment on a record feed is 5 MB. • You can’t use the content fields to update or delete the content. • You can’t filter or update the content fields. • Deleting a FeedItem via the API also deletes the associated content. Likewise, undeleting a FeedItem restores associated content. Note: This object is hard deleted. It isn’t sent to the Recycle Bin. • After uploading to a feed, it is possible for an attachment or document to be deleted, marked private, or hidden by sharing rules. In this case, all content fields in a FeedItem object appear as null in a SOQL query. • You can’t explicitly create or delete a FeedTrackedChange record. • If you insert a FeedItem or FeedComment of Type ContentPost on a User or Group to create a file, the NetworkScope field value of the FeedItem is passed to the file. • If you use an Apex trigger to modify the Body of a FeedItem object, all mentions hyperlinks are converted to plain text. The mentioned users don’t get email notifications. • If you insert rich text into the feed item body, make sure that the case of the opening and closing HTML tags matches. For example, This is bold text generates an error. • To check file sharing with Apex triggers, write triggers on ContentDocumentLink instead of FeedItem. For a ContentDocumentLink trigger example, see ContentDocumentLink. • In API version 36.0 and later, use FeedAttachment to attach one or more content items to a FeedItem. As a result of multiple attachment support through FeedAttachment, all fields related to content attachments have been removed. These fields are: ContentData, ContentDescription, ContentFileName, ContentSize, and ContentType.
FeedLike Indicates that a user has liked a feed item. This object is available in API version 21.0 and later. FeedLike records represent likes on posts and not likes on comments. Likes on comments can’t be queried via the API. A FeedLike is a child object of an associated FeedItem, FeedTrackedChange, or object feed, such as AccountFeed.
Supported Calls create(), delete(), describeSObjects()
949
Standard Objects
FeedLike
Special Access Rules If the logged-in user has the “Insert System Field Values for Chatter Feeds” user permission, the create field property is available on CreatedBy and CreatedDate system fields. During migration, the logged-in user can set these fields to the original post’s author and creation date. The fields can’t be updated after migration.
Fields Field Name
Details
FeedItemId
Type reference Properties Create, Filter, Group, Sort Description ID of the feed item that the user liked.
FeedEntityId
Type reference Properties Create, Filter, Group, Sort Description The Id of a feed item or feed comment the user liked. If the user liked a comment, FeedEntityId is set to the ID of the comment. If the user liked a feed item, FeedEntityId is set to the ID of the feed item. FeedEntityId is an optional field. The default value is the ID of the feed item.
InsertedById
Type reference Properties Filter, Group, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
Usage You can't query FeedLike records directly. They can only be queried via the entity feed, such as AccountFeed. FeedLike records represent likes on posts and not likes on comments. Likes on comments can’t be queried via the API.
950
Standard Objects
FeedPollChoice
FeedPollChoice Shows the choices for a poll posted in the feed. This object is available in API version 29.0 and later.
Supported Calls query(), retrieve()
Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see. • “Manage Unlisted Groups” Only users with this permission can delete items in unlisted groups.
Fields Field Name
Details
ChoiceBody
Type string Properties Group Description A choice in the poll.
FeedItemId
Type reference Properties Create, Filter, Group, Sort Description ID of the feed item for the poll.
Position
Type int Properties Group, Sort Description Shows the position of the poll choice.
951
Standard Objects
FeedPollVote
Usage Use this object to query all of the choices associated with a particular poll. To view how people voted on the poll, see the FeedPollVote object.
FeedPollVote Shows how users voted on a poll posted in the feed. This object is available in API version 29.0 and later.
Supported Calls query(), retrieve()
Fields Field Name
Details
ChoiceId
Type reference Properties Filter, Group Description Indicates which choice a user selected on a poll posted in a feed.
FeedItemId
Type reference Properties Filter, Group, Sort Description ID of the feed item for the poll.
Usage Use this object to query how users voted on a particular poll.
FeedPost FeedPost represents the following types of changes in a record feed, such as AccountFeed: text posts, link posts, and content posts. This object is available in API version 18.0 through 21.0. FeedPost is no longer available in later versions. Starting with API version 21.0, use FeedItem to represent text posts, link posts, and content posts in feeds.
952
Standard Objects
FeedPost
Supported Calls create(), delete(), describeSObjects(), search()
Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see. Only users with the “Modify All Data” permission can delete a FeedItem of Type TrackedChange. If the logged-in user has the “Insert System Field Values for Chatter Feeds” user permission, the create field property is available on CreatedBy and CreatedDate system fields. During migration, the logged-in user can set these fields to the original post’s author and creation date. The fields can’t be updated after migration.
Fields Field
Details
Body
Type string Properties Create, Filter, Nillable, Sort Description The content of the FeedPost. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
ContentData
Type base64 Properties Create, Nillable Description This field is required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type string Properties Create, Nillable, Sort Description The description of the file specified in ContentData.
953
Standard Objects
FeedPost
Field
Details
ContentFileName
Type string Properties Create, Group, Nillable, Sort Description This field is required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description This field is the size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.
ContentType
Type string Properties Group, Nillable, Sort Description This field is the MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.
FeedItemId
Type reference Properties Filter, Group, Sort Description ID of the feed containing the FeedPost.
InsertedById
Type reference Properties Filter, Group, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
954
Standard Objects
FeedPost
Field
Details
IsDeleted
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the record has been moved to the Recycle Bin (true) or not (false). This field is a standard system field.
LinkUrl
Type url Properties Create, Filter, Nillable, Sort Description The URL of a LinkPost.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the object type to which the FeedPost is related. For example, set this field to a UserId to post to someone’s profile feed, or an AccountId to post to a specific account.
Title
Type string Properties Create, Filter, Group, Nillable, Sort Description The title of the FeedPost. When the Type is LinkPost, the Body is the URL and the Title is the label for the link.
Type
Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of FeedPost: • UserStatus—automatically generated when a user updates their status • TrackedChange—ignore • TextPost—a direct text entry on a feed
955
Standard Objects
Field
FeedRevision
Details • LinkPost—a URL posting on a feed • ContentPost—an uploaded file on a feed Note: If you set Type to ContentPost, you must specify ContentData and ContentFileName.
Usage • You can’t directly query for a FeedPost. FeedPosts are always associated with a feed item, so you can query for them through the feeds. The following example returns all feed items for a given account, ordered by date descending: SELECT Id, Type, FeedPost.Body FROM AccountFeed WHERE ParentId = AccountId ORDER BY CreatedDate DESC
• A FeedPost of type UserStatus is automatically created when a user adds a post to update the current status. You can’t explicitly create a FeedPost of type UserStatus. • The size limit for an attachment on a profile, news, or record feed is 2 GB. • You can’t use the content fields to update or delete the content. • You can’t filter or update the content fields. • Deleting a FeedPost via the API also deletes the associated content and FeedPost objects. Likewise, undeleting a FeedPost restores associated content and FeedPost objects. Note: This object is hard deleted. It isn’t sent to the Recycle Bin. • After uploading to a feed, it is possible for an attachment or document to be deleted, marked private, or hidden by sharing rules. In this case, all content fields in FeedPost appear as null in a SOQL query. • You can’t explicitly create or delete a FeedTrackedChange record.
FeedRevision Holds the revision history of a specific feed item or comment, including a list of attributes that changed for each revision. This object is available in API version 34.0 and later.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
Action
Type picklist
956
Standard Objects
Field Name
FeedRevision
Details Properties Filter, Group, Nillable, Sort Description Holds the type of modification to the underlying feed item or comment attribute. Action can have the value Changed.
EditedAttribute
Type picklist Properties Filter, Group, Nillable, Sort Description Identifies the part of the feed item or comment which was modified. A single revision can have many edited attributes.
FeedEntityId
Type reference Properties Filter, Group, Sort Description Identifies the modified feed item or comment.
IsDeleted
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the record has been moved to the Recycle Bin (true) or not (false). This field is a standard system field.
IsValueRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines.
957
Standard Objects
Field Name
FeedRevision
Details • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. OriginNetworkId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the community in which a user modified the feed item or comment. This field is only available, if Salesforce Communities is enabled for your organization.
Revision
Type int Properties Filter, Group, Nillable, Sort Description The revision number of the feed item or comment.
Value
Type textarea Properties Nillable Description Identifies the value of the EditedAttribute field before the update.
958
Standard Objects
FeedTrackedChange
Usage This object tracks the changes made to a feed item or feed comment and stores a list of attributes that changed for each revision. • To query the FeedRevision object, users need the “View All Data” permission or supply a WHERE clause on the FeedEntityId.
FeedTrackedChange Represents an individual field change or set of field changes. A FeedTrackedChange is a child object of a record feed, such as AccountFeed This object is available in API version 18.0 and later..
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field
Details
CurrencyIsoCode
Type picklist Properties Defaulted on create, Group, Restricted picklist, Sort Description Available only for organizations with the multicurrency feature enabled. Contains the ISO currency code for the field, if FieldName is a currency field.
FeedItemId
Type reference Properties Group, Sort, Filter Description ID of the parent feed that tracks the field change.
FieldName
Type string Properties Group, Sort Description The name of the field that was changed. Note: This field also tracks other events that are not related to an individual field for a parent feed. These events occur as the parent record advances through its pipeline. For example, a value of leadConverted indicates that a lead has been converted to an opportunity. For a full list of values, see Tracking of Special Events.
959
Standard Objects
FeedTrackedChange
Field
Details
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldCurrencyIsoCode
Type string Properties Group, Nillable, Sort Description Available only for organizations with the multicurrency feature enabled. Contains the ISO currency code for the OldValue field, if FieldName is a currency field.
OldValue
Type anyType Properties Nillable, Sort Description The last value of the field before it was changed.
Usage A user can subscribe to a record or to another user. Changes to the record and updates from the users are displayed in the Chatter feed on the user's home page, which is a useful way to stay up-to-date with other users and with changes made to records in Salesforce. Feeds are available in API version 18.0 and later. If you move a custom field to the Recycle Bin, all FeedTrackedChange records that track historical changes to the custom field are automatically deleted and are not restored if the custom-field is undeleted. The following sections outline the difference between standard feeds and custom feeds.
Standard Feeds A standard feed is a record feed, such as AccountFeed. FeedTrackedChange records for standard feeds can only be queried via the parent feed object. Note the following when working with standard feed items: • Feed items for standard feeds are read only in the API. • A FeedTrackedChange record is visible when you have read access on the record feed, and when the field in the FeedTrackedChange is visible in the field-level security settings.
960
Standard Objects
FeedTrackedChange
Custom Feeds If you want more control over the information provided in a record feed, such as AccountFeed, you can create a custom feed. A custom feed can replace or augment an existing record feed. For example, you might want to: • Disable the standard account record feed and use an Apex trigger to generate FeedTrackedChange records for the events that you want to track in the feed instead. • Augment the standard contact record feed by writing an API client that inserts feed items for events that are not tracked in the standard feed.
Tracking of Special Events The FieldName field also tracks other events that are not related to an individual field for a parent feed. These events occur as the parent record advances through its pipeline. For example, a value of leadConverted indicates that a lead has been converted to an opportunity. Valid values for the FieldName field for multiple objects: • created • ownerAccepted • ownerAssignment Additional valid values for the FieldName field for individual objects: Account • accountCreatedFromLead • accountMerged • accountUpdatedByLead • personAccountUpdatedByLead Case • closed • ownerEscalated Contact • contactCreatedFromLead • contactMerged • contactUpdatedByLead Contract • contractActivation • contractApproval • contractConversion • contractExpiration • contractTermination Lead • leadConverted • leadMerged
961
Standard Objects
FieldHistoryArchive
Opportunity • opportunityCreatedFromLead SEE ALSO: NewsFeed UserProfileFeed
FieldHistoryArchive Represents field history values for all objects that retain field history. FieldHistoryArchive is a BigObject, available only to users with the “Retain Field History” permission. This object is available in API version 29.0 and later. Each instance of the FieldHistoryArchive object represents a single change in the value of a field. FieldHistoryArchive stores history for both standard and custom fields. The Field field returns the name of the field unless the parent field or object is deleted, in which case it returns the field ID. You can use the ID to retrieve the old field and object name from the FieldNameAfterArchival and ParentNameAfterArchival fields, respectively.
Supported Calls describeSObjects(), query()
Fields Field Name
Details
ArchiveFieldName
Type string Properties Nillable Description The name of the field at the time the data was archived. If the field name changed, the name is sometimes not the same for all records related to a single field.
ArchiveParentName
Type string Properties Nillable Description The name of the parent object at the time the data was archived. If the object name changed, the name is sometimes not the same for all records related to a single field.
962
Standard Objects
FieldHistoryArchive
Field Name
Details
ArchiveParentType
Type string Properties Nillable Description The type of the field at the time the data was archived. If the field type changed, the type is sometimes not the same for all records related to a single field.
ArchiveTimestamp
Type dateTime Properties Nillable Description The date and time at which the data was archived.
CreatedById
Type reference Properties Nillable Description The user ID of the user who created the original record.
CreatedDate
Type dateTime Properties Nillable, Sort Description The date and time at which the original record was created.
Field
Type picklist Properties Filter, Nillable, Restricted picklist Description The name of the field that was changed. If the field is deleted from the parent object, the Field field contains the field ID instead.
FieldHistoryType
Type picklist Properties Nillable, Sort, Restricted picklist
963
Standard Objects
Field Name
FieldHistoryArchive
Details Description The name of the object that contains the field history (for example, Account).
Id
Type ID Properties Defaulted on create, Filter, idLookup Description The ID of the archived record. It’s useful to have a field’s ID for fields that you’ve deleted. (Field names aren’t retained in history when you delete fields from Salesforce.)
NewValue
Type anyType Properties Nillable Description The new value of the modified field.
OldValue
Type anyType Properties Nillable Description The previous value of the modified field.
ParentId
Type reference Properties Filter, Nillable, Sort Description The ID of the object that contains the field (the parent object).
Usage When sorting fields, order them as follows: 1. FieldHistoryType ASC 2. ParentID ASC 3. CreatedDate DESC
964
Standard Objects
FieldPermissions
FieldPermissions Represents the enabled field permissions for the parent PermissionSet. This object is available in API version 24.0 and later. To grant a user access to a field, associate a FieldPermissions record with a PermissionSet that’s assigned to a user. FieldPermissions records are only supported in PermissionSet, not in Profile.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
Field
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The field’s API name. This name must be prefixed with the SobjectType. For example, Merchandise__c.Description__c
ParentId
Type reference Properties Create, Filter, Group, Sort Description The Id of the field’s parent PermissionSet.
PermissionsEdit
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, users assigned to the parent PermissionSet can edit this field. Requires PermissionsRead for the same field to be true.
PermissionsRead
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update
965
Standard Objects
Field Name
FieldPermissions
Details Description If true, users assigned to the parent PermissionSet can view this field. A FieldPermissions record must have at minimum PermissionsRead set to true, or it will be deleted.
SobjectType
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The object’s API name. For example, Merchandise__c.
Usage FieldPermissions work similarly to ObjectPermissions. However, FieldPermissions includes a Field attribute to return the name of the field. For example, the following query returns all FieldPermissions records that have at least the “Read” permission. The results includes the field, object, and permission set names. SELECT SobjectType, Field, PermissionsRead, Parent.Name FROM FieldPermissions WHERE PermissionsRead = True
Include the field’s parent object when querying FieldPermissions. For example, to find all rows that match the Account object’s Type field, create the following query: SELECT Id, SobjectType, Field FROM FieldPermissions WHERE Field = 'Account.Type' AND SobjectType = 'Account'
Both SobjectType and Field must be included in the SELECT line of the query. You must also provide the full API name of the field in the form of SobjectType.Field when querying for a field. Note: When using the FieldPermission object to download records, depending on the SOQL query you use, you might not receive all expected records. Results might also appear incomplete. However, all records do download; fields that don't support field security and rows for entities not visible to the org. are hidden.
Special Properties for Field Permissions The auto-number and formula fields have special rules for how field permissions work. Both have FieldPermissions records, but inserting and updating is limited to PermissionsRead. PermissionsEdit isn’t allowed for either field type, since these fields must be read-only for users. The following field types don’t return a FieldPermissions record because they are assumed to always be readable. • Id • CreatedById • CreatedDate
966
Standard Objects
FieldPermissions
• IsDeleted • LastModifiedById • LastModifiedDate • SystemModStamp The following field types don’t return a FieldPermissions record because they are assumed to always be readable and writable. • OwnerId • Master-detail custom (relationship) fields • Universally required custom fields As a result, the following query returns no records, even though users do have some access to some of the fields. SELECT Field, SobjectType, PermissionsRead FROM FieldPermissions WHERE Field='Id'
To determine if a field can return a FieldPermissions record, you can call a describeSObject() on the field. For example, describeSObject('Merchandise__c'), returns all the properties of the Merchandise custom object, including field properties. If you’re using a field whose permissionable property is false (such as any of the field types listed in this section), you can’t query, insert, update, or delete any field permissions records, because none exist.
Working with Custom Activity Fields While tasks and events are considered separate objects, they share a common set of activity custom fields. As a result, when a custom task field is created, a custom event field is also created, and vice versa. You can display the custom field on the event layout, task layout, or both event and task layouts. Although custom activity fields are shared between tasks and events, you’ll see separate FieldPermissions records for the task and event. However, changes made to one field permission record are automatically made to the other. For example, if you create a custom activity field, assign field permissions to it in a permission set, and run the following query, the query will return two records with the same permission value. SELECT Field, Id, ParentId, PermissionsEdit, PermissionsRead, SobjectType FROM FieldPermissions WHERE SobjectType = 'event' OR SobjectType ='task'
If you then update one of the records with a different set of field permission values and run the query again, the same permission values for both records are returned.
Nesting Field Permissions You can nest FieldPermissions in a PermissionSet query. For example, the following returns any permission sets where “Edit Read Only Fields” is true. Additionally, the result set will include both the “Read” and “Edit” field permission on the Merchandise object. This is done by nesting the SOQL with a field permission query using the relationship name for field permissions: FieldPerms. SELECT PermissionsEditReadonlyFields, (SELECT SobjectType, Field, PermissionsRead, PermissionsEdit FROM FieldPerms WHERE SobjectType = 'Merchandise__c') FROM PermissionSet WHERE PermissionsEditReadonlyFields = true
967
Standard Objects
FiscalYearSettings
As a result, it’s possible to traverse the relationship between the PermissionSet and any child related objects (in this case, FieldPermissions). You can do this from the PermissionSet object by using the child relationship (ObjectPerms, FieldPerms, and so on) or from the child object by referencing the PermissionSet with Parent.permission_set_attribute. It’s important to consider when to use a conditional WHERE statement to restrict the result set. To query based on an attribute on the permission set object, nest the SOQL with the child relationship. However, to query based on an attribute on the child object, you must reference the permission set parent attribute in your query. The following two queries return the same columns with different results, based on whether you use the child relationship or parent notation. SELECT PermissionsEditReadonlyFields, (SELECT SobjectType, Field, PermissionsRead, PermissionsEdit FROM FieldPerms WHERE SobjectType = 'Merchandise__c') FROM PermissionSet WHERE PermissionsEditReadonlyFields = true
versus: SELECT SobjectType, Field, PermissionsRead, PermissionsEdit, Parent.Name, Parent.PermissionsEditReadonlyFields FROM FieldPermissions WHERE SObjectType='Merchandise__c'
SEE ALSO: PermissionSet ObjectPermissions
FiscalYearSettings Settings to define a custom or standard fiscal year for your organization. This object has a parent-child relationship with the Period object.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Customer Portal users can’t access this object.
Fields Field
Details
Description
Type string Properties Filter, Group, Nillable, Sort
968
Standard Objects
Field
FiscalYearSettings
Details Description Description of the setting.
EndDate
Type date Properties Filter, Group, Nillable, Sort Description End date of the fiscal year.
IsStandardYear
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the fiscal year is a standard calendar year (true) or a custom fiscal year (false).
Name
Type string Properties Filter, Group, Sort Description A name for the fiscal year. Limit: 80 characters.
PeriodId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the associated fiscal period.
PeriodLabelScheme
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The numbering scheme used for fiscal periods.
PeriodPrefix
Type picklist
969
Standard Objects
Field
FiscalYearSettings
Details Properties Defaulted on create, Filter, Group, Nillable, Sort Description The prefix of fiscal periods. For example, if p is the prefix, then the first period is “P1.”
QuarterLabelScheme
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The numbering scheme used for fiscal quarters.
QuarterPrefix
Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description The prefix of fiscal quarters. For example, if “Q” is the prefix, then the fourth quarter would be “Q4.”
StartDate
Type date Properties Filter, Group, Nillable, Sort Description Start date of the fiscal year.
WeekLabelScheme
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The numbering scheme used for weeks.
WeekStartDay
Type int Properties Filter, Group, Nillable, Sort Description The name of the day that starts the week, for example Monday or Sunday
970
Standard Objects
FlexQueueItem
Field
Details
YearType
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates one of two types of fiscal years, Standard or Custom. Standard denotes the standard Gregorian calendar, while Custom means a fiscal year with a custom structure.
SEE ALSO: Period Object Basics
FlexQueueItem Represents an asynchronous Apex job in the Apex flex queue. Provides information about the job type and flex queue position of the AsyncApexJob. This object is available in API version 36.0 and later.
Supported Calls describeSObjects(), query()
Fields Field Name
Description
AsyncApexJobId
Type reference Properties Filter, Group, Sort Description The ID of an AsyncApexJob that’s waiting in the flex queue.
FlexQueueItemId
Type string Properties Filter, Group, Nillable, Sort Description The primary key for this FlexQueueItem.
971
Standard Objects
FlexQueueItem
Field Name
Description
JobPosition
Type int Properties Filter, Group, Sort Description The position in the flex queue of the waiting job. The highest-priority job in the queue is at position 0.
JobType
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of the job. Valid values are: • ApexToken • BatchApex • BatchApexWorker • Future • Queueable • ScheduledApex • SharingRecalculation • TestRequest • TestWorker Currently, queries are supported only on BatchApex jobs.
Usage To find the position of an AsyncApexJob in the flex queue, query JobPosition. For example: SELECT JobPosition FROM FlexQueueItem WHERE JobType = 'BatchApex' AND AsyncApexJobId = '707xx000000DABC'
To find the job at a given position, query AsyncApexJobId. For example: SELECT AsyncApexJobId FROM FlexQueueItem WHERE JobType = 'BatchApex' AND JobPosition = '2'
To find all batch jobs in the flex queue, query JobType. To get other information about the jobs, include AsyncApexJob in your query. For example: SELECT JobType, JobPosition, AsyncApexJob.ApexClass.Name, AsyncApexJob.CreatedDate, AsyncApexJob.CreatedBy FROM FlexQueueItem WHERE JobType='BatchApex' AND AsyncApexJob.ApexClass.Name LIKE '%'BatchAJob'%' ORDER BY JobPosition DESC
972
Standard Objects
FlowInterview
FlowInterview Represents a flow interview. A flow interview is a running instance of a flow.
Supported Calls delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), describeSObject()
Special Access Rules To delete a flow interview, you must have the “Manage Force.com Flow” user permission. All other calls require the “Run Flows” user permission or the Force.com Flow User field enabled on the user detail page.
Fields Field Name
Details
CurrentElement
Type string Properties Filter, Group, Nillable, Sort Description The flow element at which the interview is currently paused or waiting.
InterviewLabel
Type string Properties Filter, Nillable, Sort Description Label for the interview. This label helps users and administrators differentiate interviews from the same flow. In the user interface, this label appears in the Paused Flow Interviews component on the user’s Home tab and in the Paused and Waiting Interviews list on the flow management page.
Name
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name for the interview.
OwnerId
Type ID
973
Standard Objects
Field Name
FlowInterviewOwnerSharingRule
Details Properties Filter, Group, Sort Description The ID of the user who owns the interview. Only this user or an admin can resume the interview.
PauseLabel
Type string Properties Filter, Nillable, Sort Description Information about why the interview was paused. This string is entered by the user who paused the flow interview. Label is Why Paused
FlowInterviewOwnerSharingRule Represents the rules for sharing a FlowInterview with users other than the owner. This object is available in API version 33.0 and later.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Fields Field
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing being allowed. The possible values are: • Read • Edit
Description
Type textarea Properties Create, Filter, Nillable, Sort, Update
974
Standard Objects
Field
FlowInterviewOwnerSharingRule
Details Description A description of the sharing rule. Maximum size is 1000 characters.
DeveloperName
Type string Properties Create, Filter, Group, Sort, Update 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. Corresponds to Rule Name in the user interface. Note: 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.
GroupId
Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to Label on the user interface.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description The ID representing the target user or group that’s given access.
975
Standard Objects
FlowInterviewShare
Usage Use this object to manage the sharing rules for FlowInterview records. Sharing rules don’t affect who can resume the FlowInterview. Only the owner or a flow admin can resume a FlowInterview. General sharing uses this object.
FlowInterviewShare Represents a sharing entry on a FlowInterview. This object is available in API version 33.0 and later.
Supported Calls describeSObjects(), create(), delete(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the FlowInterview. The possible values are: • Read • Edit • All This value is not valid for creating or deleting records.
ParentId
Type reference Properties Create, Filter, Group, Sort, Update Description ID of the FlowInterview associated with this sharing entry.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. You can only write to this field when its value is either omitted or set to Manual (default).
976
Standard Objects
Field
Folder
Details Valid values include: • Manual—The User or Group has access because a user with “All” access manually shared the FlowInterview with them. • Owner—The User is the owner of the FlowInterview. • Rule—The User or Group has access via a FlowInterview sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the FlowInterview. This field can't be updated.
Usage This object lets you determine which users and groups can view and edit FlowInterview records owned by other users. However, it doesn’t let you determine who can resume the FlowInterview. Only the owner or a flow admin can resume a FlowInterview.
Folder Represents a repository for a Document, EmailTemplate, Report, or Dashboard. Only one type of item can be contained in a folder.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Special Access Rules • You must have the “Modify All Data” permission to create, update, or delete document folders and email template folders. • Customer Portal users can’t access this object. • To query this object, no special permissions are needed. • As of API version 35.0, when a folder is shared with a role, it is only visible to users in that role. Superior roles in the role hierarchy don’t gain visibility. • If analytics folder sharing is turned on, then users need these permissions to create and manage report folders and dashboard folders: – “Create Dashboard Folders” – “Create Report Folders”
977
Standard Objects
Folder
Fields Field
Details
AccessType
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Indicates who can access the Folder. Available values include: • Hidden—Folder is hidden from everyone. • Public—Folder is accessible by all users. • Shared—Folder is accessible only by a User in a particular Group or UserRole. The API doesn’t allow you to view, insert, or update which group or Role the Folder is shared with. Note: If analytics folder sharing is turned on for your organization, then this field is present but not used.
DeveloperName
Type string Properties Create, Filter, Group, Nillable, Sort, Update 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 Folder Unique Name. Note: 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.
IsReadonly
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this Folder is read-only (true) or editable (false). Label is Read Only. Note: If analytics folder sharing is turned on for your organization, then this field is present but not used.
978
Standard Objects
Folder
Field
Details
Name
Type string Properties Create, Filter, Group, Sort, Update Description Label of the folder as it appears in the user interface. Label is Document Folder Label.
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value 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. This field can’t be accessed unless the logged-in user has the “Customize Application” permission.
Type
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Required. Type of objects contained in the Folder. This field can’t be updated. Available values include: • Dashboard • Document • Email template • Report
979
Standard Objects
FolderedContentDocument
Usage Only one type of item can be contained in a folder, either Document, EmailTemplate, Report, or Dashboard. SEE ALSO: Object Basics
FolderedContentDocument Represents the relationship between a parent and child ContentFolderItem in a ContentWorkspace.
Supported Calls describeSObjects()
Fields Field Name
Details
ContentDocumentId
Type reference Properties Filter, Group, Sort Description ID of the ContentDocument that can be in a folder.
ContentSize
Type int Properties Filter, Group, Nillable, Sort Description File size of the ContentDocument.
FileExtension
Type string Properties Filter, Group, Nillable, Sort Description File extension of the ContentDocument.
FileType
Type string
980
Standard Objects
Field Name
ForecastingAdjustment
Details Properties Filter, Group, Nillable, Sort Description File type of the ContentDocument.
IsFolder
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the FolderedContentDocument is a folder, rather than a file.
ParentContentFolderId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the ContentFoldr the ContentDocument resides in.
Title
Type string Properties Filter, Group, Sort Description Name of the file or folder in a ContentFolder.
ForecastingAdjustment This object represents an individual sales manager’s adjustment for a subordinate’s forecast via a ForecastingItem. Available in API versions 26 and greater. This object is separate from the ForecastingOwnerAdjustment object, which represents forecast users’ adjustments of their own forecasts. Note: This information only applies to Collaborative Forecasts.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
981
Standard Objects
ForecastingAdjustment
Fields Field Name
Details
AdjustedAmount
Type double Properties Create, Filter, Sort, Update Description The revenue amount of an individual forecast item, after an adjustment.
AdjustedQuantity
Type double Properties Create, Filter, Sort, Update Description The quantity amount of an individual forecast item, after an adjustment. This field is available in API version 28 and later.
AdjustmentNote
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description A text note providing information about the adjustment. The maximum length is 140 characters. This field does not appear in reports.
CurrencyIsoCode
Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The currency code of the adjustment. If omitted, the default is the importing user’s personal currency.
ForecastCategoryName
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The category within the sales cycle that an opportunity is assigned to based on its opportunity stage. The standard forecast categories are Pipeline, Best Case,
982
Standard Objects
Field Name
ForecastingAdjustment
Details Commit, Omitted, and Closed. You can customize forecast category names. The forecast categories display information for that specific category; for example, Best Case only reflects amounts in the Best Case category.
ForecastingItemCategory
Type picklist Properties Create, Filter, Group, Sort Description This field indicates which type of forecast rollup the manager adjustment belongs to. Depending on whether your organization uses individual forecast category rollups or cumulative forecast rollups, you have these possible values for the ForecastingItemCategory field. Individual forecast category rollups: • PipelineOnly - Rollup from Pipeline opportunities only. • BestCaseOnly - Rollup from Best Case opportunities only. Adjustable. • CommitOnly - Rollup from Commit opportunities only. Adjustable. Cumulative forecast rollups: • OpenPipeline - Rollup from Pipeline + Best Case + Commit opportunities. • BestCaseForecast - Rollup from Best Case + Commit + Closed opportunities. Adjustable. • CommitForecast - Rollup from Commit + Closed opportunities. Adjustable. Either cumulative or individual forecast category rollups: • ClosedOnly - Rollup from Closed opportunities only. The ForecastingItemCategory field differs from the ForecastCategoryName field. • The ForecastCategoryName field represents the forecast category of the underlying opportunities rolling up to forecast amounts. In organizations using cumulative forecast rollups, the ForecastCategoryName field can be null because the cumulative forecast amounts include opportunities from multiple forecast categories. • The new ForecastingItemCategory field represents the type of rollup a forecast amount or adjustment is from. In organizations using individual forecast category columns, it contains the individual forecast rollup categories. In organizations using cumulative forecast rollups, it contains the cumulative rollup categories. When inserting manager adjustments, the values you insert for ForecastCategoryName and ForecastingItemCategory must be compatible with each other. In organizations using cumulative forecast rollups, the ForecastCategoryName is nillable. These are the valid pairs.
983
Standard Objects
Field Name
ForecastingAdjustment
Details Individual forecast category rollups: • ForecastCategoryName: BestCase, ForecastingItemCategory: BestCaseOnly • ForecastCategoryName: Commit, ForecastingItemCategory: CommitOnly Cumulative forecast category rollups: • ForecastCategoryName: null, ForecastingItemCategory: BestCaseForecast • ForecastCategoryName: null, ForecastingItemCategory: CommitForecast
ForecastingTypeId
Type reference Properties Create, Filter, Group, Sort Description The ID of the related ForecastingType.
ForecastingItemId
Type reference Properties Filter, Group, Sort Description The ID of the related ForecastingItem.
IsAmount
Type boolean Properties Defaulted on create, Filter, Group, Sort Description True indicates that the adjustment is made in a revenue amount. If false, then IsQuantity must be true. This field is available in API version 28 and later.
IsQuantity
Type boolean Properties Defaulted on create, Filter, Group, Sort Description True indicates that the adjustment is made in a quantity amount. If false, then IsAmount must be true. This field is available in API version 28 and later.
984
Standard Objects
ForecastingAdjustment
Field Name
Details
OwnerId
Type reference Properties Create,Defaulted on create, Filter, Group, Sort Description The ID of the forecast owner.
PeriodId
Type reference Properties Filter, Group, Nillable, Sort Description Period ID for the adjustment. Read only.
ProductFamily
Type picklist Properties Create, Filter, Group, Nillable, Sort Description The Product Family for the adjustment. Read only. This field is available in API version 29 and later.
StartDate
Type date Properties Create, Filter, Group, Sort Description The start of the adjustment, expressed as month and year. The date can include any day in a given month. Stored using the first date of the month.
Usage Use this object to obtain a manager’s adjustment detail for a specified ForecastingItem. The ForecastingAdjustment object itself is visible to all users, but only forecast managers and users above them in the forecast hierarchy can read or write ForecastingAdjustment records. Note: Beginning with API version 30.0, organizations can have more than one forecasting type enabled. The ForecastingQuota, ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingItem, and ForecastingFact objects can all have records with different ForecastingTypeId values. Use the ForecastingType
985
Standard Objects
ForecastingDisplayedFamily
object to determine the ID for each forecast type and then filter ForecastingQuota, ForecastingAdjustment, ForecastingItem, or ForecastingFact records as necessary. SEE ALSO: ForecastingFact ForecastingItem ForecastingQuota
ForecastingDisplayedFamily Represents the table in Forecasts Settings where an admin selects the product families that users can forecast on in Lightning Experience. This object is available in API version 40.0 and later.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
DisplayPosition
Type int Properties Filter, Group, idLookup, Nillable, Sort Description The order in which product families are displayed on the forecasts page. Each value is unique to a product family.
ProductFamily
Type picklist Properties Filter, Group, Sort Description The product family available to forecast on. Each product family is unique.
ForecastingFact This is a read-only object linking a ForecastingItem with its opportunities, such as opportunities that share the same owner or forecast category and have a closing date within the period of the forecasting item. Available in API versions 26 and greater. Note: This information only applies to Collaborative Forecasts.
986
Standard Objects
ForecastingFact
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
ForecastCategoryName
Type picklist Properties Filter, Group, Restricted picklist, Sort Description A forecast category is the category within the sales cycle to which an opportunity is assigned based on its opportunity stage. The standard forecast categories are Pipeline, Best Case, Commit, Omitted, and Closed. You can customize the forecast category names.
ForecastedObjectId
Type reference Properties Filter, Group, Nillable, Sort Description Contains the Split ID of the forecasted OpportunitySplit object if the forecast data source is opportunity splits or the OpportunityLineItem ID of the forecasted opportunity if the data source is product families. If the data source is product families and the opportunity has no line item, this field is Null. If the forecast data source is opportunities, this field is Null. This field is available in API version 29 and later. Read only.
ForecastingItemId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the ForecastingItem.
ForecastingTypeId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related ForecastingType.
987
Standard Objects
ForecastingFact
Field Name
Details
OpportunityId
Type reference Properties Filter, Group, Sort Description The opportunity ID.
OwnerId
Type reference Properties Filter, Group, Sort Description The ID of the opportunity owner.
PeriodId
Type reference Properties Filter, Group, Nillable, Sort Description Period ID for the forecast.
Usage Use this object to get information about opportunities linked to forecasting items. Note: Beginning with API version 30.0, organizations can have more than one forecasting type enabled. The ForecastingQuota, ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingItem, and ForecastingFact objects can all have records with different ForecastingTypeId values. Use the ForecastingType object to determine the ID for each forecast type and then filter ForecastingQuota, ForecastingAdjustment, ForecastingItem, or ForecastingFact records as necessary. s SEE ALSO: ForecastingAdjustment ForecastingItem ForecastingQuota
988
Standard Objects
ForecastingItem
ForecastingItem This is a read-only object used for individual forecast amounts. Users see amounts based on their perspectives and forecast roles. The amounts users see include one of the following when forecasting in revenue: AmountWithoutAdjustments, AmountWithoutManagerAdjustment, ForecastAmount, OwnerOnlyAmount. The amounts users see include one of the following when forecasting in quantity: QuantityWithoutAdjustments, QuantityWithoutManagerAdjustment, ForecastQuantity, OwnerOnlyQuantity. Available in API versions 26 and greater. Additionally, note that users: • with the “View All Forecasts” permission have access to all ForecastingItem fields. • without the “View All Forecasts” permission have access to all fields for their own subordinates. Other users can see the ForecastingItem object, but not its records. Note: This information only applies to Collaborative Forecasts.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
AmountWithoutAdjustments
Type double Properties Filter, Sort, Nillable Description The sum of a person’s owned revenue opportunities and the person's subordinates’ opportunities, without adjustments. Subordinates include everyone reporting up to a person in the forecast hierarchy. This amount is visible only on reports.
AmountWithoutManagerAdjustment Type
double Properties Filter, Sort, Nillable Description The forecast number as seen by the forecast owner. This is the sum of the owner’s revenue opportunities and the owner’s subordinates’ opportunities, including adjustments made by the forecast owner on the owner's or subordinates’ forecasts. It doesn’t include adjustments made by forecast managers above the owner in the forecast hierarchy.
989
Standard Objects
ForecastingItem
Field Name
Details
AmountWithoutOwnerAdjustment
Type double Properties Filter, Sort, Nillable Description The forecast amount as seen by the forecast owner without the owner's adjustment. This is the sum of the subordinate's opportunities, including adjustments made by their manager or by the subordinate themselves, plus the rollup of the owner's own opportunities. It doesn’t include adjustments made by the forecast owner.
ForecastAmount
Type double Properties Filter, Sort, Nillable Description The revenue forecast from the forecast manager’s perspective and the sum of the owner’s and subordinates’ opportunities, including all forecast adjustments.
ForecastCategoryName
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description A forecast category is the category within the sales cycle to which an opportunity is assigned based on its opportunity stage. The standard forecast categories are Pipeline, Best Case, Commit, Omitted, and Closed. You can customize the forecast category names.
ForecastQuantity
Type double Properties Filter, Sort, Nillable Description The quantity forecast from the forecast manager’s perspective and the sum of the owner’s and subordinates’ opportunities, including all forecast adjustments. This field is available in API version 28 and later.
ForecastingItemCategory
Type picklist
990
Standard Objects
Field Name
ForecastingItem
Details Properties Filter, Group, Sort Description This field indicates which type of forecast rollup the forecasting item belongs to. Depending on whether your organization uses individual forecast category rollups or cumulative forecast rollups, you have these possible values for the ForecastingItemCategory field. Individual forecast category rollups: • PipelineOnly - Rollup from Pipeline opportunities only. • BestCaseOnly - Rollup from Best Case opportunities only. Adjustable. • CommitOnly - Rollup from Commit opportunities only. Adjustable. Cumulative forecast rollups: • OpenPipeline - Rollup from Pipeline + Best Case + Commit opportunities. • BestCaseForecast - Rollup from Best Case + Commit + Closed opportunities. Adjustable. • CommitForecast - Rollup from Commit + Closed opportunities. Adjustable. Either cumulative or individual forecast category rollups: • ClosedOnly - Rollup from Closed opportunities only. The ForecastingItemCategory field differs from the ForecastCategoryName field. • The ForecastCategoryName field represents the forecast category of the underlying opportunities rolling up to forecast amounts. In organizations using cumulative forecast rollups, the ForecastCategoryName field can be null because the cumulative forecast amounts include opportunities from multiple forecast categories. • The new ForecastingItemCategory field represents the type of rollup a forecast amount or adjustment is from. In organizations using individual forecast category columns, it contains the individual forecast rollup categories. In organizations using cumulative forecast rollups, it contains the cumulative rollup categories.
ForecastingTypeId
Type reference Properties Filter, Group, Sort Description The ID of the related ForecastingType.
HasAdjustment
Type boolean
991
Standard Objects
Field Name
ForecastingItem
Details Properties Defaulted on create, Filter, Group, Sort Description A flag that indicates if the forecasting item includes a manager adjustment. This flag is true only when the item includes an adjustment and the user performing the query has read access to the adjustment.
HasOwnerAdjustment
Type boolean Properties Defaulted on create, Filter, Group, Sort Description A flag that indicates if the forecasting item includes an owner adjustment. This flag is true only when the item includes an adjustment and the user performing the query has read access to the adjustment. Available in API versions 33 and greater.
IsAmount
Type boolean Properties Defaulted on create, Filter, Group, Sort Description True indicates that the adjustment is made in a revenue amount. If false, then IsQuantity must be true. This field is available in API version 28 and later.
IsQuantity
Type boolean Properties Defaulted on create, Filter, Group, Sort Description True indicates that the adjustment is made in a quantity amount. If false, then IsAmount must be true. This field is available in API version 28 and later.
IsUpToDate
Type boolean Properties Defaulted on create, Filter, Group, Sort Description A flag indicating whether or not a specific forecasting item reflects current information. For example, if users are making adjustments which are in process, the item won’t be up-to-date.
992
Standard Objects
ForecastingItem
Field Name
Details
OwnerId
Type reference Properties Filter, Group, Sort Description The ID of the forecast owner.
OwnerOnlyAmount
Type double Properties Filter, Sort, Nillable Description The sum of a person’s revenue opportunities, without adjustments.
OwnerOnlyQuantity
Type double Properties Filter, Sort, Nillable Description The sum of a person’s quantity opportunities, without adjustments. This field is available in API version 28 and later.
ParentForecastingItemId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the ForecastingItem that the current item rolls up to.
PeriodId
Type reference Properties Filter, Group, Nillable, Sort Description Period ID for the forecast.
ProductFamily
Type picklist Properties Filter, Group, Nillable, Sort
993
Standard Objects
Field Name
ForecastingItem
Details Description The product family of the forecast item. This field is available in API version 29 and later. Read only.
QuantityWithoutAdjustments
Type double Properties Filter, Sort, Nillable Description The sum of a person’s owned quantity opportunities and also his or her subordinates’ opportunities, without adjustments. Subordinates include everyone reporting up to a person in the forecast hierarchy. This field is available in API version 28 and later.
QuantityWithoutManagerAdjustment Type
double Properties Filter, Sort, Nillable Description The forecast number as seen by the forecast owner. This is the sum of the owner’s quantity opportunities and subordinates’ opportunities, including adjustments made on the subordinates’ forecasts. It doesn’t include adjustments made by forecast managers above the owner in the forecast hierarchy. This field is available in API version 28 and later. QuantityWithoutOwnerAdjustment Type
double Properties Filter, Sort, Nillable Description The forecast quantity as seen by the forecast owner without the owner's adjustment. This is the sum of the subordinate's opportunities, including adjustments made by their manager or by the subordinate themselves, plus the rollup of the owner's own opportunities. It doesn’t include adjustments made by the forecast owner. This field is available in API version 38.0 and later.
Usage Use this object to obtain individual forecast amounts, either with or without adjustments, based on a user’s perspective and forecast role. The ForecastingItem object is visible to all users, but only forecast managers and users above them in the forecast hierarchy can read or write ForecastingAdjustment records.
994
Standard Objects
ForecastingOwnerAdjustment
Note: Beginning with API version 30.0, organizations can have more than one forecasting type enabled. The ForecastingQuota, ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingItem, and ForecastingFact objects can all have records with different ForecastingTypeId values. Use the ForecastingType object to determine the ID for each forecast type and then filter ForecastingQuota, ForecastingAdjustment, ForecastingItem, or ForecastingFact records as necessary. SEE ALSO: ForecastingAdjustment ForecastingFact ForecastingQuota
ForecastingOwnerAdjustment This object represents an individual forecast user’s adjustment of their own forecast via a ForecastingItem. Available in API versions 33 and greater. This object is separate from the ForecastingAdjustment object, which represents managers’ adjustments of subordinates’ forecasts. Note: This information only applies to Collaborative Forecasts.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
CurrencyIsoCode
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency code of the adjustment. If omitted, the default is the importing user’s personal currency.
ForecastCategoryName
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The category within the sales cycle that an opportunity is assigned to based on its opportunity stage. The standard forecast categories are Pipeline, Best Case,
995
Standard Objects
Field Name
ForecastingOwnerAdjustment
Details Commit, Omitted, and Closed. You can customize forecast category names. The forecast categories display information for that specific category; for example, Best Case only reflects amounts in the Best Case category.
ForecastingItemCategory
Type picklist Properties Create, Filter, Group, Sort Description This field indicates which type of forecast rollup the owner adjustment belongs to. Depending on whether your organization uses individual forecast category rollups or cumulative forecast rollups, you have these possible values for the ForecastingItemCategory field. Individual forecast category rollups: • PipelineOnly - Rollup from Pipeline opportunities only. • BestCaseOnly - Rollup from Best Case opportunities only. Adjustable. • CommitOnly - Rollup from Commit opportunities only. Adjustable. Cumulative forecast rollups: • OpenPipeline - Rollup from Pipeline + Best Case + Commit opportunities. • BestCaseForecast - Rollup from Best Case + Commit + Closed opportunities. Adjustable. • CommitForecast - Rollup from Commit + Closed opportunities. Adjustable. Either cumulative or individual forecast category rollups: • ClosedOnly - Rollup from Closed opportunities only. The ForecastingItemCategory field differs from the ForecastCategoryName field. • The ForecastCategoryName field represents the forecast category of the underlying opportunities rolling up to forecast amounts. In organizations using cumulative forecast rollups, the ForecastCategoryName field can be null because the cumulative forecast amounts include opportunities from multiple forecast categories. • The new ForecastingItemCategory field represents the type of rollup a forecast amount or adjustment is from. In organizations using individual forecast category columns, it contains the individual forecast rollup categories. In organizations using cumulative forecast rollups, it contains the cumulative rollup categories. When inserting owner adjustments, the values you insert for ForecastCategoryName and ForecastingItemCategory must be compatible with each other. In organizations using cumulative forecast rollups, the ForecastCategoryName is nillable. These are the valid pairs.
996
Standard Objects
Field Name
ForecastingOwnerAdjustment
Details Individual forecast category rollups: • ForecastCategoryName: BestCase, ForecastingItemCategory: BestCaseOnly • ForecastCategoryName: Commit, ForecastingItemCategory: CommitOnly Cumulative forecast category rollups: • ForecastCategoryName: null, ForecastingItemCategory: BestCaseForecast • ForecastCategoryName: null, ForecastingItemCategory: CommitForecast
ForecastingItemId
Type reference Properties Filter, Group, Sort Description The ID of the related ForecastingItem.
ForecastingTypeId
Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the related ForecastingType.
ForecastOwnerId
Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the forecast owner.
IsAmount
Type boolean Properties Defaulted on create, Filter, Group, Sort Description True indicates that the adjustment is made in a revenue amount. If false, then IsQuantity must be true.
997
Standard Objects
ForecastingOwnerAdjustment
Field Name
Details
IsQuantity
Type boolean Properties Defaulted on create, Filter, Group, Sort Description True indicates that the adjustment is made in a quantity amount. If false, then IsAmount must be true.
OwnerAdjustedAmount
Type currency Properties Create, Filter, Nillable, Sort, Update Description The revenue amount of an individual forecast item, after an adjustment.
OwnerAdjustedQuantity
Type double Properties Create, Filter, Nillable, Sort, Update Description The quantity amount of an individual forecast item, after an adjustment.
OwnerAdjustmentNote
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description A text note providing information about the adjustment. The maximum length is 140 characters. This field does not appear in reports.
PeriodId
Type reference Properties Filter, Group, Nillable, Sort Description Period ID for the adjustment. Read only.
ProductFamily
Type picklist
998
Standard Objects
Field Name
ForecastingQuota
Details Properties Create, Filter, Group, Nillable, Sort Description The Product Family for the adjustment. Read only.
StartDate
Type date Properties Create, Filter, Group, Nillable, Sort Description The start of the adjustment, expressed as month and year. The date can include any day in a given month. Stored using the first date of the month.
Usage Use this object to obtain a user’s adjustment detail for a specified ForecastingItem in their own forecast. Note: Beginning with API version 30.0, organizations can have more than one forecasting type enabled. The ForecastingQuota, ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingItem, and ForecastingFact objects can all have records with different ForecastingTypeId values. Use the ForecastingType object to determine the ID for each forecast type and then filter ForecastingQuota, ForecastingAdjustment, ForecastingItem, or ForecastingFact records as necessary.
ForecastingQuota This object represents an individual user’s quota for a specified time period. The “Manage Quotas” user permission is required for creating, updating, or deleting quotas. (Users can only edit their subordinates’ quotas, not their own.) The “View All Forecasts” permission is required to View any user's forecast, regardless of the forecast role hierarchy. Available in API versions 25 and greater. Forecast managers can view the forecasts of subordinates who report to them in the forecast hierarchy. Note: This information only applies to Collaborative Forecasts.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
999
Standard Objects
ForecastingQuota
Fields Field Name
Details
CurrencyIsoCode
Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The currency code of the quota. If omitted, the default is the importing user’s personal currency.
ForecastingTypeId
Type reference Properties Create, Filter, Group, Sort Description The ID of the related ForecastingType.
IsAmount
Type boolean Properties Defaulted on create, Filter, Group, Sort Description True indicates that the adjustment is made in a revenue amount. If false, then IsQuantity must be true. This field is available in API version 28 and later.
IsQuantity
Type boolean Properties Defaulted on create, Filter, Group, Sort Description True indicates that the adjustment is made in a quantity amount. If false, then IsAmount must be true. This field is available in API version 28 and later.
PeriodId
Type reference Properties Filter, Group, Nillable, Sort Description Period ID for the quota. Read only.
1000
Standard Objects
ForecastingQuota
Field Name
Details
ProductFamily
Type picklist Properties Create, Filter, Group, Nillable, Sort Description The product family for the quota. This field is available in API version 29 and later.
QuotaAmount
Type currency Properties Create, Filter, Sort, Update Description The revenue quota amount for an individual user and for a specific period.
QuotaOwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID that identifies the quota owner.
QuotaQuantity
Type double Properties Create, Filter, Sort, Update Description The quantity quota amount for an individual user and for a specific period. This field is available in API version 28 and later.
StartDate
Type date Properties Create, Filter, Group, Sort, Update Description The start of the quota, expressed as month and year. The date can include any day in a given month. Stored using the first date of the month.
Usage Use this object to get an individual user’s quota for a specified time period.
1001
Standard Objects
ForecastingType
Note: Beginning with API version 30.0, organizations can have more than one forecasting type enabled. The ForecastingQuota, ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingItem, and ForecastingFact objects can all have records with different ForecastingTypeId values. Use the ForecastingType object to determine the ID for each forecast type and then filter ForecastingQuota, ForecastingAdjustment, ForecastingItem, or ForecastingFact records as necessary. SEE ALSO: ForecastingAdjustment ForecastingFact ForecastingItem
ForecastingType This object is used to identify the forecast type associated with ForecastingAdjustment, ForecastingOwnerAdjustment, ForecastingQuota, ForecastingFact, and ForecastingItem objects. Available in API versions 30.0 and greater. Note: This information only applies to Collaborative Forecasts.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
DeveloperName
Type string Properties Filter, Group, Sort Description The name of the forecasting type. Allowed values include: • OpportunityRevenue : Opportunities - Revenue • OpportunityQuantity : Opportunities - Quantity • OpportunitySplitRevenue : Opportunity Revenue Splits - Revenue • OpportunityOverlayRevenue : Opportunity Overlay Splits - Revenue • OpportunityLineItemRevenue : Product Families - Revenue • OpportunityLineItemQuantity : Product Families - Quantity • The name of a custom opportunity split type that has been enabled as a forecast type. Custom split types are based on currency fields, which can contain revenue amounts only.
1002
Standard Objects
Field Name
ForecastingType
Details The DeveloperName is called name in the Metadata API and Forecasting Type in custom reports.
HasProductFamily
Type boolean Properties Defaulted on create, Group Description Indicates whether a forecasts view includes product families. Available in API version 40.0 and later.
IsActive
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the forecasting type is enabled.
IsAmount
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the forecasting type is based on the revenue measurement.
IsQuantity
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the forecasting type is based on the quantity measurement.
Language
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the forecasting type.
MasterLabel
Type string
1003
Standard Objects
Field Name
ForecastingUserPreference
Details Properties Filter, Group, Sort Description Master label for this Forecasting Type value. This display value is the internal label that does not get translated.
Usage Use this object to identify the forecast type of ForecastingAdjustment, ForecastingQuota, ForecastingFact, and ForecastingItem objects.
ForecastingUserPreference Represents the forecasting selections that a user has made, such as display options, date range, forecasting type, and currency. Note: This information applies to Collaborative Forecasts and not to Customizable Forecasts.
Supported Calls create(), describeSObjects(), query(), update(), upsert()
Fields Field Name
Details
ExternalId
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A unique system-generated numerical identifier for the user.
ForecastingDisplayedTypeId
Type reference Properties Create, Group, Sort, Update Description An identifier for the forecasting type that’s displayed.
1004
Standard Objects
ForecastingUserPreference
Field Name
Details
ForecastingPeriodDuration
Type int Properties Create, Group, Nillable, Sort, Update Description How long the forecasting period lasts.
ForecastingPeriodType
Type picklist Properties Create, Group, Nillable, Restricted picklist, Sort, Update Description The forecasting period’s type. Valid values include: Month, Quarter, Week, or Year
ForecastingStartPeriod
Type int Properties Create, Group, Nillable, Sort, Update Description The date when the forecasting period begins.
ForecastingViewCurrency
Type string Properties Create, Group, Nillable, Sort, Update Description The currency shown on the forecasts page.
IsForecastingHideZeroRows
Type boolean Properties Create, Defaulted on create, Group, Sort, Update Description Whether the forecasts page shows zero-value rows.
IsForecastingShowQuantity
Type boolean Properties Create, Defaulted on create, Group, Sort, Update
1005
Standard Objects
Field Name
ForecastShare
Details Description Whether the forecasts page shows forecast quantity.
IsHideForecastingGuidedTour
Type boolean Properties Create, Defaulted on create, Group, Sort, Update Description Whether the forecasts page shows the guided tour.
IsHideForecastingQuotaColumn
Type boolean Properties Create, Defaulted on create, Group, Sort, Update Description Whether the forecasts page shows a quota column.
IsShowForecastingQuotaAttainment Type
boolean Properties Create, Defaulted on create, Group, Sort, Update Description Whether the forecasts page shows quota attainment information (Salesforce Classic only).
ForecastShare Represents the sharing of a customizable forecast at a given role and territory. Note: This information applies to Customizable Forecasting and not Collaborative Forecasts.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules Customer Portal users can’t access this object.
1006
Standard Objects
ForecastShare
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field
Details
AccessLevel
Type picklist Properties Filter, Group, Restricted picklist, Sort Description A value (Read, Edit, or All) that represents the type of sharing being allowed.
CanSubmit
Type boolean Properties Filter, Group, Sort Description Indicates whether the user or group can submit forecasts (True) or not (False).
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Valid values include: •
Manual—The User or Group has access because a User has manually shared
the forecast with them. • UserOrGroupId
Owner—The User is the owner of the forecast.
Type reference Properties Filter, Group, Sort Description The ID representing the User or Group being granted access.
UserRoleId
Type reference Properties Filter, Group, Sort
1007
Standard Objects
Field
Goal
Details Description ID of the UserRole associated with this object.
Usage This object allows you to determine which users and groups can view or submit forecasts owned by other users.
Goal The Goal object represents the components of a goal such as its name, description, and status.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field Name
Details
CompletionDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The completion date of the goal.
Description
Type textarea Properties Create, Nillable, Update Description The description of the goal. The maximum length is 65,535 characters.
DueDate
Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the goal is due.
1008
Standard Objects
Goal
Field Name
Details
ImageUrl
Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The URL for the goal image. The image must be stored in Documents and set as externally available. Applicable only to Goal objects of Type: Goal.
IsKeyCompanyGoal
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the goal is a key company goal.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp that indicates when a user last viewed a record that is related to this goal.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp that indicates when a user last viewed this goal. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.
Name
Type string Properties Create, Filter, Group, Sort, Update Description The name of the goal. The maximum length is 255 characters.
OwnerId
Type reference
1009
Standard Objects
Field Name
GoalFeed
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who owns the goal.
Progress
Type percent Properties Filter, Nillable, Sort Description The progress of the goal measured as a percentage.
StartDate
Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The start date of the goal.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the goal. Possible values: • Draft • Published • Completed • Canceled • Not Completed
GoalFeed Represents a single feed item in the feed displayed for a Goal record. The goal feed shows changes to a goal for fields that are tracked in feeds, posts, and comments about the goal.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
1010
Standard Objects
GoalFeed
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content of the FeedItem. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The numbers of FeedComments associated with this feed item.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort
1011
Standard Objects
Field Name
GoalFeed
Details Description Available in API version 36.0 and earlier only. The file uploaded to the feed. Required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int Properties Available in API version 36.0 and earlier only. Group, Nillable, Sort Description Read only. Automatically determined during insert. The size of the file (in bytes) uploaded to the feed.
ContentType
Type string Properties Available in API version 36.0 and earlier only. Group, Nillable, Sort Description Read only. Automatically determined during insert. The MIME type of the file uploaded to the feed.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if a client application migrates posts and comments from another application into a feed, then InsertedById is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines.
1012
Standard Objects
Field Name
GoalFeed
Details • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the goal record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference
1013
Standard Objects
Field Name
GoalFeed
Details Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost. For example, set this field to an existing ContentVersion and post it to a feed as a FeedItem object of TypeContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the FeedItem. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item. Except for ContentPost, LinkPost, and TextPost, don’t create feed item types directly from the API. • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file.
1014
Standard Objects
Field Name
GoalFeed
Details • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • AttachArticleEvent—generated event when a user attaches an article to a case. • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • CaseCommentPost—generated event when a user adds a case comment for a case object. • ChangeStatusPost—generated event when a user changes the status of a case. • ChatTranscriptPost—generated event when Live Agent transcript is saved to a case. • EmailMessageEvent—generated event when an email related to a case object is sent or received. • FacebookPost—generated when a Facebook post is created from a case. Deprecated. • MilestoneEvent—generated when a case milestone is completed or reaches violation status. • SocialPost—generated when a social post is created from a case.
1015
Standard Objects
GoalHistory
GoalHistory This read-only object contains historical information about changes that have been made to the Goal object.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
GoalId
Type reference Properties Filter, Group, Sort Description ID of the goal.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed.
1016
Standard Objects
GoalLink
GoalLink Represents the relationship between two goals. This is a many-to-many relationship, meaning that each goal can link to many other goals.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
Fields Field Name
Details
Name
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The auto-generated name of the goal link.
ParentGoalId
Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the parent goal.
SubgoalId
Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the subgoal.
GoalShare Represents a sharing entry on a Goal object.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
1017
Standard Objects
GoalShare
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The user’s or group’s level of access to the goal. The possible values are: • Read Only • Read/Write • Owner This field must be set to an access level that is higher than the organization’s default access level for goals.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the goal that is associated with this sharing entry.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Valid values include: • Owner: User is the owner of the Goal or is in a user role above the Goal owner in the role hierarchy. • Manual: User or group has access because a user with “All” access manually shared the Goal with the user or group. • Rule: User or group has access via a Goal sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort
1018
Standard Objects
Field Name
GoogleDoc
Details Description ID of the user or group that was given access to the Goal. This field can’t be updated.
GoogleDoc Represents a link to a Google Document. This object is available in API version 14.0 and later.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Special Access Rules This object is available in All Editions except Database.com for Google Apps Premier Edition accounts. See the Salesforce online help for more information.
Fields Field
Details
Name
Type string Properties Create, Filter, Group, Sort, Update Description The name of the Google document.
Owner
Type reference Properties Create, Defaulted on create, Filter, Nillable, Update Description The ID of the user who currently owns this Google Document. Default value is the user logged in to the API to perform the create.
ParentId
Type reference Properties Create, Filter
1019
Standard Objects
Field
Group
Details Description Required. ID of the attachment's parent object. The following objects are supported as parents of Google documents: Account, Asset, Campaign, Case, Contact, Contract, Custom Objects, Lead, Opportunity, Product2, and Solution.
Url
Type string Properties Create, Filter, Nillable, Update Description The URL of the Google document.
Group A set of User records. Groups are sets of users. They can contain individual users, other groups, the users in a particular role or territory, or the users in a particular role or territory plus all of the users below that role or territory in the hierarchy.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), search(), retrieve(), update(), upsert()
Special Access Rules Customer Portal users can’t access this object.
Fields Field
Details
DefaultDivision
Type picklist Properties Filter, Group, Restricted picklist, Sort Description This record’s default division. Only applicable if divisions are enabled for your organization.
DeveloperName
Type string
1020
Standard Objects
Field
Group
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update 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. Corresponds to Group Name in the user interface. This field is available in API version 24.0 and later. Note: 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.
DoesIncludeBosses
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the managers have access (true) or do not have access (false) to records shared with members of the group. This field is only available for public groups. This field is available in API version 18.0 and later.
DoesSendEmailToMembers
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the email is sent (true) or not sent (false) to the group members. The email is sent to queue members as well.
Email
Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address for a group of type Case. Applies only for a case queue.
Name
Type string
1021
Standard Objects
Field
Group
Details Properties Create, Filter, Group, Sort, Update Description Required. Name of the group. Corresponds to Label on the user interface.
OwnerId
Type reference Properties Filter, Group, Sort Description ID of the user who owns the group.
QueueRoutingConfig
Type reference Properties Create, Delete, Query, Retrieve, Update Description The ID of the queue routing configuration associated with the queue.
RelatedId
Type reference Properties Filter, Group, Nillable, Sort Description Represents the ID of the associated groups. For Groups of type “Role,” the ID of the associated UserRole. The RelatedId field is polymorphic.
Type
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Required. Type of the Group. One of the following values: • Regular—Standard Public Group. When you create() a Group, its type must be Regular, unless a partner portal is enabled for the organization, in which case the type can be Regular or PRMOrganization. • Role—Public Group that includes all of the User records in a particular UserRole. • RoleAndSubordinates—Public Group that includes all of the User records in a particular UserRole and all of the User records in any subordinateUserRole. • Organization—Public Group that includes all of the User records in the organization. This Group is read-only.
1022
Standard Objects
Field
GroupMember
Details • Case—Public group of users, members of a queue that can own a Case. • Lead—Public group of users, members of a queue that can own a Lead. • Manager—Public group that includes a user’s direct and indirect managers. This Group is read-only. • ManagerAndSubordinatesInternal—Public Group that includes a user and the user’s direct and indirect reports. This Group is read-only. • PRMOrganization—Public Group that includes all of the partners in an organization that has the partner portal feature enabled. • Queue—Public Group that includes all of the User records that are members of a queue. • Territory—Public Group that includes all of the User records in an organization that has the territory feature enabled. • TerritoryAndSubordinates—Public Group that includes all of the User records in a particular UserRole and all of the User records in any subordinateUserRole. • Collaboration—Chatter group. Only Regular, Case, and Lead can be used when creating a group. The other values are reserved.
Usage Unlike users, this object can be deleted. Any User can access this object—no special permissions are needed. Only public groups are accessible via the API. Personal groups are not available. In API version 40.0 and later, you can query a Group using Related.Name to retrieve the Group’s name. Related.Name is supported for public groups, user roles, territories, manager groups, and user names. In API version 13.0 and later, if you delete a public group, it will be deleted even if it has been used in sharing, consistent with the behavior for UserRole. In versions before 13.0, such sharing prevents the record from being deleted. SEE ALSO: GroupMember Object Basics
GroupMember Represents a User or Group that is a member of a public group.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
1023
Standard Objects
HashtagDefinition
Special Access Rules Customer Portal users cannot access this object.
Fields Field
Details
GroupId
Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Group.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description Required. ID of the User or Group that is a direct member of the group.
Usage A record exists for every User or Group who is a direct member of a public group whose Type field is set to Regular. User records that are indirect members of Regular public groups are not listed as group members. A User can be an indirect member of a group if he or she is in a UserRole above the direct group member in the hierarchy, or if he or she is a member of a group that is included as a subgroup in that group. If you attempt to create a record that matches an existing record, system simply returns the existing record. SEE ALSO: Object Basics
HashtagDefinition HashtagDefinition represents hashtag (#) topics in public Chatter posts and comments. Public posts and comments include those on profiles and in public groups, but not those on records or in private groups. This object is available in API version 26.0 and later. Important: Starting in Spring ’16, API access to HashtagDefinition is disabled across all API versions. Any integrations relying on API queries to this object stop working. You can continue to use hashtags in posts and comments, and the hashtags continue to create corresponding topics. We recommend that you redirect all API queries and reports using the HashtagDefinition object to use the Topic object instead. For more information, see Retiring the Legacy HashtagDefinition Object—FAQs.
1024
Standard Objects
HashtagDefinition
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
HashtagCount
Type int Properties Filter, Group, Nillable, Sort Description The number of times a hashtag topic is used.
Name
Type string Properties Filter, Nillable, Sort Description The string of characters following the hashtag (#) in a hashtag topic.
NameNorm
Type string Properties Filter, Nillable, Sort Description The string of characters following the hashtag (#) in a hashtag topic, normalized to remove capitalization and punctuation.
NetworkId
Type reference Properties Filter, Group, Nillable, Sort Description Identifier of the community to which the HashtagDefinition belongs. This field is available only if Salesforce Communities is enabled in your organization.
1025
Standard Objects
Holiday
Usage Use this object to identify public hashtag topics and see how often they’re used. SEE ALSO: Topic
Holiday Represents a period of time during which your customer support team is unavailable. Business hours and escalation rules associated with business hours are suspended during any holidays with which they are affiliated.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Special Access Rules Customer Portal users can’t access this object. All users, even those without the “View Setup and Configuration” user permission, can view holidays via the API.
Fields Field
Details
ActivityDate
Type date Properties Create, Filter, Group, Nillable, Sort, Update Description If the Holiday IsAllDay flag is set to true (indicating that it is an all-day holiday), then the holiday due date information is contained in the ActivityDate field. This field is a date field with a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant, and you should not attempt to alter it to account for any time zone differences.
Description
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the holiday.
1026
Standard Objects
Holiday
Field
Details
EndTimeInMinutes
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The end time of the holiday in minutes.
IsAllDay
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the duration of the holiday is all day (true) or not (false).
IsRecurrence
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the holiday is scheduled to repeat itself (true) or only occurs once (false). This is a read only field on update, but not on create. If this field value is true, then any recurrence fields associated with the given recurrence type must be populated.
Name
Type string Properties Create, Filter, Group, Sort, Update Description The name of the holiday.
RecurrenceDayOfMonth
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The day of the month on which the holiday repeats.
RecurrenceDayOfWeekMask Type
int Properties Create, Filter, Group, Nillable, Sort, Update
1027
Standard Objects
Field
Holiday
Details Description The day or days of the week on which the holiday repeats. This field contains a bitmask. For each day of the week, the values are as follows: • Sunday = 1 • Monday = 2 • Tuesday = 4 • Wednesday = 8 • Thursday = 16 • Friday = 32 • Saturday = 64 Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 4 + 16 = 20.
RecurrenceEndDateOnly
Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The last date on which the holiday repeats. For multiday recurring events, this is the day on which the last occurrence starts.
RecurrenceInstance
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The frequency of the recurring holiday. For example, 2nd or 3rd.
RecurrenceInterval
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The interval between recurring holidays.
RecurrenceMonthOfYear
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The month of the year on which the event repeats.
1028
Standard Objects
Idea
Field
Details
RecurrenceStartDate
Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the recurring holiday begins. Must be a date and time before RecurrenceEndDateOnly.
RecurrenceType
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates how often the holiday repeats. For example, daily, weekly, or every Nth month (where “Nth” is defined in RecurrenceInstance).
StartTimeInMinutes
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The start time of the holiday in minutes.
Usage Use this object to view and update holidays, which specify dates and times at which associated business hours and escalation rules are suspended.
Idea Represents an idea on which users are allowed to comment and vote, for example, a suggestion for an enhancement to an existing product or process. This object is available in API version 12 and later.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Note: For other standard objects, the describeLayout() call returns the recordTypeMappings section that contains the layout ID and picklist values for each record type. However, the recordTypeMappings section and the fields it includes are not available for the Idea object. When performing a SOSL search on Idea objects, IdeaComment objects are also searched.
1029
Standard Objects
Idea
Fields Field
Details
AttachmentBody
Type base64 Properties Create, Nillable, Update Description File data for the attachment. This field is available in API version 28.0 and later.
AttachmentContentType
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of the attachment. This field is available in API version 28.0 and later.
AttachmentLength
Type int Properties Filter, Group, Nillable, Sort Description Size of the attachment in bytes. This field is available in API version 28.0 and later.
AttachmentName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the attachment. This field is available in API version 28.0 and later.
Body
Type textarea Properties Create, Nillable, Update Description Description of the Idea.
Categories
Type multipicklist
1030
Standard Objects
Field
Idea
Details Properties Create, Filter, Nillable, Update Description Customizable multi-select picklist used to organize Ideas into logical groupings. Note: This field is only available if your organization has the Categories field enabled. This field is enabled by default in organizations created after API version 14 was released. If the Categories field is enabled, API versions 13 and earlier do not have access to either the Categories or Category fields.
Category
Type picklist Properties Create, Filter, Nillable, Update Description Customizable picklist of values used to organize Ideas into logical groupings. Note: This field is not available if your organization has the multi-select Categories field enabled.
CommunityId
Type reference Properties Create, Filter, Group, Sort Description The zone ID associated with the idea. Once you create an idea, you can’t change the zone ID associated with that idea. Note: API version 12 does not support zone ID. If you create an idea in version 12, your idea is automatically posted to the oldest zone that you have permission to access.
CreatorFullPhotoUrl
Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s profile photo. This field is available in API version 28.0 and later.
CreatorName
Type string Properties Filter, Group, Nillable, Sort
1031
Standard Objects
Field
Idea
Details Description Name of the user who posted the idea or commented on the idea. This field is available in API version 28.0 and later.
CreatorSmallPhotoUrl
Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s thumbnail photo. This field is available in API version 28.0 and later.
CurrencyIsoCode
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
IdeaThemeID
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Identifies the idea theme associated with the idea.
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
IsHtml
Type boolean Properties Defaulted on create, Filter, Group, Sort
1032
Standard Objects
Field
Idea
Details Description Read-only. If this value is true, your organization has the Ideas HTML editor enabled, and the Idea Body may contain HTML. If this value is false, the HTML editor is disabled and the Idea Body only contains regular text.
IsMerged
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read only. Indicates whether the idea has been merged with a parent idea (true) or not (false). You can’t vote for or add comments to a merged idea. Note: In API version 27, IsMerged replaces IsLocked. Existing formula fields that use IsLocked must be edited to use IsMerged.
LastCommentDate
Type dateTime Properties Filter, Nillable, Sort Description The date and time the last comment (child IdeaComment object) was added.
LastCommentId
Type reference Properties Filter, Group, Nillable, Sort Description Read only. The ID of the last comment (child IdeaComment object).
LastReferencedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type date Properties Filter, Nillable, Sort, Update
1033
Standard Objects
Field
Idea
Details Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
NumComments
Type int Properties Defaulted on create, Filter, Group, Nillable, Sort Description The number of comments (child IdeaComment objects) that users have submitted for the given idea.
ParentIdeaId
Type reference Properties Filter, Group, Nillable, Sort Description The ID associated with this idea's parent idea. When multiple ideas are merged together, one idea becomes the parent (master) of the other ideas. The ParentIdeaId is automatically set when you merge ideas.
RecordTypeId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the record type assigned to this object.
Status
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Customizable picklist of values used to specify the status of an idea.
Title
Type string Properties Create, Filter, Group, Sort, Update Description The descriptive title of the idea.
1034
Standard Objects
IdeaComment
Field
Details
VoteScore
Type double Properties Filter, Nillable, Sort Description The internal score of the Idea, used to sort Ideas on the Popular tab in the application user interface. The internal algorithm that determines the score gives older votes less weight than newer votes, simulating exponential decay. The score itself does not display in the application user interface. Note: Unlike other fields of type double, you can't use a SOQL aggregate function with this field.
VoteTotal
Type double Properties Filter, Nillable, Sort Description An Idea's total number of points. Each vote a user makes is worth ten points, therefore the value of this field is ten times the number of votes an idea has received. Note: Unlike other fields of type double, you can't use a SOQL aggregate function with this field.
Note: If you are importing Idea data and need to set the value for an audit field, such as CreatedDate, contact Salesforce. Audit fields are automatically updated during API operations unless you request to set these fields yourself..
Usage Use this object to track ideas, which are written suggestions on which users can vote and comment. SEE ALSO: IdeaComment Vote
IdeaComment Represents a comment that a user has submitted in response to an idea.
1035
Standard Objects
IdeaComment
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Note: When performing a SOSL search on IdeaComment objects, Idea objects are also searched.
Fields Field
Field Type
CommentBody
Type textarea Properties Create, Filter, Nillable, Sort, Update Description Body of the submitted comment.
CommunityId
Type reference Properties Create, Filter, Group, Sort Description The zone ID associated with the idea. Once you create an idea, you can’t change the zone ID associated with that idea. Note: API version 12 does not support zone ID. If you create an idea in version 12, your idea is automatically posted to the oldest zone that you have permission to access.
CreatorFullPhotoUrl
Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s profile photo. This field is available in API version 28.0 and later.
CreatorName
Type string Properties Filter, Group, Nillable, Sort Description Name of the user who posted the idea or commented on the idea. This field is available in API version 28.0 and later.
1036
Standard Objects
IdeaComment
Field
Field Type
CreatorSmallPhotoUrl
Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s thumbnail photo. This field is available in API version 28.0 and later.
IdeaId
Type reference Properties Create, Filter, Group, Sort Description ID of the idea on which this comment was made.
IsHtml
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. If this value is true, your organization has the Ideas HTML editor enabled, and the CommentBody field may contain HTML. If this value is false, the HTML editor is disabled and the CommentBody field only contains regular text.
UpVotes
Type int Properties Filter, Group, Nillable, Sort Description Total number of up votes for the question.
Note: If you import these records, and need to set the value for an audit field, such as CreatedDate, contact Salesforce. Audit fields are automatically updated during API operations unless you request to set these fields yourself.
Usage Use this object to track comments on ideas, which are users' text responses to ideas. SEE ALSO: Idea Vote
1037
Standard Objects
IdeaReputation
IdeaReputation Represents a collection of statistics and scores derived from a user’s activity within an Ideas zone or internal organization. This object is available in API version 28.0 and later.
Supported Calls query(), retrieve(),
Fields Field
Details
CommentCount
Type int Properties Filter, Group, Nillable, Sort Description The number of comments a user has created in a zone or the internal organization. This number excludes comments the user creates on his or her own idea.
CommentsReceivedCount
Type int Properties Filter, Group, Nillable, Sort Description The number of comments a user has received in a zone or the internal organization.
ContextId
Type reference Properties Filter, Group, Namepointing, Nillable, Sort Description The ID of the zone or internal organization.
DownVotesGivenCount
Type int Properties Filter, Group, Nillable, Sort Description The number of down votes a user has given in a zone or the internal organization.
1038
Standard Objects
IdeaReputation
Field
Details
DownVotesReceivedCount
Type int Properties Filter, Group, Nillable, Sort Description The number of down votes a user has received in a zone or the internal organization.
IdeaCount
Type int Properties Filter, Group, Nillable, Sort Description The number of ideas a user has created in a zone or the internal organization.
ReputationLevel
Type string Properties Nillable Description The reputation level that a user has achieved based on their score in a zone or within an organization.
Score
Type double Properties Filter, Nillable, Sort Description The total score of a user’s activity within a zone or within an organization.
UpVotesGivenCount
Type int Properties Filter, Group, Nillable, Sort Description The number of up votes a user has given in a zone or the internal organization. This number doesn’t include the default vote the system applies when the user creates the idea.
UpVotesReceivedCount
Type int Properties Filter, Group, Nillable, Sort
1039
Standard Objects
Field
IdeaReputationLevel
Details Description The number of up votes a user has received in a zone or the internal organization.
UserId
Type reference Properties Filter, Group, Sort Description The user ID associated with the reputation.
Usage Use to query a user’s reputation within a zone.
IdeaReputationLevel Represents a reputation level within an Ideas zone or internal organization and is used by the system to calculate reputation. You can create up to 25 levels per zone or internal organization. This object is available in API version 28.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
ContextId
Type reference Properties Create, Filter, Group, Namepointing, Sort, Update Description The ID of the zone or internal organization.
Name
Type string Properties Create, Filter, Group, Sort, Update
1040
Standard Objects
Field Name
IdeaTheme
Details Description Name of the reputation level. The name must be unique within the zone or internal organization. Maximum size is 50 characters.
Threshold
Type int Properties Create, Filter, Group, Sort, Update Description Minimum number of points for this level. The threshold must be unique within the zone or internal organization and must be greater than or equal to zero.
Usage Use to create or edit reputation levels for an Ideas zone or internal organization.
IdeaTheme Represents an invitation to community members to submit ideas that are focused on a specific topic. This object is available in API version 26 and later.
Supported Calls create(), delete(), describeLayout(), query(), retrieve(), search(), undelete(), update(),
Fields Field Name
Details
Categories
Type multipicklist Properties Create, Filter, Nillable, Update Description Customizable multi-select picklist used to organize ideas and idea themes into logical groupings.
CommunityId
Type reference
1041
Standard Objects
Field Name
IdeaTheme
Details Properties Create, Filter, Group, Nillable, Sort, Description The zone ID associated with the idea theme.
CurrencyIsoCode
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
Description
Type textarea Properties Create, Nillable, Update Description Description of the idea theme.
EndDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date marking the end of the idea theme.
LastReferencedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
StartDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date that the idea theme begins.
1042
Standard Objects
KnowledgeableUser
Field Name
Details
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Customizable picklist of values used to specify the status of the idea theme.
Title
Type string Properties Create, Filter, Group, idLookup, Namefield, Sort, Update Description Title of the idea theme.
Usage Use the object to track ideas that are submitted to an idea theme.
KnowledgeableUser Represents a user identified as knowledgeable about a specific topic, and ranks them relative to other knowledgeable users. This object is available in API version 31.0 and later.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
NetworkId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the community the topic exists in. This field is available only if Salesforce Communities is enabled for your organization.
1043
Standard Objects
KnowledgeArticle
Field Name
Details
RawRank
Type int Properties Filter, Group, Nillable, Sort Description Rank of this user’s knowledge on the topic relative to other users.
TopicId
Type reference Properties Filter, Group, Sort Description Unique ID for the topic in Salesforce.
UserId
Type reference Properties Filter, Group, Sort Description Unique ID for the user in Salesforce.
KnowledgeArticle Provides read-only access to an article and the ability to delete the master article. This object is available in API version 19.0 and later. Unlike KnowledgeArticleVersion, the ID of a KnowledgeArticle record is identical irrespective of the article's version (status). For more information on articles and article types, see “Work with Articles and Translations” and “Knowledge Article Types” in the Salesforce online help.
Supported Calls delete(), describeSObjects(), query(), retrieve()
Special Access Rules A user must have the “View Articles” permission enabled. Salesforce Knowledge users, unlike Customer Portal and partner portal users, must also be granted the Knowledge User feature license.
1044
Standard Objects
KnowledgeArticle
Fields Field Name
Details
ArchivedById
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who archived the article.
ArchivedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the article was archived.
ArticleNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The unique number automatically assigned to the article when it's created. You can't change the format or value for this field.
CaseAssociationCount
Type int Properties Filter, Group, Sort Description The number of cases attached to the article.
FirstPublishedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the article was first published.
LastPublishedDate
Type dateTime Properties Filter, Nillable, Sort
1045
Standard Objects
Field Name
KnowledgeArticleVersion
Details Description The date when the article was last published.
LastReferencedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
MasterLanguage
Type picklist Properties Filter, Restricted picklist Description The article's original language. Only accessible if your knowledge base supports multiple languages.
Usage Use this object to query or retrieve articles. KnowledgeArticle can be used in a SOQL clause, but doesn’t provide access to the fields from the article. Provides read-only access to an article and the ability to delete the master article. SEE ALSO: KnowledgeArticleVersion
KnowledgeArticleVersion Provides a global view of standard article fields across all article types depending on their version. This object is available in API version 18.0 and later. Use this object to: • Query or search generically across multiple article types.
1046
Standard Objects
KnowledgeArticleVersion
• Filter on a specific version. • Update standard fields, those fields that are updateable, in draft versions. When you query on the archived article, the results include both the article and the article’s archived versions. Note: You can’t update draft translations with the API.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), and update().
Note: • You can only update draft versions. • To create, update, or delete a Knowledge article version, use the call on ArticleType_kav, where ArticleType is the name of the article’s type. For example, to delete, use ArticleType_kav.delete().
Special Access Rules A user must have the “View Articles” permission enabled. Salesforce Knowledge users, unlike Customer Portal and partner portal users, must also be granted the Knowledge User feature license to view and edit article versions.
Fields Field Name
Details
ArchivedById
Type reference Properties Filter, Nillable Description The ID of the user who archived the article.
ArchivedDate
Type dateTime Properties Filter, Nillable Description The date when the article was archived.
ArticleNumber
Type string Properties Autonumber, Defaulted on create, Filter
1047
Standard Objects
Field Name
KnowledgeArticleVersion
Details Description The unique number automatically assigned to the article when it's created. You can't change the format or value for this field.
ArticleType
Type string Properties Defaulted on create,Filter Description Indicates the API Name of the article type. The ArticleType is assigned to the article when it's created. You can't change the value of this field. This field is available in API version 26.0 and later.
FirstPublishedDate
Type dateTime Properties Filter, Nillable Description The date when the article was first published.
IsLatestVersion
Type boolean Properties Defaulted on create, Group, Filter, Sort Description Indicates whether the article is the most current version. (true) or not (false). This field can be true on the online or published version, a draft version in the master language, a draft version in a translation, and the latest archived version. However, you can’t filter by (PublishState=’Online’) and (IsLatestVersion=false) because the online version is also the latest version. This field is available in API version 24.0 and later.
IsMasterLanguage
Type boolean Properties Defaulted on create, Filter Description Indicates whether the article has one or more translations associated with it (true) or not (false). Only accessible if your knowledge base supports multiple languages.
IsOutOfDate
Type boolean
1048
Standard Objects
Field Name
KnowledgeArticleVersion
Details Properties Defaulted on create, Filter Description Indicates whether the source article has been updated since this translated version was created (true) or not (false). Only accessible if your knowledge base supports multiple languages.
IsVisibleInApp
Type boolean Properties Defaulted on create, Filter Description Required. Indicates whether the article is visible in the Articles tab (true) or not (false).
IsVisibleInCsp
Type boolean Properties Defaulted on create, Filter Description Required. Indicates whether the article is visible in the Customer Portal (true) or not (false).
IsVisibleInPkb
Type boolean Properties Defaulted on create, Filter Description Required. Indicates whether the article is visible in the public knowledge base (true) or not (false).
IsVisibleInPrm
Type boolean Properties Defaulted on create, Filter Description Required. Indicates whether the article is visible in the partner portal (true) or not (false).
KnowledgeArticleId
Type reference
1049
Standard Objects
Field Name
KnowledgeArticleVersion
Details Properties Filter Description The ID of the article independent from its version. The value for this field is retrieved from the Id field of the KnowledgeArticle object.
Language
Type picklist Properties Filter, Restricted picklist Description The language that the article is written in, such as French or Chinese (Traditional). Querying or searching articles in SOQL or SOSL requires that you specify the Language field in the WHERE clause. The language must be the same for all article types.
LastPublishedDate
Type dateTime Properties Filter, Nillable Description The date when the article was last published.
MasterVersionId
Type reference Properties Filter, Nillable Description ID of the source article, if the article is the translation of a source article. Only accessible if your knowledge base supports multiple languages.
OwnerId
Type reference Properties Filter Description The ID of the article's owner.
PublishStatus
Type picklist
1050
Standard Objects
Field Name
KnowledgeArticleVersion
Details Properties Defaulted on create, Filter, Restricted picklist Description The publication status for the article: • Draft: any draft articles. • Online: articles published in Salesforce Knowledge. • Archived: archived articles. A user must have the “Manage Articles” permission enabled to use Online. Querying or searching articles in SOQL or SOSL requires that you specify either the PublishStatus or the Id field in the WHERE clause. You can search for only one publication status per article type in a single SOSL query. When searching for articles with a PublishStatus of Archived, also check that IsLatestVersion equals false in your WHERE clause.
SourceId
Type reference Properties Filter, Nillable Description ID of the source from which the article was created (Case or Reply).
Summary
Type textarea Properties Filter, Nillable Description Summary of the article. Maximum size is 1000 characters.
Title
Type string Properties Defaulted on create, Filter, idLookup Description Required. Article's title. Maximum size is 255 characters.
TranslationCompletedDate
Type dateTime Properties Filter, Nillable
1051
Standard Objects
Field Name
KnowledgeArticleVersion
Details Description Date and time when the article was last translated. Only accessible if your knowledge base supports multiple languages.
TranslationExportedDate
Type dateTime Properties Filter, Nillable Description Date and time when the article was last exported for translation. Only accessible if your knowledge base supports multiple languages.
TranslationImportedDate
Type dateTime Properties Filter, Nillable Description Date and time when the article was last imported for translation. Only accessible if your knowledge base supports multiple languages.
UrlName
Type string Properties Filter Description Required. Represents the article's URL. Can contain alphanumeric characters and hyphens but can't begin or end with a hyphen. UrlName is case-sensitive and its maximum size is 255 characters.
ValidationStatus
Type picklist Properties Filter, Group Description Shows whether the content of the article has been validated. Default values are Validated and Not Validated. This field is available in API version 24.0 or later.
VersionNumber
Type int Properties None
1052
Standard Objects
Field Name
KnowledgeArticleVersion
Details Description The number assigned to a version of an article. This field is available in API version 24.0 and later.
Usage Use this object to query, retrieve, or search for articles across all article types depending on their version. You can update draft master articles. Additionally, you can delete articles that are not drafts. Client applications can use KnowledgeArticleVersion with describeDataCategoryGroups() and describeDataCategoryGroupStructures() to return the category groups and the category structure associated with Salesforce Knowledge. Alternatively, client applications can use the article type API Name followed by __kav to query, retrieve, or search for articles for a specific article type. To access an article independent of its version, use the KnowledgeArticle object.
SOQL Samples The following SOQL clause uses KnowledgeArticleVersion to query all published articles from all article types complying with the classification specified in the WITH DATA CATEGORY clause: SELECT Title, Summary FROM KnowledgeArticleVersion WHERE PublishStatus='Online' AND Language = 'en_US' WITH DATA CATEGORY Geography__c ABOVE_OR_BELOW europe__c AND Product__c BELOW All__c
The following SOQL clause uses the article type API Name to limit the query to all draft articles from the Offer__kav article type: SELECT Id, Title FROM Offer__kav WHERE PublishStatus='Draft' AND Language = 'en_US' WITH DATA CATEGORY Geography__c AT (france__c,usa__c) AND Product__c ABOVE dsl__c
The following SOQL clause uses KnowledgeArticleVersion to query the Ids of all archived versions of a particular article: SELECT Id FROM KnowledgeArticleVersion WHERE PublishStatus='Archived' AND IsLatestVersion=false AND KnowledgeArticleId='kA1D00000001PQ6KAM'
SOQL and SOSL with KnowledgeArticleVersion • Always filter on a single value of PublishStatus unless the query filters on one or more primary key IDs. To support security, only users with the “Manage Articles” permission see articles whose PublishStatus value is Draft. • Archived article versions are stored in the articletype_kav object. To query archived article versions, specify the article Id and set IsLatestVersion='0'.
1053
Standard Objects
KnowledgeArticleVersionHistory
• Always filter on a single value of Language. However, in SOQL, you can filter on more than one Language if there is a filter on Id or KnowledgeArticleId. SEE ALSO: KnowledgeArticle KnowledgeArticleViewStat KnowledgeArticleVoteStat
KnowledgeArticleVersionHistory Enables read-only access to the full history of an article. This object is available in API version 25.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules This object respects field, entity, and record-level security. You must have at least “Read” permission on the article type or the field to access its history. For data category security, Salesforce determines access based on the categorization of the online version of an article. If there is no online version, then security is applied based on the archived version, followed by the security of the draft version.
Fields Field Name
Details
EventType
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of event that is tracked in the history table.
FieldName
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Name of the tracked field.
Language
Type picklist
1054
Standard Objects
Field Name
KnowledgeArticleVersionHistory
Details Properties Filter, Group, Restricted picklist, Sort Description The language that the article is written in, such as French or Chinese (Traditional). Querying or searching articles in SOQL or SOSL requires that you specify the Language field in the WHERE clause. The language must be the same for all article types.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The most recent value of the field before it was changed.
ParentId
Type reference Properties Filter, Group, Sort Description The ID of the article.
ParentSobjectType
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of object that contains the field.
VersionId
Type reference Properties Filter, Group, Nillable, Sort
1055
Standard Objects
Field Name
KnowledgeArticleViewStat
Details Description The ID assigned to a version of the article.
VersionNumber
Type int Properties Filter, Group, Sort Description The number assigned to a version of an article. This field is available in API version 24.0 and later.
Usage Use this object to query events in the history of an article. For example, you can retrieve the number of edits a particular user has made to an article, how many times the article has been published, and so on.
KnowledgeArticleViewStat Provides statistics on the number of views for the specified article across all article types. This object is read-only and available in API version 20 and later.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules Users must have access to the published version of an article to retrieve its views. For more information on published article version, see the PublishStatus field in KnowledgeArticleVersion.
Fields Field Name
Details
Channel
Type picklist Properties Filter, Restricted picklist Description The channel where the article is viewed: • AllChannels for article views across all channels.
1056
Standard Objects
Field Name
KnowledgeArticleViewStat
Details • App for the internal Salesforce Knowledge application. • Pkb for article views in public knowledge base. • Csp for Customer Portal. • Prm for article view in partner portal.
NormalizedScore
Type double Properties Filter, Nillable Description Article's weighted views in the selected channel. The article with most views has a score of 100. Other article views are then calculated relative to this highest view score. For example, if the best read article has 2000 views and another has 1000. The first one gets a score of 100 while the second gets 50.
ParentId
Type reference Properties Filter Description ID of the viewed article. This corresponds to a KnowledgeArticle record.
ViewCount
Type int Properties Filter, Group, Sort Description The number of unique views an article has received in the selected channel. An article with a high number of views may not always have a high normalized score. The normalized score for an article is calculated based on views over time, with more recent views earning a higher score. This field is available in API version 27.0 and later.
Usage Use this object to query or retrieve statistics for article views. Alternatively, client applications can use the article type API Name followed by __ViewStat to query or retrieve most viewed articles from a specific article type.
1057
Standard Objects
KnowledgeArticleVoteStat
SOQL Samples The following SOQL clause uses KnowledgeArticleViewStat to query all the article views in Salesforce Knowledge and return the related articles: SELECT Id, NormalizedScore, Parent.Id FROM KnowledgeArticleViewStat where Channel = 'App' ORDER BY NormalizedScore
Use the following clause to restrict your query to Offer articles for the Offer article type: SELECT Id, NormalizedScore, Parent.Id FROM Offer__ViewStat where Channel = 'App' ORDER BY NormalizedScore
SEE ALSO: KnowledgeArticle KnowledgeArticleVersion KnowledgeArticleVoteStat
KnowledgeArticleVoteStat Provides the weighted rating for the specified article on a scale of 1 to 5 across all article types. This object is read-only and available in API version 20 and later.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules Users must have access to the published version of an article to retrieve its votes. For more information on published article version, see the PublishStatus field in KnowledgeArticleVersion
Fields Field Name
Details
Channel
Type picklist Properties Filter, Restricted picklist Description The channel where the article is rated: • AllChannels for article views across all channels. • App for the internal Salesforce Knowledge application.
1058
Standard Objects
Field Name
Lead
Details • Pkb for article views in public knowledge base. • Csp for Customer Portal. • Prm for article view in partner portal.
NormalizedScore
Type double Properties Filter, Nillable Description Article's weighted score on a scale of 1 to 5. A higher score means more votes. Articles without recent votes trend towards an average rating of three stars.
ParentId
Type reference Properties Filter Description The rated article. This corresponds to a KnowledgeArticle record.
Usage Use this object to query or retrieve the rating for an article. Alternatively, client applications can use the article type API Name followed by __VoteStat to query or retrieve the rating for an article for a specific article type.
SOQL Samples See KnowledgeArticleViewStat. SEE ALSO: KnowledgeArticle KnowledgeArticleVersion KnowledgeArticleViewStat
Lead Represents a prospect or potential Opportunity.
1059
Standard Objects
Lead
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), merge(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field
Details
Address
Type address Properties Filter, Nillable Description The compound form of the address. Read-only. See Address Compound Fields for details on compound address fields.
AnnualRevenue
Type currency Properties Create, Filter, Nillable, Sort, Update Description Annual revenue for the company of the lead.
City
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City for the address of the lead.
CleanStatus
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the record’s clean status as compared with Data.com. Values are: Matched, Different, Acknowledged, NotFound, Inactive, Pending, SelectMatch, or Skipped. Several values for CleanStatus display with different labels on the lead record detail page. • Matched displays as In Sync • Acknowledged displays as Reviewed
1060
Standard Objects
Field
Lead
Details • Pending displays as Not Compared
Company
Type string Properties Create, Filter, Group, Sort, Update Description Required. Company of the lead. Note: If person account record types have been enabled, and if the value of Company is null, the lead converts to a person account.
CompanyDunsNumber
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number assigned to every business location in the Dun&Bradstreet database that has a unique, separate, and distinct operation. D-U-N-S numbers are used by industries and organizations around the world as a global standard for business identification and tracking. Maximum size is 9 characters. Note: This field is only available to organizations that use Data.com Prospector or Data.com Clean.
ConnectionReceivedId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is only available if you have enabled Salesforce to Salesforce.
ConnectionSentId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the PartnerNetworkConnection that you shared this record with. This field is only available if you have enabled Salesforce to Salesforce. Beginning with API version 15.0, the ConnectionSentId field is no longer supported. The ConnectionSentId field is still visible, but the value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections.
1061
Standard Objects
Lead
Field
Details
ConvertedAccountId
Type reference Properties Filter, Group, Nillable, Sort Description Object reference ID that points to the Account into which the Lead has been converted.
ConvertedContactId
Type reference Properties Filter, Group, Nillable, Sort Description Object reference ID that points to the Contact into which the Lead has been converted.
ConvertedDate
Type date Properties Filter, Group, Nillable, Sort Description Date on which this Lead was converted.
ConvertedOpportunityId
Type reference Properties Filter, Group, Nillable, Sort Description Object reference ID that points to the Opportunity into which the Lead has been converted.
Country
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country for the address of the lead.
CountryCode
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the lead’s address.
1062
Standard Objects
Lead
Field
Details
CurrencyIsoCode
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
Description
Type textarea Properties Create, Nillable, Update Description Description of the lead.
Division
Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as “North America,” “Healthcare,” or “Consulting.” Available only if the organization has the Division permission enabled.
Email
Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address for the lead.
EmailBouncedDate
Type dateTime Properties Filter, Nillable, Sort, Update Description If bounce management is activated and an email sent to the lead bounced, the date and time the bounce occurred.
EmailBouncedReason
Type string
1063
Standard Objects
Field
Lead
Details Properties Filter, Group, Nillable, Sort, Update Description If bounce management is activated and an email sent to the lead bounced, the reason the bounce occurred.
Fax
Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Fax number for the lead.
FirstName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description First name of the lead. Limited to 40 characters.
HasOptedOutOfEmail
Type boolean Properties Create, Defaulted on create, Filter, Update Description Indicates whether the lead has opted out of email (true) or not (false). Label is Email Opt Out.
GeocodeAccuracy
Type picklist Properties Retrieve, Query, Restricted picklist, Nillable Description Accuracy level of the geocode for the address on this object. See Compound Field Considerations and Limitations for details on geolocation compound fields.
Industry
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Industry the lead works in.
1064
Standard Objects
Lead
Field
Details
IsConverted
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the Lead has been converted (true) or not (false). Label is Converted.
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
IsUnreadByOwner
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, lead has been assigned, but not yet viewed. See Unread Leads for more information. Label is Unread By Owner.
Jigsaw
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description References the ID of a contact in Data.com. If a lead has a value in this field, it means that a contact was imported as a lead from Data.com. If the contact (converted to a lead) was not imported from Data.com, the field value is null. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key. Important: The Jigsawfield is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify the value in the Jigsaw field.
LastActivityDate
Type date Properties Filter, Group, Nillable, Sort
1065
Standard Objects
Field
Lead
Details Description Value is one of the following, whichever is the most recent: • Due date of the most recent event logged against the record. • Due date of the most recently closed task associated with the record.
LastName
Type string Properties Create, Filter, Group, Sort, Update Description Required. Last name of the lead. Limited to 80 characters.
LastReferencedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Latitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of an address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields.
Longitude
Type double Properties Create, Filter, Nillable, Sort, Update
1066
Standard Objects
Field
Lead
Details Description Used with Latitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields.
LeadSource
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Source from which the lead was obtained.
MasterRecordId
Type reference Properties Filter, Group, Nillable, Sort Description If this object was deleted as the result of a merge, this field contains the ID of the record that was kept. If this object was deleted for any other reason, or has not been deleted, the value is null. Note: When using Apex triggers to determine which record was deleted in a merge event, this field’s value is the ID of the record that was kept only in Trigger.old. In Trigger.new, the value is null.
MiddleName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Middle name of the lead. Maximum size is 40 characters. Contact Salesforce Customer Support to enable this field.
MobilePhone
Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Mobile phone number for the lead.
Name
Type string
1067
Standard Objects
Field
Lead
Details Properties Filter, Group, Sort Description Concatenation of FirstName, MiddleName, LastName, and Suffix. Maximum size is 121 characters.
NumberOfEmployees
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of employees at the lead’s company. Label is Employees.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the lead.
PartnerAccountId
Type reference Properties Filter, Nillable Description ID of the partner account for the partner user that owns this lead. Available only if Partner Relationship Management is enabled OR Communities is enabled and you have partner portal licenses. Note: If you are uploading leads using API version 15.0 or earlier, and one of the leads in the batch has a partner user as the owner, the Partner Account field on all leads in the batch is set to that partner user’s account regardless of whether the partner user is the owner. In version 16.0, the Partner Account field is set to the appropriate account for the partner user that owns the lead. If the owner of the lead is not a partner user, this field remains blank.
Phone
Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number for the lead.
1068
Standard Objects
Lead
Field
Details
PhotoUrl
Type url Properties Filter, Group, Sort Description Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the lead. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the lead. Blank if Social Accounts and Contacts isn't enabled for the organization or if Social Accounts and Contacts has been disabled for the requesting user.
PostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal code for the address of the lead. Label is Zip/Postal Code.
Rating
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Rating of the lead.
RecordTypeId
Type reference Properties Create, Filter, Nillable, Update Description ID of the record type assigned to this object.
Salutation
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Salutation for the lead.
1069
Standard Objects
Lead
Field
Details
ScoreIntelligenceId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the intelligent field record that contains lead score.
State
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State for the address of the lead.
StateCode
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code for the lead’s address.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Status code for this converted lead. Status codes are defined in Status and represented in the API by the LeadStatus object.
Street
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street number and name for the address of the lead.
Suffix
Type string Properties Create, Filter, Group, Nillable, Sort, Update
1070
Standard Objects
Field
Lead
Details Description Name suffix of the lead. Maximum size is 40 characters. Contact Salesforce Customer Support to enable this field.
Title
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Title for the lead, for example CFO or CEO.
Website
Type url Properties Create, Filter, Group, Nillable, Sort, Update Description Website for the lead.
Note: If you import Lead data and need to set the value for an audit field, such as CreatedDate, contact Salesforce. Audit fields are automatically updated during API operations unless you request to set these fields yourself..
Converted Leads Leads have a special state to indicate that they have been converted into an Account, Contact, and optionally, an Opportunity. Your client application can convert leads via the convertLead() call. Users can also convert leads through the user interface. Once a lead has been converted, it is read-only. You can’t update or delete a converted lead. However, you can query converted lead records. Leads have several fields that indicate their converted status. These special fields are set when converting the lead in the user interface. • ConvertedAccountId • ConvertedContactId • ConvertedDate • ConvertedOpportunityId • IsConverted • Status Note: If person account record types have been enabled, and if the value of Company is null, the lead converts to a person account.
1071
Standard Objects
Lead
Unread Leads Leads have a special state to indicate that they have not been viewed or edited by the lead owner. In the user interface, this is helpful for users to know which leads have been assigned to them but which they have not touched yet. IsUnreadByOwner is true if the lead owner has not yet viewed or edited the lead, and false if the lead owner has viewed or edited the lead at least once.
Lead Status Picklist Each Status value corresponds to either a converted or unconverted status in the lead status picklist, as defined in the user interface. To obtain the lead status values in the picklist, a client application can query LeadStatus. You can’t convert a lead via the API by changing Status to one of the converted lead status values. When you convert qualified leads into an account, contact, and opportunity, you can select one of the converted status types for the lead. Leads with a converted status type are no longer available in the Leads tab, although you can include them in reports.
Usage To update a Lead or to convert one with convertLead(), your client application must log in with the “Edit” permission on leads. When you create, update, or upsert a lead, your client application can have the lead automatically assigned to one or more User records based on assignment rules that have been configured in the user interface. To use this feature, your client application needs to set either of the following options (but not both) in the AssignmentRuleHeader used in create or update: Field
Field Type
Details
assignmentRuleId
reference
ID of the assignment rule to use. Can be an inactive assignment rule. If unspecified and useDefaultRule is true, then the default assignment rule is used. To find the ID for a given assignment rule, query the AssignmentRule object (specifying RuleType="leadAssignment"), iterate through the returned AssignmentRule records, find the one you want to use, retrieve its ID, and then specify its ID in this field in the AssignmentRuleHeader.
useDefaultRule
boolean
Specifies whether to use the default rule for rule-based assignment (true) or not (false). Default rules are assigned in the user interface.
Java Sample The following Java sample shows how to automatically assign a newly created lead. package wsc; import import import import import import import import
com.sforce.soap.enterprise.Connector; com.sforce.soap.enterprise.EnterpriseConnection; com.sforce.ws.ConnectionException; com.sforce.ws.ConnectorConfig; com.sforce.soap.enterprise.sobject.Lead; com.sforce.soap.enterprise.QueryResult; com.sforce.soap.enterprise.SaveResult; com.sforce.soap.enterprise.sobject.SObject;
1072
Standard Objects
Lead
public class LeadAssignment { static final String USERNAME = "REPLACE USER NAME"; static final String PASSWORD = "REPLACE PASSWORD"; static EnterpriseConnection connection; static LeadAssignment _leadAssignment; // Main public static void main(String[] args) { // Establish connection and login ConnectorConfig config = new ConnectorConfig(); config.setUsername(USERNAME); config.setPassword(PASSWORD); try { connection = Connector.newConnection(config); System.out.println("Logged in, endpoint: " + config.getAuthEndpoint()); } catch (ConnectionException e1) { e1.printStackTrace(); } // Create lead _leadAssignment = new LeadAssignment(); try { _leadAssignment.CreateLead(); } catch (Exception e) { e.printStackTrace(); } // Logout try { connection.logout(); System.out.println("Logged out"); } catch (ConnectionException ce) { ce.printStackTrace(); } } public void CreateLead() throws ConnectionException { // Create a new Lead and assign various properties Lead lead = new Lead(); lead.setFirstName("Joe"); lead.setLastName("Smith"); lead.setCompany("ABC Corporation"); lead.setLeadSource("API"); // The lead assignment rule will assign any new leads that // have "API" as the LeadSource to a particular user // In this sample we will look for a particular rule and if found // use the id for the lead assignment. If it is not found we will
1073
Standard Objects
Lead
// instruct the call to use the current default rule. You can't use // both of these values together. QueryResult qr = connection.query("SELECT Id FROM AssignmentRule WHERE Name = " + "'Mass Mail Campaign' AND SobjectType = 'Lead'"); if (qr.getSize() == 0) { connection.setAssignmentRuleHeader(null, true); } else { connection.setAssignmentRuleHeader(qr.getRecords()[0].getId(), false); } // Every operation that results in a new or updated lead will // use the specified rule until the header is removed from the // connection. SaveResult[] sr = connection.create(new SObject[] {lead}); for (int i=0;i mpv.getPackageSubscribers() != null) .flatMap(mpv -> Arrays.stream(mpv.getPackageSubscribers().getRecords())) .map(PackageSubscriber.class::cast) .toArray(PackageSubscriber[]::new); }
3. Put it all together. The following code sample shows how to use the previous methods to modify the workflow to perform package pushes by instance. String[] instances = { "NA4" }; // Here we list the instances we would like to push to MetadataPackage metadataPackage = api.getMetadataPackage(); MetadataPackageVersion version = api.getLatestMetadataPackageVersion(metadataPackage); // do pushes by instance to avoid API timeouts retrieving PackageSubscribers for (String instanceName : instances) { PackageSubscriber[] eligibleSubscribers = api.getEligibleSubscriberIds(version, instanceName); // ... proceed with creating PushRequests and PushJobs as before
1425
Standard Objects
Partner
Partner Represents a partner relationship between two Account records or between an Opportunity and an Account.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules • You must have the “View All Data” permission to access this object via the API. All of the Partner fields are accessible in the describeSObjects() and query() calls. You cannot update() or upsert() partners via the API. • Customer Portal users can’t access this object.
Fields Field
Details
AccountFromId
Type reference Properties Create, Filter, Group, Nillable, Sort Description Required if OpportunityId is null. ID of the main Account in a partner relationship between two accounts. Specifying this field when creating a Partner record creates two AccountPartner objects, one for each direction of the relationship. If you specify the OpportunityId field, you can’t specify this field as well.
AccountToId
Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Partner Account related to either an opportunity or an account. You must specify this field when creating an opportunity Partner or an Account Partner.
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
1426
Standard Objects
Partner
Field
Details
IsPrimary
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Valid for Opportunity Partners only. Indicates that the account is the primary partner for the opportunity. Only one account can be marked as primary for an opportunity. If you set this field to 1 (true) upon insert of a new opportunity partner, any other primary partners for that opportunity will automatically have this field set to 0 (false). Label is Primary.
OpportunityId
Type reference Properties Create, Filter, Group, Nillable, Sort Description Required if AccountFromId is null. ID of the Opportunity in a partner relationship between an Account and an Opportunity. Specifying this field when creating a record creates an OpportunityPartner. If you specify the AccountFromId field, you can’t specify this field as well.
Role
Type picklist Properties Create, Filter, Group, Nillable, Sort, Description UserRole that the account has towards the related opportunity or account, such as consultant or distributor.
Roles In the Salesforce user interface, system administrators can set up the valid role values and their corresponding reverse role values in the PartnerRole object. Each account in the relationship is assigned a Role (such as Consultant or Distributor) designating that account’s role towards the related account or opportunity.
Creating an Account-Opportunity Partner Relationship When you create a partner relationship between an account and an opportunity (when you create a Partner object and specify the OpportunityId field), the API automatically creates an OpportunityPartner with the corresponding values: • The value of the Partner field AccountToId maps to the value of the OpportunityPartner field AccountToId. • The values of the OpportunityId, Role, and IsPrimary fields in both objects are the same.
1427
Standard Objects
PartnerNetworkConnection
• If you set the IsPrimary value to 1 (true) upon insert of a new OpportunityPartner, any other existing primary partners for that opportunity will automatically have the IsPrimary value set to 0 (false). This mapping allows the API to manage the objects and their relationship efficiently.
Creating an Account-Account Partner Relationship When you create a partner relationship between two accounts (when you create a Partner object and specify the AccountFromId), the API automatically creates two AccountPartner objects, one for the forward relationship and one for the reverse. For example, if you create a Partner object with “Acme, Inc.” as the AccountFromId and “Acme Consulting” as the AccountToId, the API automatically creates two AccountPartner objects: • The forward relationship AccountPartner with “Acme, Inc.” as the AccountFromId and “Acme Consulting” as the AccountToId. • The reverse relationship AccountPartner with “Acme Consulting” as the AccountFromId and “Acme, Inc.” as the AccountToId. • The value of the Role field in the reverse relationship AccountPartner is set to the PartnerRole object ReverseRole value associated with the value of the Role field in the forward relationship AccountPartner. This mapping allows the API to manage the objects and their relationship efficiently. SEE ALSO: AccountPartner OpportunityPartner UserRole PartnerRole
PartnerNetworkConnection Represents a Salesforce to Salesforce connection between Salesforce organizations.
Supported Calls create(), describeSObjects(), query(), retrieve()
Fields Field
Details
AccountId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the Account associated with this connection.
ConnectionName
Type string
1428
Standard Objects
Field
PartnerNetworkConnection
Details Properties Filter, idLookup, Sort Description A descriptive name for the connection. Limit: 295 characters.
ConnectionStatus
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the Salesforce to Salesforce connection. The picklist includes the following values: • Sent • Received • Pending • Accepted • Rejected • Inactive • Disconnecting • ConnectionSuspended • SubscribeInProgress • UsersInitialSync • BulkSyncMetadata
ConnectionType
Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of Salesforce to Salesforce connection. The picklist includes the following values: • Standard • Replication This field is available in API version 30.0 and later.
ContactId
Type reference Properties Filter, Group, Nillable, Sort
1429
Standard Objects
Field
PartnerNetworkConnection
Details Description ID of the Contact associated with this connection.
IsSyncAuditFields
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether audit fields are synced between the primary and secondary organization in a replication connection. This field is available in API version 32.0 and later, and is only accessible in Salesforce organizations where Organization Sync is enabled.
IsSyncMetadata
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether supported types of metadata are synced from the primary to the secondary organization in a replication connection. This field is available in API version 33.0 and later, and is only accessible in Salesforce organizations where Organization Sync is enabled.
IsSyncUsers
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether users with standard Salesforce user licenses are synced between the primary and secondary organization in a replication connection. This field is available in API version 35.0 and later, and is only accessible in Salesforce organizations where Organization Sync is enabled.
PrimaryContactId
Type reference Properties Filter, Group, Sort Description ID of the User associated with this connection.
ReplicationRole
Type picklist
1430
Standard Objects
Field
PartnerNetworkRecordConnection
Details Properties Filter, Group, Nillable, Restricted picklist, Sort Description The role of this Salesforce organization in the replication connection. The picklist includes the following values: • Primary • Secondary This field is available in API version 30.0 and later, and is only accessible in Salesforce organizations where Organization Sync is enabled.
ResponseDate
Type dateTime Properties Filter, Nillable, Sort Description The date and time that the connection was accepted or rejected.
Usage Represents Salesforce to Salesforce standard and replication connections. This object is referenced by all objects that have been shared with other organizations, enabling you to determine which connections shared a record with you. If the organization does not have Salesforce to Salesforce enabled, the PartnerNetworkConnection object is not available, and you can’t access it via the API. SEE ALSO: PartnerNetworkRecordConnection
PartnerNetworkRecordConnection Represents a record shared between Salesforce organizations using Salesforce to Salesforce.
Supported Calls create(), query()
Fields Field
Details
ConnectionId
Type reference
1431
Standard Objects
Field
PartnerNetworkRecordConnection
Details Properties Create, Filter, Group, Nillable, Sort Description Required. ID of the connection a record is shared with.
EndDate
Type dateTime Properties Filter, Nillable, Sort Description Date that sharing of the record was stopped.
LocalRecordId
Type reference Properties Create, Filter, Group, Sort Description Required. ID of the shared record.
ParentRecordId
Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the parent record of the shared record.
PartnerRecordId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the shared record in the connection's organization.
RelatedRecords
Type string Properties Create, Filter, Nillable, Sort Description A comma-separated list of API names for child records to be shared with a parent record.
1432
Standard Objects
PartnerNetworkRecordConnection
Field
Details
SendClosedTasks
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Forwards closed tasks related to the shared record.
SendEmails
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Sends an email notifying the connection's representative that you have forwarded the record to them. Only new recipients of a record will receive a notification email.
SendOpenTasks
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Forwards open tasks related to the shared record.
StartDate
Type dateTime Properties Filter, Nillable, Sort Description Date that the shared record was accepted.
Status
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the shared record. One of the following values: • Active (received) • Active (sent) • Connected • Inactive • Inactive (converted) • Inactive (deleted)
1433
Standard Objects
Field
PartnerNetworkRecordConnection
Details • Pending (sent)
Usage When you create a PartnerNetworkRecordConnection, you forward a record to a connection. Note: Attempting to forward a record from an object to which the connection is not subscribed results in an Invalid Partner Network Status error. Don’t forward a record to the connection that originally shared it. Doing so causes errors when Apex triggers run. When you delete a PartnerNetworkRecordConnection, you stop sharing a record with a connection. • To share a record, use the following fields: LocalRecordID and ConnectionId • To share a child of a parent record, use the following fields: LocalRecordID, ConnectionId, and ParentRecordID • To share a child of a parent record and its child records, use the following fields: LocalRecordID, ConnectionId, ParentRecordID, and RelatedRecords If the organization does not have Salesforce to Salesforce enabled, the PartnerNetworkRecordConnection object is not available, and you can’t access it using the API.
Sample Code—Apex The following example shows how to forward a record. List connMap = new List( [select Id, ConnectionStatus, ConnectionName from PartnerNetworkConnection where ConnectionStatus = 'Accepted'] ); for(PartnerNetworkConnection network : connMap) { PartnerNetworkRecordConnection newrecord = new PartnerNetworkRecordConnection(); newrecord.ConnectionId = network.Id; newrecord.LocalRecordId = accountId; newrecord.RelatedRecords = 'Contact,Opportunity,Orders__c'; newrecord.SendClosedTasks = true; newrecord.SendOpenTasks = true; newrecord.SendEmails = true; insert newrecord; }
The following example shows how to stop sharing a record. List recordConns = new List( [select Id, Status, ConnectionId, LocalRecordId from PartnerNetworkRecordConnection where LocalRecordId in :accounts] ); for(PartnerNetworkRecordConnection recordConn : recordConns) {
1434
Standard Objects
PartnerNetworkSyncLog
if(recordConn.Status.equalsignorecase('Sent')){ //account is connected - outbound delete recordConn; } }
SEE ALSO: PartnerNetworkConnection
PartnerNetworkSyncLog Represents the Org Sync Log tab in Salesforce, where Salesforce administrators can track the replication of record inserts and updates being performed in Organization Sync. The Connection Detail page for the replication connection also displays the Org Sync Log’s twenty most recent entries, and provides a link to the log.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search()
Special Access Rules The Org Sync Log tab can only be added in organizations where Organization Sync has been enabled. To add the tab to the Salesforce user interface, users must also have the “Manage Connections” user permission.
Fields Field Name
Details
ConnectionEvent
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The action being replicated to the partner organization, such as a record insertion.
ConnectionId
Type reference Properties Filter, Group, Sort Description The ID of the Salesforce to Salesforce replication connection in which the replication event succeeded or failed.
1435
Standard Objects
PartnerNetworkSyncLog
Field Name
Details
Description
Type textarea Properties Nillable Description A description of the replication event.
EntityType
Type string Properties Filter, Group, Nillable, Sort Description The type of record being inserted or updated.
Error
Type string Properties Filter, Group, Nillable, Sort Description The code used to describe the replication failure or success.
LocalRecord
Type string Properties Filter, Group, Sort Description The record being inserted or updated.
Status
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description An item is added to the Organization Sync Log if it failed to be replicated to the linked organization. This picklist includes the following values: • Failed: The replication continued to fail after multiple retries, and won’t be retried further. • Resolved: The replication succeeded after retrying. • Retrying: Salesforce is retrying the replication. This field is available in API version 35.0 and later.
1436
Standard Objects
PartnerRole
PartnerRole Represents a role for an account Partner, such as consultant, supplier, and so on.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules Customer Portal users can't access this object.
Fields Field
Details
ApiName
Type string Properties Filter, Group, NillableSort Description Uniquely identifies a picklist value so it can be retrieved without using an id or master label.
MasterLabel
Type string Properties Filter, Group, Nillable, Sort Description Master label for this partner role value. This display value is the internal label that does not get translated. Limit: 255 characters.
ReverseRole
Type picklist Properties Filter, Group, Nillable, Sort Description Name of the reverse role that corresponds to this partner role. For example, if the role is “subcontractor,” then the reverse role might be “general contractor.” In the user interface, assigning a partner role to an account creates a reverse partner relationship so that both accounts list the other as a partner.
SortOrder
Type int
1437
Standard Objects
Field
Period
Details Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the partner role picklist. These numbers are not guaranteed to be sequential, as some previous partner role values might have been deleted.
Usage This object represents a value in the partner role picklist. In the user interface, the partner role picklist provides additional information about the role of a Partner, such as their corresponding reverse role. Query this object to retrieve the set of values in the partner role picklist, and then use that information while processing PartnerRole records to determine more information about a given partner role. For example, the application could determine the reverse role of a given Partner Role value and the value of the ReverseRole property in the associated PartnerRole object. SEE ALSO: Object Basics
Period Represents a fiscal period defined in FiscalYearSettings.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Customer Portal users can't access this object.
Fields Field
Details
EndDate
Type date Properties Filter, Group, Sort Description The last date of the fiscal period.
1438
Standard Objects
Period
Field
Details
FiscalYearSettingsId
Type reference Properties Filter, Nillable, Group, Sort Description The parent record for this period.
FullyQualifiedLabel
Type string Properties Group, Nillable Description Represents the period’s complete name in the UI. For example, “September FY 2016”.
IsForecastPeriod
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the period is associated with customizable forecasts (true) or not (false).
Number
Type int Properties Filter, Nillable, Group, Sort Description If the labeling scheme of your fiscal year's quarters or months is numbered, this field indicates the relative number of the row.
PeriodLabel
Type picklist Properties Filter, Group, Nillable, Sort Description If the months in your fiscal year use custom names, then this field contains the appropriate name for rows of type Month.
QuarterLabel
Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort
1439
Standard Objects
Field
PermissionSet
Details Description If the quarters in your fiscal year use custom names, then this field contains the appropriate name for rows of type Quarter.
StartDate
Type date Properties Filter, Group, Sort Description The first date of the fiscal period.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the period is of type Month, Quarter, Week, or Year. Label is the field value.
Usage In API version 36.0 and earlier, querying the Period object yields no results. In API version 37.0 and later, a query returns period records. SEE ALSO: FiscalYearSettings
PermissionSet Represents a set of permissions that’s used to grant additional access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later. You can use permission sets to grant access, but not to deny access.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), search(), update(), upsert()
Fields Field Name
Details
Description
Type string
1440
Standard Objects
Field Name
PermissionSet
Details Properties Create, Filter, Nillable, Group, Sort, Update Description A description of the permission set. Limit: 255 characters.
HasActivationRequired
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the permission set requires an associated active session (true) or not (false).
IsCustom
Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the permission set is custom (created by an admin); if false, the permission set is standard and related to a specific permsision set license.
IsOwnedByProfile
Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the permission set is owned by a profile. Available in API version 25.0 and later.
Label
Type string Properties Create, Filter, Group, Sort, Update Description The permission set label, which corresponds to Label in the user interface. Limit: 80 characters.
LicenseId
Type ID Properties Create, Filter, Group, Nillable, Sort
1441
Standard Objects
Field Name
PermissionSet
Details Description The ID of either the related PermissionSetLicense or UserLicense associated with this permission set. Available in API version 38.0 and later. Use this field instead of UserLicenseId, which is deprecated and only available up to API Version 37.0.
Name
Type string Properties Create, Filter, Group, Sort, Update 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 organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Corresponds to API Name in the user interface. Limit: 80 characters.
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix for a permission set that's been installed as part of a managed package. If the permission set isn't packaged or is part of an unmanaged package, this value is empty. Available in API version 23.0 and later.
PermissionsPermissionName Type
boolean Properties Create, Filter, Update Description One field for each permission. If true, users assigned to this permission set have the named permission. The number of fields varies depending on the permissions for the organization and license type. Tip: To get a list of available permissions in the SOAP API, use describeSObjects(). ProfileId
Type reference Properties Filter, Group, Nillable, Sort
1442
Standard Objects
Field Name
PermissionSet
Details Description If the permission set is owned by a profile, this field returns the ID of the Profile. If the permission set isn’t owned by a profile, this field returns a null value. Available in API version 25.0 and later.
UserLicenseId
Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the UserLicense associated with this permission set. This field is nillable in API version 26.0 and later and available up to API version 37.0 In API version 38.0 and later, use LicenseId.
Usage Use the PermissionSet object to query existing permission sets. For example, to search for all permission sets that contain the “Modify All Data” permission: SELECT Name, PermissionsModifyAllData FROM PermissionSet WHERE PermissionsModifyAllData=true
When combined with the PermissionSetAssignment object, you can create a nested query that returns all users assigned to a particular permission like “Modify All Data”: SELECT Name, (SELECT AssigneeId FROM Assignments) FROM PermissionSet WHERE PermissionsModifyAllData=true
You can also create a permission set, or delete a permission set if it isn't assigned to a user.
User Licenses The user license controls the permissions that are available in a permission set. Every permission set can be associated with a user license or permission set license. If you plan to assign a permission set to multiple users with different user and permission set licenses, leave LicenseId empty. If only users with one type of license will use this permission set, set the LicenseId to that single user or permission set license. If you want a permission set associated with a permission set license, then set LicenseId to the permission set license. To get the LicenseId, run this query: SELECT Id, Name FROM UserLicense
Alternatively, to query a user or profile for the LicenseId. SELECT Id, Profile.UserLicenseId FROM User
1443
Standard Objects
PermissionSet
Child Objects When using the API, think of each permission set or related set of access controls as an empty container that you fill with permission records. In the API, a permission set can contain user, object, and field permissions, as well as setup entity access settings for other settings, such as Apex classes. • ObjectPermissions and FieldPermissions objects are available in API version 24.0 and later. • The SetupEntityAccess object is available in API version 25.0 and later. Only user permissions are managed in the PermissionSet API object; all other permission types are managed in child API objects.
In these child objects, access is stored in a record, while the absence of a record indicates no access. To return a record in a SOQL query, a minimum permission or setting is required for each child object. Because permissions are stored in related objects, it’s important to understand what questions to ask when using SOQL. For example, you might want to know which permission sets have “Delete” on an object or have the right to approve a return merchandise authorization (where the approval checkbox is controlled with field permissions). Asking the right questions when using SOQL with permission sets ensures that you get the information you need to make an informed decision, such as whether to migrate permissions or assign a permission set to a user.
1444
Standard Objects
PermissionSet
For example, the following returns all permission sets where the “Read” permission is enabled for the Merchandise__c object. SELECT SobjectType, ParentId, PermissionsRead FROM ObjectPermissions WHERE PermissionsRead = True AND SobjectType = 'Merchandise__c'
You can query for all permission sets that have “Read” on an object. However, you can’t query for permission sets that have no access on an object, because no records exist for that object. For example, the following returns no records because the object must have at least “Read” to return any records. SELECT SobjectType, ParentId, PermissionsRead FROM ObjectPermissions WHERE PermissionsRead = False AND SobjectType = 'Merchandise__c'
If you have at least the “Read” permission on an object, you can create a conditional query on other permissions in the same object. For example, the following returns any records where the object has at least the “Read” permission but not the “Edit” permission. SELECT ParentId, PermissionsRead, PermissionsEdit FROM ObjectPermissions WHERE PermissionsEdit = False AND SobjectType = 'Merchandise__c'
To set an object or field permission to no access, delete the record that contains the permission. For example, to disable all object permissions in the Merchandise__c object for a particular permission set, first query to retrieve the ID of the object permission record. SELECT Id FROM ObjectPermissions WHERE SobjectType = 'Merchandise__c'
Then delete the IDs returned from the query. Note: If you try to update the object or field permissions by setting all permissions to false, the permission record is automatically deleted; any subsequent queries for the record ID won’t return results and you must add a new permission record to grant access.
View a Permission Set with Nested Queries You can build on the PermissionSet object using child relationships that show all of the permissions in a single permission set. For example, the following returns all permission sets and displays the “Transfer Leads” permission, as well as any “Read” permissions on any objects and fields. SELECT Label, PermissionsTransferAnyLead, (SELECT SobjectType, PermissionsRead FROM ObjectPerms), (SELECT SobjectType, Field, PermissionsRead FROM FieldPerms) FROM PermissionSet
Associated Profiles In API version 25.0 and later, every profile is associated with a permission set that stores the profile’s user, object, and field permissions, as well as setup entity access settings. You can query permission sets that are owned by profiles but not modify them. The following example returns all permission sets, including those owned by a profile. SELECT Id, Label, ProfileId, Profile.Name FROM PermissionSet
1445
Standard Objects
PermissionSetAssignment
The following returns all permission sets except those owned by profiles. SELECT Id, Label, ProfileId, Profile.Name, IsOwnedByProfile FROM PermissionSet WHERE IsOwnedByProfile = FALSE
Because permission sets have child objects in the API, you can query their values on permission sets owned by a profile. For example, the following returns all enabled object permission records for profiles only. SELECT Id,ParentId, PermissionsRead, SobjectType, Parent.ProfileId FROM ObjectPermissions WHERE Parent.IsOwnedByProfile = TRUE
Once you have the IDs for permission sets that are owned by profiles as well as those not owned by profiles, you can use the PermissionSetAssignment object to determine whether users can access an object or field via a permission in their profile or any of their permission sets. For example, the following SOQL query returns all users who have the “Read” permission on the Merchandise__c object and specifies whether the permission is granted through a profile or permission set. SELECT Assignee.Name, PermissionSet.Id, PermissionSet.isOwnedByProfile FROM PermissionSetAssignment WHERE PermissionSetId IN (SELECT ParentId FROM ObjectPermissions WHERE SObjectType = 'Merchandise__c' AND PermissionsRead = true)
Note: For permission sets that are owned by profiles, don’t use any Name and Label values that are returned in a query, as they can change at any time. SEE ALSO: ObjectPermissions FieldPermissions SetupEntityAccess PermissionSetAssignment Profile
PermissionSetAssignment Represents the association between a User and a PermissionSet. This object is available in API version 22.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve()
Fields Field Name
Details
AssigneeId
Type reference
1446
Standard Objects
Field Name
PermissionSetAssignment
Details Properties Create, Filter, Group, Sort Description ID of the User to assign the permission set specified in PermissionSetId.
PermissionSetId
Type reference Properties Create, Filter, Group, Sort Description ID of the PermissionSet to assign to the user specified in AssigneeId.
Usage Finding Permission Set Assignments Use the PermissionSetAssignment object to query permission set assignments to find out which permission sets are assigned to which users. Because each user may be assigned to many permission sets and each permission set may be assigned to many users, each PermissionSetAssignment ID represents the association of a single user and single permission set. For example, to search for all of the permission sets assigned to a particular user: SELECT Id, PermissionSetId FROM PermissionSetAssignment WHERE AssigneeId = '005600000017cKt'
To search for all users assigned to a particular permission set: SELECT Id, AssigneeId FROM PermissionSetAssignment WHERE PermissionSetId = '0PS30000000000e'
You can also create a new permission set assignment, or use delete to remove a permission set that's assigned to a user. To update an assignment, delete an existing assignment and insert a new one. User Licenses When assigning a permission set, if the PermissionSet has a UserLicenseId, its UserLicenseId and the Profile UserLicenseId must match. To determine a user's license assignment, query the user's profile and then query the profile's license. For example, to find a user's profile ID: SELECT Id, ProfileId FROM User WHERE Id = '005D0000001GMAT'
To find a permission set's UserLicenseId: SELECT Id, LicenseId FROM PermissionSet WHERE Id = '0PS30000000000e'
1447
Standard Objects
PermissionSetLicense
If the IDs match, the assignment succeeds. To find all the permission sets with no license that are assigned to any user: SELECT Id, Assignee.Name, PermissionSet.Name FROM PermissionSetAssignment WHERE PermissionSet.LicenseId = null
SEE ALSO: PermissionSet
PermissionSetLicense Represents a license that’s used to enable one or more users to receive a specified permission without changing their profile or reassigning profiles. You can use permission set licenses to grant access, but not to deny access. This object is available in API version 29.0 and later.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
DeveloperName
Type string Properties Filter, Group, Sort 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. Note: 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.
ExpirationDate
Type date Properties Filter, Group, Nillable, Sort Description The date at which the permission set license expires.
1448
Standard Objects
PermissionSetLicense
Field Name
Details
Language
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the permission set license.
MasterLabel
Type string Properties Filter, Group, Sort Description The label of the permission set license. Label is Permission Set License Label.
MaximumPermissionsPermissionName Type
boolean Properties Filter, Description One field for each permission. For example, MaximumPermissionsIdentityConnect corresponds to the “Use
Identity Connect” permission. If true, this PermissionSetLicense grants the specified permission. The number of fields varies depending on the permissions available for the organization. MaximumPermissionsShowCompanyNameAsUserBadge Type
boolean Properties Filter Description When on, a user’s company name, if available, will be displayed in place of the community role. PermissionSetLicenseKey
Type string Properties Filter, Group, idLookup, Sort Description A string that uniquely identifies a particular permission set license.
1449
Standard Objects
PermissionSetLicense
Field Name
Details
Status
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of a permission set license. If Active, the permission set license is available. If Disabled, the permission set license has expired.
TotalLicenses
Type int Properties Filter, Group, Sort Description The total number of this permission set license that are available to your organization.
UsedLicenses
Type int Properties Filter, Group, Sort Description The number of this permission set license that are currently assigned to users.
Usage Users with the “View Setup and Configuration” permission can use the PermissionSetLicense object to view the set of currently defined permission set licenses in your organization. Use the PermissionSetLicense object to query existing permission licenses. For example, to return a list of all active permission set licenses: SELECT MasterLabel FROM PermissionSetLicense WHERE Status = 'Active'
When combined with the PermissionSetLicenseAssign object, you can create a nested query that returns all users assigned to a particular permission set license like “Identity Connect”: SELECT MasterLabel, (SELECT AssigneeId FROM PermissionSetLicenseAssignments) FROM PermissionSetLicense WHERE MaximumPermissionsIdentityConnect=true
SEE ALSO: PermissionSetLicenseAssign
1450
Standard Objects
PermissionSetLicenseAssign
PermissionSetLicenseAssign Represents the association between a User and a PermissionSetLicense. This object is available in API version 29.0 and later. Note: The relationship name for PermissionSetLicenseAssign is PermissionSetLicenseAssignments.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve()
Fields Field Name
Details
AssigneeId
Type reference Properties Create, Filter, Group, Sort Description ID of the User to assign the permission set license specified in PermissionSetLicenseId.
PermissionSetLicenseId
Type reference Properties Create, Filter, Group, Sort Description The ID of the permission set license the user is assigned to.
Usage Use the PermissionSetLicenseAssign object for querying permission set license assignments to find out which permission set licenses are assigned to which users. Because each user can be assigned to many permission set licenses, each PermissionSetLicenseAssign ID represents the association of a single user and single permission set license. For example, to search for all of the permission sets assigned to a particular user: SELECT Id, PermissionSetLicenseId FROM PermissionSetLicenseAssign WHERE AssigneeId = '005D0000001RFek'
To search for all users assigned to a particular permission set license: SELECT AssigneeId FROM PermissionSetLicenseAssign WHERE PermissionSetLicenseId = '0PLD000000003mwOAA'
1451
Standard Objects
PlatformAction
You can also create a new permission set license assignment, or use delete to remove a permission set license that’s been assigned to a user. To update an assignment, delete an existing assignment and insert a new one. SEE ALSO: PermissionSetLicense
PlatformAction PlatformAction is a virtual read-only object. It enables you to query for actions displayed in the UI, given a user, a context, device format, and a record ID. Examples include standard and custom buttons, quick actions, and productivity actions.
Supported Calls query()
Fields Field
Details
ActionListContext
Type string Properties Filter, Group, Nillable, Restricted picklist, Sort Description Required. The list context this action applies to. Valid values are: • Assistant • BannerPhoto • Chatter • Dockable • FeedElement • FlexiPage • Global • ListView • ListViewDefinition • ListViewRecord • Lookup • MruList • MruRow • ObjectHomeChart • Photo • Record
1452
Standard Objects
Field
PlatformAction
Details • RecordEdit • RelatedList • RelatedListRecord
ActionTarget
Type string Properties Nillable Description The URL to invoke or describe the action when the action is invoked. If the action is a standard button overridden by a Visualforce page, the ActionTarget returns the URL of the Visualforce page, such as /apex/pagename. This field is available in API version 35.0 and later.
ActionTargetType
Type string Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of the target when this action is triggered. Valid values are: • Describe—applies to actions with a user interface, such as quick actions • Invoke—applies to actions with no user interface, such as action links or invocable actions • Visualforce—applies to standard buttons overridden by a Visualforce page
ActionTargetUrl
Type string Properties Filter, Group, Nillable, Sort Description URL to invoke or describe the action when the action is invoked. This field is deprecated in API version 35.0 and later. Use ActionTarget instead.
Category
Type string Properties Filter, Group, Nillable, Restricted picklist, Sort Description Applies only to action links. Denotes whether the action link shows up in the feed item list of actions or the overflow list of actions. Valid values are: • Primary
1453
Standard Objects
Field
PlatformAction
Details • Overflow
ConfirmationMessage
Type string Properties Filter, Group, Nillable, Sort Description Applies only to action links. The message to display before the action is invoked. Field is null if no confirmation is required before invoking the action.
DeviceFormat
Type string Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Specifies which action icon the PlatformAction query returns. If this field isn’t specified, it defaults to Phone. Valid values are: • Aloha • Desktop • Phone • Tablet
ExternalId
Type string Properties Filter, Group, Nillable, Sort Description The unique ID for the PlatformAction. If the action doesn’t have an ID, its API name is used.
GroupId
Type ID Properties Filter, Group, Nillable, Sort Description The unique ID of a group of action links.
IconContentType
Type string Properties Filter, Group, Nillable, Sort
1454
Standard Objects
Field
PlatformAction
Details Description The content type—such as .jpg, .gif, or .png—of the icon for this action. Applies to both custom and standard icons assigned to actions.
IconHeight
Type int Properties Filter, Group, Nillable, Sort Description The height of the icon for this action. Applies only to standard icons.
IconUrl
Type string Properties Filter, Group, Nillable, Sort Description The URL of the icon for this action.
IconWidth
Type int Properties Filter, Group, Nillable, Sort Description The width of the icon for this action. Applies only to standard icons.
InvocationStatus
Type string Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the action within the feed item. Applies to action links only. Valid values are: • Failed • New • Pending • Successful
InvokedByUserId
Type ID Properties Filter, Group, Nillable, Sort
1455
Standard Objects
Field
PlatformAction
Details Description The ID of the user who most recently invoked this action within the current feed item. Applies to action links only.
IsGroupDefault
Type boolean Properties Filter, Group, Sort Description Denotes whether this action is the default in an action link group. False for other action types. Applies to action links only.
IsMassAction
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the action can be performed on multiple records. This field is available in API version 38.0 and later.
Label
Type string Properties Filter, Group, Sort Description The label to display for this action.
PrimaryColor
Type string Properties Filter, Group, Nillable, Sort Description The primary color of the icon for this action.
RelatedListRecordId
Type string Properties Filter, Group, Nillable, Sort Description Represents the ID of a record in an object’s related list. This field is available in API version 38.0 and later.
1456
Standard Objects
PlatformAction
Field
Details
RelatedSourceEntity
Type string Properties Filter, Group, Nillable, Sort Description When the ActionListContext is RelatedList or RelatedListRecord, this field represents the API name of the related list to which the action belongs.
Section
Type string Properties Filter, Group, Nillable, Restricted picklist, Sort Description The section of the user interface the action resides in. Applicable only to Lightning Experience. Valid values are: • ActivityComposer • CollaborateComposer • NotesComposer • Page • SingleActionLinks This field is available in API version 35.0 and later.
SourceEntity
Type string Properties Filter, Group, Sort Description Required. The object or record with which this action is associated.
Subtype
Type string Properties Filter, Group, Nillable, Sort Description The subtype of the action. For quick actions, the subtype is QuickActionType. For custom buttons, the subtype is WebLinkTypeEnum. For action links, subtypes are Api, ApiAsync, Download, and Ui. Standard buttons and productivity actions have no subtype.
Type
Type string
1457
Standard Objects
Field
PlatformAction
Details Properties Filter, Group, Restricted picklist, Sort Description The type of the action. Valid values are: • ActionLink—An indicator on a feed element that targets an API, a web page, or a file, represented by a button in the Salesforce Chatter feed UI. • CustomButton—When clicked, opens a URL or a Visualforce page in a window or executes JavaScript. • InvocableAction • ProductivityAction—Productivity actions are predefined by Salesforce and are attached to a limited set of objects. You can’t edit or delete productivity actions. • QuickAction—A global or object-specific action. • StandardButton—A predefined Salesforce button such as New, Edit, and Delete.
Usage PlatformAction can be described using describeSObject(). You can directly query for PlatformAction. For example, this query returns all fields for actions associated with each of the records of the listed objects: SELECT ExternalId, ActionTargetType, ActionTargetUrl, ApiName, Category, ConfirmationMessage, ExternalId, GroupId, UiTheme, IconUrl, IconContentType, IconHeight, IconWidth, PrimaryColor, InvocationStatus, InvokedByUserId, IsGroupDefault, Label, LastModifiedDate, Subtype, SourceEntity, Type FROM PlatformAction WHERE SourceEntity IN ('001xx000003DGsH', '001xx000003DHBq', ‘Task’, ‘Global’) AND ActionListContext = ‘Record’;
Note: To query PlatformAction, provide the ActionListContext and SourceEntity. If you query for ActionListContext with a value of RelatedList, and don't specify a RelatedSourceEntity, the query returns the API name of the related list. This query uses multiple ActionListContext values in its WHERE clause to return all actions in the Lightning Experience user interface (DeviceFormat = 'Desktop') for the specified object: SELECT ActionListContext, Label, Type, Subtype, Section, SourceEntity, RelatedSourceEntity, ActionTarget, ActionTargetType, ApiName, Category, ConfirmationMessage, DeviceFormat, ExternalId, GroupId, IconContentType, IconHeight, IconUrl, IconWidth, Id, InvocationStatus, InvokedByUserId, IsGroupDefault, LastModifiedDate, PrimaryColor FROM PlatformAction WHERE ActionListContext IN ('Record','Chatter','RelatedList') AND SourceEntity = '001xx000003DlvX' AND DeviceFormat = 'Desktop'
1458
Standard Objects
PresenceUserConfig
PresenceUserConfig Represents a configuration that determines a presence user’s settings. This object is available in API version 32.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field
Details
Capacity
Type int Properties Create, Filter, Group, Sort, Update Description The maximum number of work assignments that can be pushed to an agent at a time.
DeveloperName
Type string Properties Create, Filter, Group, Sort, Update 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. Note: 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.
Language
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the presence configuration.
MasterLabel
Type string
1459
Standard Objects
Field
PresenceUserConfig
Details Properties Create, Filter, Group, Sort, Update Description The label of the presence configuration.
OptionsIsAutoAcceptEnabled Type
boolean Properties Create, Filter, Update Description Indicates whether work items that are routed to agents are automatically accepted (true) or not (false). Available only if OptionsIsDeclineEnabled is set to false. OptionsIsDeclineEnabled Type
boolean Properties Create, Filter, Update Description Indicates whether agents can decline work items that are routed to them (true) or not (false). Available only if OptionsIsAutoAcceptEnabled is set to false. OptionsIsDeclineReasonEnabled Type
boolean Properties Create, Filter, Update Description Indicates whether agents can select a reason for declining work requests (true) or not (false). This can be selected only if decline reasons are enabled. OptionsIsDisconnectSoundEnabled Type
boolean Properties Create, Filter, Update Description Indicates whether a sound is played when agents are disconnected from Omni-Channel (true) or not (false). OptionsIsRequestSoundEnabled Type
boolean Properties Create, Filter, Update
1460
Standard Objects
Field
PresenceUserConfigProfile
Details Description Indicates whether a sound plays with incoming work requests (true) or not (false). Set to true by default.
PresenceStatusOnDeclineId Type
reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the presence status that’s automatically assigned to the agent when the agent declines a work item. Available only if OptionsIsDeclineEnabled is set to true. PresenceStatusOnPushTimeoutId Type
reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the presence status that’s automatically assigned to the agent when the agent doesn’t respond to a work item before push timeout occurs. Available in API version 36.0 and later.
PresenceUserConfigProfile Represents a configuration that determines the settings that are assigned to presence users who are assigned to a specific profile. User-level configurations override profile-level configurations. This object is available in API version 32.0 and later.
Supported Calls create(), delete(), query(), retrieve(), update()
Fields Field
Details
PresenceUserConfigId
Type reference Properties Create, Filter, Group, Sort Description If an individual user is also assigned a presence configuration through the PresenceUserConfigProfile, this configuration will override that.
1461
Standard Objects
PresenceUserConfigUser
Field
Details
ProfileId
Type reference Properties Create, Filter, Group, Sort Description The ID of the profile that’s associated with this presence configuration. A profile can be associated with only one presence configuration.
PresenceUserConfigUser Represents a configuration that determines the settings that are assigned to a presence user. These user-level configurations override profile-level configurations. This object is available in API version 32.0 and later.
Supported Calls create(), delete(), query(), retrieve(), update()
Fields Field
Details
PresenceUserConfigId
Type reference Properties Create, Filter, Group, Sort Description The ID of the presence configuration.
UserId
Type reference Properties Create, Filter, Group, Sort Description The ID of the user who’s associated with this presence configuration. A user can be associated with only one presence configuration.
Pricebook2 Represents a price book that contains the list of products that your org sells.
1462
Standard Objects
Pricebook2
Note: Price books are represented by Pricebook2 objects. As of API version 8.0, the Pricebook object is no longer available. Requests containing Pricebook are refused, and responses do not contain the Pricebook object.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field
Details
Description
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the price book.
IsActive
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the price book is active (true) or not (false). Inactive price books are hidden in many areas in the user interface. You can change this field’s value as often as necessary. Label is Active.
IsArchived
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the price book has been archived (true) or not (false). This field is read only.
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether the price book has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
1463
Standard Objects
Pricebook2
Field
Details
IsStandard
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the price book is the standard price book for the org (true) or not (false). Every org has one standard price book—all other price books are custom price books.
Name
Type string Properties Create, Filter, Group, Sort, Update Description Required. Name of this object. This field is read-only for the standard price book. Label is Price Book Name.
Usage A price book is a list of products that your org sells. • Each org has one standard price book that defines the standard or generic list price for each product or service that it sells. • An org can have multiple custom price books to use for specialized purposes, such as for discounts, different channels or markets, or select accounts or opportunities. While your client application can create, delete, and update custom price books, your client application can update only the standard price book. • For some orgs, the standard price book is the only price needed. If you need to set up other price books, you can reference the standard price book when setting up list prices in custom price books. Use this object to query standard and custom price books that have been configured for your org. A common use of this object is to allow your client application to obtain valid Pricebook2 object IDs for use when configuring PricebookEntry records via the API. Your client application can perform the following tasks on PricebookEntry objects: • Query • Create for the standard pricebook or custom pricebooks. • Update • Delete • Change the IsActive field when creating or updating records
PriceBook2, Product2, and PricebookEntry Relationships In the API: • Price books are represented by Pricebook2 records (as of version 8.0, the Pricebook object is no longer available). • Products are represented by Product2 records (as of version 8.0, the Product object is no longer available).
1464
Standard Objects
Pricebook2
• Each price book contains zero or more entries (represented by PricebookEntry records) that specify the products that are associated with the price book. A price book entry defines the price for which you sell a product at a particular currency. These objects are defined only for those orgs that have products enabled as a feature. If the org doesn’t have the products feature enabled, the Pricebook2 object doesn’t appear in the describeGlobal() call, and you can’t access it via the API. If you delete a Pricebook2 while a line item references PricebookEntry in the price book, the line item is unaffected, but the Pricebook2 is archived and unavailable from the API. For a visual diagram of the relationships between Pricebook2 and other objects, see Product and Schedule Objects.
Price Book Setup The process of setting up a price book via the API usually means: 1. Load product data into Product2 records (creating one Product2 record for each product that you want to add). 2. For each Product2 record, create a PricebookEntry that links the Product2 record to the standard Pricebook2. You need to define a standard price for a product at a given currency (if you have multicurrency enabled), before defining a price for that product in the same currency in a custom price book. 3. Create a Pricebook2 record to represent a custom price book. 4. For each Pricebook2 record, creating a PricebookEntry for every Product2 that you want to add, specifying unique properties for each PricebookEntry (such as the UnitPrice and CurrencyIsoCode) as needed.
Code Sample—Java public void pricebookSample() { try { //Create a custom pricebook Pricebook2 pb = new Pricebook2(); pb.setName("Custom Pricebok"); pb.setIsActive(true); SaveResult[] saveResults = connection.create(new SObject[]{pb}); pb.setId(saveResults[0].getId()); // Create a new product Product2 product = new Product2(); product.setIsActive(true); product.setName("Product"); saveResults = connection.create(new SObject[]{product}); product.setId(saveResults[0].getId()); // Add product to standard pricebook QueryResult result = connection.query( "select Id from Pricebook2 where isStandard=true" ); SObject[] records = result.getRecords(); String stdPbId = records[0].getId(); // Create a pricebook entry for standard pricebook PricebookEntry pbe = new PricebookEntry(); pbe.setPricebook2Id(stdPbId); pbe.setProduct2Id(product.getId()); pbe.setIsActive(true);
1465
Standard Objects
Pricebook2History
pbe.setUnitPrice(100.0); saveResults = connection.create(new SObject[]{pbe}); // Create a pricebook entry for custom pricebook pbe = new PricebookEntry(); pbe.setPricebook2Id(pb.getId()); pbe.setProduct2Id(product.getId()); pbe.setIsActive(true); pbe.setUnitPrice(100.0); saveResults = connection.create(new SObject[]{pbe}); } catch (ConnectionException ce) { ce.printStackTrace(); } }
SEE ALSO: Product and Schedule Objects
Pricebook2History Represents historical information about changes that have been made to the standard fields of the associated Pricebook2, or to any custom fields with history tracking enabled. This object is available in API version 40.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules This object is always read-only.
Fields Field
Details
Pricebook2Id
Type reference Properties Filter, Group, Sort Description ID of the Pricebook2 associated with this record.
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort
1466
Standard Objects
Field
PricebookEntry
Details Description Name of the price book field that was modified, or a special value to indicate some other modification to the price book.
IsDeleted
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). This is a standard system field. Label is Deleted.
NewValue
Type anyType Properties Nillable, Sort Description New value of the modified price book field. Maximum of 255 characters.
OldValue
Type anyType Properties Nillable, Sort Description Previous value of the modified price book field. Maximum of 255 characters.
Usage Price book history entries are indirectly created each time a price book is modified. Two rows are added to this record when foreign key fields change. One row contains the foreign key object names that display in the online application. For example, Jane Doe is recorded as the name of a Contact. The other row contains the actual foreign key ID that is only returned to and visible from the API. This object respects field level security on the parent object. SEE ALSO: Pricebook2
PricebookEntry Represents a product entry (an association between a Pricebook2 and Product2) in a price book.
1467
Standard Objects
PricebookEntry
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Fields Field
Details
CurrencyIsoCode
Type picklist Properties Filter, Restricted picklist Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
IsActive
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this price book entry is active (true) or not (false). Although you can never delete PricebookEntry records, your client application can set this flag to false. Inactive PricebookEntry records are hidden in many areas in the user interface. You can change this flag on a PricebookEntry record as often as necessary.
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether this PricebookEntry record has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
Name
Type string Properties Filter, Group, Nillable, Sort Description Name of this PricebookEntry record. This read-only field references the value in the Name field of the Product2 record. Label is Product Name.
1468
Standard Objects
PricebookEntry
Field
Details
Pricebook2Id
Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Pricebook2 record with which this record is associated. This field must be specified when creating Pricebook2 records. It can’t be changed in an update.
Product2Id
Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Product2 record with which this record is associated. This field must be specified when creating Product2 records. It can’t be changed in an update.
ProductCode
Type string Properties Filter, Group, Nillable, Sort Description Product code for this record. This read-only field references the value in the ProductCode field of the associated Product2 record.
UnitPrice
Type currency Properties Create, Filter, Sort, Update Description Required. Unit price for this price book entry. You can specify a value only if UseStandardPrice is set to false. Label is List Price.
UseStandardPrice
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this price book entry uses the standard price defined in the standard Pricebook2 record (true) or not (false). If set to true, then the UnitPrice field is read-only, and the value will be the same as the UnitPrice value in the corresponding PricebookEntry in the standard price book (that is, the PricebookEntry record whose Pricebook2Id refers to the standard price book and whose Product2Id and
1469
Standard Objects
Field
ProcessDefinition
Details CurrencyIsoCode are the same as this record). For PricebookEntry records associated with the standard Pricebook2 record, this field must be set to true.
Usage Use this object to define the association between your organization’s products (Product2) and your organization’s standard price book or to other, custom-defined price books ( Pricebook2). Create one PricebookEntry record for each standard or custom price and currency combination for a product in a Pricebook2. When creating these records, you must specify the IDs of the associated Pricebook2 record and Product2 record. Once created, your client application can’t update these IDs. This object is defined only for those organizations that have products enabled as a feature. If the organization does not have the products feature enabled, then the PricebookEntry object does not appear in the describeGlobal() call, and you can’t access it. If you delete a PricebookEntry while a line item references it, the line item is unaffected, but the PricebookEntry will be archived and unavailable from the API. You must load the standard price for a product before you are permitted to load its custom price(s). SEE ALSO: Object Basics
ProcessDefinition Represents the definition of a single approval process.
Supported Calls describeSObjects(), query(), retrieve(), search()
Special Access Rules Portal and Communities users can’t access this object.
Fields Field
Details
Description
Type string Properties Filter, Nillable, Sort Description A description of this process, with a maximum of 3,000 characters.
1470
Standard Objects
ProcessDefinition
Field
Details
DeveloperName
Type string Properties Filter, Group, Sort Description The external name of the process; the name seen by users.
LockType
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of lock applied to the record being approved. When a record is in the approval process, it’s always locked, and only an administrator can edit it. However, the currently assigned approver can also be allowed to edit the record. • Total • Admin • Owner • Workitem • Node • none
Name
Type string Properties Filter, Group, Sort Description The unique process name, used internally.
State
Type picklist Properties Filter, Group, Sort Description The current state of this process. • Active • Inactive • Obsolete
TableEnumOrId
Type picklist
1471
Standard Objects
Field
ProcessInstance
Details Properties Filter, Group, Sort Description Specifies the object associated with the approval process, such as Account or Contact.
Type
Type picklist Properties Defaulted on create, Filter, Group, Sort Description The type of this process. • Approval Process—Used to control the action taken for a record. • State-based Process—Used internally to track various control processes, such as for developing Salesforce Knowledge articles.
Usage Use this object to read the description of an approval process. The definition is read-only.
ProcessInstance Represents an instance of a single, end-to-end approval process. Use this and the node, step, and workitem process instance objects to create approval history reports. Note: Exceptions apply to approval history data retrieved with this object and available only via the SOAP API. For each approval process instance that was pending when Summer ’14 became available for your organization, some field values are never populated or are populated only after the approval process instance is next acted upon—such as when a user approves, rejects, or reassigns an approval request—after the Summer ’14 rollout. For approval process instances that were completed before the Summer ’14 rollout, all Process Instance fields are automatically populated, with one exception: CompletedDate is never populated for approval process instances that were completed before January 1, 2013. For approval process instances that were pending during the Summer ’14 rollout, all ProcessInstance fields are automatically populated, with two exceptions: CompletedDate and LastActorId are populated only after the approval process instance is complete.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules Portal and Communities users can’t access this object.
1472
Standard Objects
ProcessInstance
Fields Field
Details
CompletedDate
Type dateTime Properties Filter, Sort Description The completion date and time of the approval process. The ElapsedTimeDay, ElapsedTimeHours, and ElapsedTimeMinutes field values are calculated using CompletedDate.
ElapsedTimeInDays
Type double Properties Filter, Sort Description The total elapsed time in days between when the approval process instance was started and now.
ElapsedTimeInHours
Type double Properties Filter, Sort Description The total elapsed time in hours between when the approval process instance was started and now.
ElapsedTimeInMinutes
Type double Properties Filter, Sort Description The total elapsed time in minutes between when the approval process instance was started and now.
LastActorId
Type reference Properties Group, Filter, Sort Description The last actor that approved, rejected, or recalled the process.
1473
Standard Objects
ProcessInstance
Field
Details
ProcessDefinitionId
Type reference Properties Defaulted on create, Group, Filter, Sort Description The ID of this approval process instance.
Status
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of this approval process instance, for example Started, Pending, or Approved.
TargetObjectId
Type reference Properties Filter, Group, Sort Description ID of the object affected by this approval process instance.
Usage Use this object to query or retrieve an approval process. The following SOQL query returns details for all the ProcessInstanceStep records related to individual ProcessInstance records. The nested query references Steps, which is the child relationshipName for ProcessInstanceStep in the ProcessInstance object. SELECT Id, (SELECT Id, StepStatus, Comments FROM Steps) FROM ProcessInstance
The following SOQL query returns details for all the ProcessInstanceWorkitem records related to individual ProcessInstance records. The nested query references Workitems, which is the child relationshipName for ProcessInstanceWorkitem in the ProcessInstance object. SELECT Id, (SELECT Id, ActorId, ProcessInstanceId FROM Workitems) FROM ProcessInstance
ProcessInstanceHistory can help provide a unified read-only view of the ProcessInstanceStep and ProcessInstanceWorkitem objects. SEE ALSO: ProcessInstanceHistory ProcessInstanceStep ProcessInstanceWorkitem
1474
Standard Objects
ProcessInstanceHistory
ProcessInstanceHistory This read-only object shows all steps and pending approval requests associated with an approval process (ProcessInstance).
Supported Calls describeSObjects()
Special Access Rules Portal and Communities users can’t access this object.
Fields Field
Details
ActorId
Type reference Properties Filter, Group, Sort Description ID of the user who is currently assigned to this ProcessInstance.
Comments
Type string Properties Filter, Nillable, Sort Description Comments for a ProcessInstanceStep. This field doesn't apply to ProcessInstanceWorkitem records.
ElapsedTimeInDays
Type double Properties Filter, Nillable, Sort Description The total time in days between when the approval process instance was started and when it was completed.
ElapsedTimeInHours
Type double Properties Filter, Nillable, Sort
1475
Standard Objects
Field
ProcessInstanceHistory
Details Description The total time in hours between when the approval process instance was started and when it was completed.
ElapsedTimeInMinutes
Type double Properties Filter, Nillable, Sort Description The total time in minutes between when the approval process instance was started and when it was completed.
IsPending
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the ProcessInstance is pending (true) or not (false).
OriginalActorId
Type reference Properties Filter, Group, Sort Description ID of the user who was originally assigned this ProcessInstance.
ProcessInstanceId
Type reference Properties Filter, Group, Sort Description ID of the ProcessInstance.
ProcessNodeId
Type reference Properties Filter, Group, Sort Description ID of this step.
RemindersSent
Type int
1476
Standard Objects
Field
ProcessInstanceStep
Details Properties Filter, Group, Nillable, Sort Description Number of reminders that have been sent. Default is 0 (zero).
StepStatus
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the current status of the ProcessInstanceStep.
TargetObjectId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the object being approved.
Usage This object helps you replicate the related list functionality of the Salesforce user interface for approval processes. Use ProcessInstanceHistory for a unified read-only view of the ProcessInstanceStep and ProcessInstanceWorkitem objects. You can’t queryProcessInstanceHistory. Instead, you can query ProcessInstanceHistory by including it in a nested query on the parent ProcessInstance object. For example, the following SOQL query returns all the ProcessInstanceHistory records related to individual ProcessInstance records. The nested query references StepsAndWorkitems, which is the child relationshipName for ProcessInstanceHistory in the ProcessInstance object. SELECT Id, (SELECT Id, StepStatus, Comments FROM StepsAndWorkitems) FROM ProcessInstance
This object respects field-level security on the parent object. SEE ALSO: ProcessInstance ProcessInstanceStep ProcessInstanceWorkitem
ProcessInstanceStep Represents one work item in an approval process (ProcessInstance).
1477
Standard Objects
ProcessInstanceStep
Note: Exceptions apply to approval history data retrieved with this object and available only via the SOAP API. For each approval process instance that was pending when Summer ’14 became available for your organization, some field values are never populated or are populated only after the approval process instance is next acted upon—such as when a user approves, rejects, or reassigns an approval request—after the Summer ’14 rollout. ProcessInstanceStep fields are never populated for approval process instances that were completed before the Summer ’14 rollout. For approval process instances that were pending during the Summer ’14 rollout, all ProcessInstanceStep fields are populated only after the approval process instance is next acted upon after the Summer ’14 rollout.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules Portal and Communities users can’t access this object.
Fields Field
Details
ActorId
Type reference Properties Filter, Group, Sort Description ID of the user who is currently assigned to this approval step.
Comments
Type string Properties Filter, Nillable, Sort Description Limit: 4,000 bytes.
ElapsedTimeInDays
Type double Properties Filter, Nillable, Sort Description The total time in days since this step was started.
ElapsedTimeInHours
Type double
1478
Standard Objects
Field
ProcessInstanceStep
Details Properties Filter, Nillable, Sort Description The total time in hours since this step was started.
ElapsedTimeInMinutes
Type double Properties Filter, Nillable, Sort Description The total time in minutes since this step was started.
OriginalActorId
Type reference Properties Filter, Group, Sort Description ID of the user who was originally assigned to this approval step.
ProcessInstanceId
Type reference Properties Filter, Group, Sort Description ID of the ProcessInstance that this approval step belongs to.
StepNodeId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the node currently assigned to this approval step.
StepStatus
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The current status of this approval step. • Approved • Fault
1479
Standard Objects
Field
ProcessInstanceNode
Details • Held • NoResponse • Pending • Reassigned • Rejected • Removed • Started If the approval step requires unanimous approval and one approver rejects the request, the value of this field for the other approvers changes to NoResponse. Likewise, if approval is based on the first response and an approver responds, the value of this field for the other approvers changes to NoResponse.
Usage Query or retrieve a new step in an approval process (ProcessInstance). SEE ALSO: ProcessInstance ProcessInstanceHistory ProcessInstanceWorkitem
ProcessInstanceNode Represents a step in an instance of an approval process. Compare to ProcessNode, which describes the step in a process definition. Use this object to retrieve approval history. Note: Exceptions apply to approval history data retrieved with this object and available only via the SOAP API. For each approval process instance that was pending when Summer ’14 became available for your organization, some field values are never populated or are populated only after the approval process instance is next acted upon—such as when a user approves, rejects, or reassigns an approval request—after the Summer ’14 rollout. ProcessInstanceNode fields are never populated for approval process instances that were completed before the Summer ’14 rollout. For approval process instances that were pending during the Summer ’14 rollout, all ProcessInstanceNode fields are populated only after the approval process instance is next acted upon after the Summer ’14 rollout.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules Portal and Communities users can’t access this object.
1480
Standard Objects
ProcessInstanceNode
Fields Field
Details
CompletedDate
Type dateTime Properties Filter, Sort Description The completion date and time of this step in the approval process. The ElapsedTimeDay, ElapsedTimeHours, and ElapsedTimeMinutes field values are calculated using CompletedDate.
ElapsedTimeInDays
Type double Properties Filter, Sort Description The total time in days since this step was started.
ElapsedTimeInHours
Type double Properties Filter, Sort Description The total time in hours since this step was started.
ElapsedTimeInMinutes
Type double Properties Filter, Sort Description The total time in minutes since this step was started.
LastActorId
Type reference Properties Defaulted on create, Group, Filter, Sort Description The last actor that approved or rejected this step.
NodeStatus
Type picklist
1481
Standard Objects
Field
ProcessInstanceWorkitem
Details Properties Filter, Group, Restricted picklist, Sort Description The status of this approval instance, for example Started, Pending, or Approved.
ProcessInstanceId
Type reference Properties Filter, Group, Sort Description The approval process this step is part of.
ProcessNodeId
Type reference Properties Filter, Group, Sort Description The identifier for this step.
ProcessNodeName
Type string Properties Filter, Group, Sort Description The name of this step.
ProcessInstanceWorkitem Represents a user’s pending approval request. Note: Exceptions apply to approval history data retrieved with this object and available only via the SOAP API. For each approval process instance that was pending when Summer ’14 became available for your organization, some field values are never populated or are populated only after the approval process instance is next acted upon—such as when a user approves, rejects, or reassigns an approval request—after the Summer ’14 rollout. ProcessInstanceWorkitem fields are never populated for approval process instances that were completed before the Summer ’14 rollout. For approval process instances that were pending during the Summer ’14 rollout, all ProcessInstanceWorkitem fields are populated after the approval process instance is next acted upon after the Summer ’14 rollout, with three exceptions: ElapsedTimeInDays, ElapsedTimeInDays, and ElapsedTimeInMinutes fields are never populated in ProcessInstanceWorkitem records for which equivalent ProcessInstanceStep records were created before the Summer ’14 rollout. For all other ProcessInstanceWorkitem records, these three fields are populated after the approval process instance is next acted upon after the Summer ’14 rollout.
1482
Standard Objects
ProcessInstanceWorkitem
Note: Because ProcessInstanceHistory combines fields from ProcessInstanceStep and ProcessInstanceWorkitem, you may notice incorrect elapsed times of 0 in ProcessInstanceHistory records because the elapsed time fields were never populated in the related ProcessInstanceWorkitem record.
Supported Calls delete(), describeSObjects(), query(), retrieve(), update()
Special Access Rules Portal and Communities users can’t access this object.
Fields Field
Details
ActorId
Type reference Properties Filter, Group, Sort, Update Description ID of the user who is currently responsible for approving an approval request.
ElapsedTimeInDays
Type double Properties Filter, Nillable Description The total time in days since this approval request was started.
ElapsedTimeInHours
Type double Properties Filter, Nillable Description The total time in hours since this approval request was started.
ElapsedTimeInMinutes
Type double Properties Filter, Nillable Description The total time in minutes since this approval request was started.
1483
Standard Objects
ProcessNode
Field
Details
OriginalActorId
Type reference Properties Filter, Group, Sort, Update Description ID of the user who was originally assigned this approval request.
ProcessInstanceId
Type reference Properties Filter, Group, Sort, Update Description ID of the ProcessInstance associated with this approval request.
Usage Use this object to manage a pending approval request for a user. SEE ALSO: ProcessInstance ProcessInstanceHistory ProcessInstanceStep
ProcessNode Describes a step in a process definition. Compare to ProcessInstanceNode, which describes the step in a running process.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules Portal and Communities users can’t access this object.
1484
Standard Objects
ProcessNode
Fields Field
Details
Description
Type string Properties Filter, Nillable, Sort Description A description of this node, no longer than 3,000 bytes.
DeveloperName
Type string Properties Filter, Group, Sort Description The external name of the node; the name seen by users.
Name
Type string Properties Filter, Group, Sort Description The unique node name.
ProcessDefinition
Type reference Properties Filter, Group, Sort Description ID of the object affected by this approval instance.
Usage Use this object to get the description of a process definition. The following SOQL query returns details for all the ProcessInstanceStep records related to individual ProcessInstance records. The nested query references Steps, which is the child relationshipName for ProcessInstanceStep in the ProcessInstance object. SELECT Id, (SELECT Id, StepStatus, Comments FROM Steps) FROM ProcessInstance
1485
Standard Objects
Product2
The following SOQL query returns details for all the ProcessInstanceWorkitem records related to individual ProcessInstance records. The nested query references Workitems, which is the child relationshipName for ProcessInstanceWorkitem in the ProcessInstance object. SELECT Id, (SELECT Id, ActorId, ProcessInstanceId FROM Workitems) FROM ProcessInstance
ProcessInstanceHistory can help provide a unified read-only view of the ProcessInstanceStep and ProcessInstanceWorkitem objects.
Product2 Represents a product that your org sells. This object has several fields that are used only for quantity and revenue schedules (for example, annuities). Schedules are available only for orgs that have enabled the products and schedules features. If these features aren’t enabled, the schedule fields don’t appear in the DescribeSObjectResult, and you can’t query, create, or update the fields. Note: Products are represented by Product2 objects. As of API version 8.0, the Product object is no longer available. Requests containing Product are refused, and responses do not contain the Product object.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field
Details
CanUseQuantitySchedule
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the product can have a quantity schedule (true) or not (false). Label is Quantity Scheduling Enabled.
CanUseRevenueSchedule
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the product can have a revenue schedule (true) or not (false). Label is Revenue Scheduling Enabled.
ConnectionReceivedId
Type reference
1486
Standard Objects
Field
Product2
Details Properties Filter, Nillable Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is only available if you have enabled Salesforce to Salesforce.
ConnectionSentId
Type reference Properties Filter, Nillable Description ID of the PartnerNetworkConnection that you shared this record with. This field is only available if you have enabled Salesforce to Salesforce. Beginning with API version 15.0, the ConnectionSentId field is no longer supported. The ConnectionSentId field is still visible, but the value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections.
CurrencyIsoCode
Type picklist Properties Filter, Restricted picklist Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the org.
DefaultPrice
Type currency Properties Create, Filter, Update Description The default price for this record.
Description
Type textarea Properties Create, Filter, Nillable, Sort, Update Description A text description of this record. Label is Product Description.
Family
Type picklist
1487
Standard Objects
Field
Product2
Details Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the product family associated with this record. Product families are configured as picklists in the user interface. To obtain a list of valid values, call describeSObjects() and process the DescribeSObjectResult for the values associated with the Family field. Label is Product Family.
IsActive
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this record is active (true) or not (false). Inactive Product2 records are hidden in many areas in the user interface. You can change the IsActive flag on a Product2 object as often as necessary. Label is Active.
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Name
Type string
1488
Standard Objects
Field
Product2
Details Properties Create, Filter, Group, Sort, Update Description Required. Default name of this record. Label is Product Name.
NumberOfQuantityInstallments Type
int Properties Filter, Group, Sort Description If the product has a quantity schedule, the number of installments. NumberOfRevenueInstallments Type
int Properties Filter, Group, Nillable, Sort Description If the product has a revenue schedule, the number of installments. ProductCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Default product code for this record. Your org defines the product code naming pattern.
QuantityInstallmentPeriod Type
picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description If the product has a quantity schedule, the amount of time covered by the schedule. QuantityScheduleType
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of the quantity schedule, if the product has one.
RecalculateTotalPrice
Type boolean
1489
Standard Objects
Field
Product2
Details Properties Defaulted on create, Filter, Group, Sort Description Changes behavior of OpportunityLineItem calculations when a line item has child schedule rows for the Quantity value. When enabled, if the rollup quantity changes, then the quantity rollup value is multiplied against the sales price to change the total price.
RevenueInstallmentPeriod Type
picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description If the product has a revenue schedule, the period of time covered by the schedule. RevenueScheduleType
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of the revenue schedule, if the product has one.
Schedule Enabled Flags When enabling the schedules feature, orgs can decide whether to enable quantity schedules, revenue schedules, or both. In addition, you can use the API to control quantity and revenue scheduling at the product level via the CanUseQuantitySchedule and CanUseRevenueSchedule flags. A value of true for either flag indicates that the product and any OpportunityLineItems can have a schedule of that type. These flags can be set when creating or updating Product2 records.
Default Schedule Fields The remaining schedule fields for this object define default schedules. Default schedule values are used to create an OpportunityLineItemSchedule when an OpportunityLineItem is created for the Product. The default schedule fields support the following valid values (all fields are also nillable). Field
Valid Values
RevenueScheduleType
Divide, Repeat
RevenueInstallmentPeriod
Daily, Weekly, Monthly, Quarterly, Yearly
NumberOfRevenueInstallments
Integer between 1 to 150, inclusive.
QuantityScheduleType
Divide, Repeat
QuantityInstallmentPeriod
Daily, Weekly, Monthly, Quarterly, Yearly
1490
Standard Objects
Product2
Field
Valid Values
NumberOfQuantityInstallments
Integer between 1 to 150, inclusive
When you attempt to set the schedule fields when creating or updating, the API applies cross-field integrity checks. The integrity requirements are: • If the schedule type is nil, the installment period and number of installments must be nil. • If the schedule type is set to any value, then the installment period and number of installments must be non-nil. Any create or update that fails these integrity checks is rejected with an error. These default schedule fields, as well as CanUseQuantitySchedule and CanUseRevenueSchedule, are restricted picklist fields and are available only if the org has the schedules feature enabled.
Usage Use this object to define the default product information for your org. This object is associated by reference with Pricebook2 objects via PricebookEntry objects. The same product can be represented in different price books as price book entries. In fact, the same product can be represented multiple times (as separate PricebookEntry records) in the same price book with different prices or currencies. A product can only have one price for a given currency within the same price book. To be used in custom price books, all standard prices must be added as price book entries to the standard price book. You can query the products that have been configured for your org. For example, you can allow your client application to obtain valid product IDs for use when configuring PricebookEntry records via the API. Your client application can perform the following tasks on PricebookEntry objects: • Query • Create for the standard pricebook or custom pricebooks. • Update • Delete • Change the IsActive field when creating or updating records This object is defined only for those orgs that have products enabled as a feature. If the org does not have the products feature, this object does not appear in the describeGlobal() call, and you can’t describe or query this object. If you try to delete a product via the API but there is an opportunity that uses that product, the delete fails. The workaround is to delete the product in the user interface, which gives you an option to archive the product. Note: On opportunities and opportunity products, the workflow rules, validation rules, and Apex triggers fire when an update to a child opportunity product or schedule causes an update to the parent record. This means your custom application logic is enforced when there are updates to the parent record, ensuring higher data quality and compliance with your organization’s business policies. SEE ALSO: Object Basics
1491
Standard Objects
Product2Feed
Product2Feed Represents a single feed item in the feed displayed on the detail page for a product record. This object is available in API version 18.0 and later. A product feed shows recent changes to a product record for any fields that are tracked in feeds, and posts and comments about the record. It is a useful way to stay up-to-date with changes made to products in Salesforce. Note: Products are represented by Product2 objects. As of API version 8.0, the Product object is no longer available. Requests containing Product are refused, and responses do not contain the Product object.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Product2 object • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.
Fields Field
Details
Body
Type textarea Properties Nillable, Sort Description The content of Product2Feed. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item. Tip: In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say you comment on a post that already has one published comment and your comment triggers moderation. Now there are two
1492
Standard Objects
Field
Product2Feed
Details comments on the post, but the count says there's only one. In a moderated feed, your comment isn’t counted until it's approved by an admin or a person with “CanApproveFeedPostAndComment” or “ModifyAllData” permission. This has implications for how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until end of comments is returned.
ConnectionId
Type reference Properties Filter, Group, Nillable, Sort Description When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. This field is required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
1493
Standard Objects
Product2Feed
Field
Details
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.
CreatedDate
Type dateTime Properties Defaulted on create, Filter, Sort Description Date and time when this record was created. This field is a standard system field. Ordering by CreatedDateDESC sorts the feed by the most recent feed item.
FeedPostId
Type reference Properties Filter, Group, Nillable, Sort Description This field was removed in API version 22.0, and is available in earlier versions for backward compatibility only. ID of the associated FeedPost. A FeedPost represents the following types of changes in an FeedItem: changes to tracked fields, text posts, link posts, and content posts.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
1494
Standard Objects
Product2Feed
Field
Details
IsDeleted
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Standard system field. Indicates whether the record has been moved to the Recycle Bin (true) or not (false).
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example: Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation.
LastModifiedDate
Type dateTime Properties Defaulted on create, Filter, Sort
1495
Standard Objects
Field
Product2Feed
Details Description Date and time when a user last modified this record. This field is a standard system field. When a feed item is created, LastModifiedDate is the same as CreatedDate. If a FeedComment is inserted on that feed item, then LastModifiedDate becomes the CreatedDate for that FeedComment. Deleting the FeedComment does not change the LastModifiedDate. Ordering by LastModifiedDate DESC sorts the feed by both the most recent feed item or comment.
LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
NetworkScope
Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. NetworkScope can have the following values:
• NetworkId—The ID of the community in which the FeedItem is available. If left empty, the feed item is only available in the default community. • AllNetworks—The feed item is available in all communities. Note the following exceptions for NetworkScope: • Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks. • You can’t filter a FeedItem on the NetworkScope field.
1496
Standard Objects
Product2Feed
Field
Details
ParentId
Type reference Properties Filter, Group, Sort Description ID of the product record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item: • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval.
1497
Standard Objects
Field
Product2Feed
Details • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • CaseCommentPost—generated event when a user adds a case comment for a case object • EmailMessageEvent—generated event when an email related to a case object is sent or received • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • ChangeStatusPost—generated event when a user changes the status of a case • AttachArticleEvent—generated event when a user attaches an article to a case Note: If you set Type to ContentPost, also specify ContentData and ContentFileName.
Visibility
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization.
1498
Standard Objects
Field
ProductEntitlementTemplate
Details Visibility can have the following values:
• AllUsers—The feed item is available to all users who have permission to see the feed item. • InternalUsers—The feed item is available to internal users only. Note the following exceptions for Visibility: • For record posts, Visibility is set to InternalUsers for all internal users by default. • External users can set Visibility only to AllUsers. • On user and group posts, only internal users can set Visibility to InternalUsers.
Usage Use this object to track changes for a product record. SEE ALSO: Product2 EntitySubscription NewsFeed UserProfileFeed
ProductEntitlementTemplate Represents predefined terms of customer support (Entitlement) that users can add to products (Product2).
Supported Calls create(), delete(), describeSObjects(), query(), retrieve()
Fields Field
Details
EntitlementTemplateId
Type reference Properties Create, Filter, Group, Sort Description Required. ID of the entitlement template. Must be a valid ID.
1499
Standard Objects
ProductItemTransaction
Field
Details
Product2Id
Type reference Properties Create, Filter, Group, Sort Description Required. ID of the Product2 associated with the entitlement template. Must be a valid ID.
Usage Use to query and manage entitlement templates. SEE ALSO: Entitlement
ProductItemTransaction Represents an action taken on a product item in field service.
Supported Calls create(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),update(),upsert()
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Description
Type textarea Properties Create, Nillable, Update Description A description of the transaction.
LastReferencedDate
Type dateTime
1500
Standard Objects
Field Name
ProductItemTransaction
Details Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
ProductItemId
Type reference Properties Create, Filter, Group, Sort Description The associated product item.
ProductItemTransactionNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description (Read Only) Auto-generated number identifying the product item transaction.
Quantity
Type double Properties Create, Filter, Sort Description Amount consumed.
RelatedRecordId
Type reference Properties Filter, Group, Nillable, Sort Description Work order or work order line item associate with the related product item.
1501
Standard Objects
ProductRequest
Field Name
Details
TransactionType
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Transaction type. Values include: • Replenished: When the quantity of the part is stocked at its location. • Consumed: When parts are consumed to complete a work order or work order line item. The technician updates the products consumed related list on the work order or work order line item. • Adjusted: When there is a discrepancy. Adjustments are made by editing the product item quantity on hand.
ProductRequest Product requests represent a part or parts ordered.
Supported Calls create()delete() , describeLayout() , describeSObjects() , getDeleted() , getUpdated() , query() , retrieve() , search() , undelete() , update() , upsert() ,
Fields Field Name
Details
AccountId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account associated with the product request.
CaseId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The case associated with the product request.
1502
Standard Objects
ProductRequest
Field Name
Details
Description
Type textarea Properties Create, Nillable, Update Description A text field for details not recorded in the provided fields.
DestinationLocationId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Where the product is delivered.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the product request was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the product request was last viewed.
NeedByDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date the product must be delivered by.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update
1503
Standard Objects
Field Name
ProductRequest
Details Description The owner of the shipment.
ProductRequestNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-assigned number that identifies the shipment.
ShipToAddress
Type address Properties Filter, Nillable Description The address that the product is to be delivered to.
ShipToCity
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city that the product is to be delivered to.
ShipToCountry
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country that the product is to be delivered to.
ShipToGeocodeAccuracy
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The accuracy of the geocode for the shipping address.
ShipToLatitude
Type double
1504
Standard Objects
Field Name
ProductRequest
Details Properties Create, Filter, Nillable, Sort, Update Description The latitude of the location where the product is to be delivered to.
ShipToLongitude
Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude of the location where the product is to be delivered to.
ShipToPostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address where the product is to be delivered to.
ShipToState
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the state where the product is to be delivered to.
ShipToStreet
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street address where the product is to be delivered to.
ShipmentType
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The type of shipment. The picklist includes the following values by default: • None • Rush
1505
Standard Objects
Field Name
ProductRequestFeed
Details • Overnight • Next Business Day • Pick Up
SourceLocationId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The location the product is shipped from.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Status of the product transfer.
WorkOrderId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order that the product request is related to.
WorkOrderLineItemId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order line item that the product request is related to.
ProductRequestFeed Represents a single feed item on an product request record detail page. A product request feed shows changes to a product request record for fields that are tracked in feeds, and posts and comments about the record. It is a useful way to stay up-to-date with changes made to product requests in Salesforce. z
1506
Standard Objects
ProductRequestFeed
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Account object • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content of ProductRequestFeed. Required when Type is TextPost. Optional when Type is ContentPostor LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item. Tip: In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only one. In a moderated feed, your comment isn’t counted until it's approved by an admin or a person with “CanApproveFeedPostAndComment” or “ModifyAllData” permission. This has implications for how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until end of comments is returned.
1507
Standard Objects
ProductRequestFeed
Field Name
Details
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LikeCount
Type int
1508
Standard Objects
Field Name
ProductRequestFeed
Details Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the product request record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item:
1509
Standard Objects
Field Name
ProductRequestFeed
Details • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • CaseCommentPost—generated event when a user adds a case comment for a case object
1510
Standard Objects
Field Name
ProductRequestHistory
Details • EmailMessageEvent—generated event when an email related to a case object is sent or received • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • ChangeStatusPost—generated event when a user changes the status of a case • AttachArticleEvent—generated event when a user attaches an article to a case Note: If you set Type to ContentPost, also specify ContentData and ContentFileName.
ProductRequestHistory Represents historical information about changes that have been made to the standard fields of the associated product request, or to any custom fields with history tracking enabled.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Name of the product request field that was modified, or a special value to indicate some other modification to the product request.
NewValue
Type anyType Properties Nillable, Sort Description New value of the modified product request field. Maximum of 255 characters.
OldValue
Type anyType
1511
Standard Objects
Field Name
ProductRequestLineItem
Details Properties Nillable, Sort Description Previous value of the modified product request field. Maximum of 255 characters.
ProductRequestId
Type reference Properties Filter, Group, Sort Description ID of the product request associated with this record.
Usage Product request history entries are automatically created each time a product request is modified.
ProductRequestLineItem Represents a request for a part in field service. Product request line items are components of product requests.
Supported Calls create()delete() , describeLayout() , describeSObjects() , getDeleted() , getUpdated() , query() , retrieve() , search() , undelete() , update() , upsert() ,
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
AccountId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account associated with the product request line item.
CaseId
Type reference
1512
Standard Objects
Field Name
ProductRequestLineItem
Details Properties Create, Filter, Group, Nillable, Sort, Update Description The case associated with the product request line item.
Description
Type textarea Properties Create, Nillable, Update Description Details not recorded in the provided fields.
DestinationLocationId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Where the product is delivered.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
NeedByDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update
1513
Standard Objects
Field Name
ProductRequestLineItem
Details Description Date the product must be delivered by.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The product request that the line item belongs to.
Product2Id
Type reference Properties Create, Filter, Group, Sort, Update Description The product associated with the product request line item.
ProductRequestLineItemNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description (Read Only) An auto-assigned number that identifies the product request line item.
QuantityRequested
Type double Properties Create, Filter, Sort, Update Description The amount requested.
QuantityUnitOfMeasure
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Units of the requested product; for example, grams, liters, or units. The picklist values can be customized.
ShipToAddress
Type address
1514
Standard Objects
Field Name
ProductRequestLineItem
Details Properties Filter, Nillable Description The physical address where the product is needed.
ShipToCity
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the address where the product is needed.
ShipToCountry
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the address where the product is needed.
ShipToGeocodeAccuracy
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address where the product is needed. See Compound Field Considerations and Limitations for details on geolocation compound fields. Note: This field is available in the API only.
ShipToLatitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the product is needed. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. Note: This field is available in the API only.
1515
Standard Objects
ProductRequestLineItem
Field Name
Details
ShipToLongitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the product is needed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. Note: This field is available in the API only.
ShipToPostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address where the product is needed.
ShipToState
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address where the product is needed.
ShipToStreet
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street of the address where the product is needed.
ShipmentType
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The type of shipment. The picklist includes the following values, which can be customized: • Rush • Overnight
1516
Standard Objects
Field Name
ProductRequestOwnerSharingRule
Details • Next Business Day • Pick Up
SourceLocationId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Where the product is at the time of the request.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the shipment. The picklist includes the following values, which can be customized: • Draft • Submitted • Received
WorkOrderId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order for which the product is needed.
WorkOrderLineItemId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order line item for which the product is needed.
ProductRequestOwnerSharingRule Represents the rules for sharing a product request with users other than the owner. Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer support to enable access to this object for your org.
1517
Standard Objects
ProductRequestShare
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Usage Use this object to manage the sharing rules for product request records.
ProductRequestShare Represents a sharing entry on a product request object.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the product request.. The possible values are: • Read • Edit • All This value is not valid when creating or updating these records.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The ID of the product request associated with the sharing entry.
RowCause
Type picklist
1518
Standard Objects
Field Name
ProductTransfer
Details Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. You can only write a value in this field when its value is either omitted or set to Manual (default). Values include: • Manual—The User or Group has access because a user with “All” access manually shared the Lead with them. • Owner—The User is the owner of the Lead. • Rule—The User or Group has access via a Lead sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the product request. This field can’t be updated.
Usage This object allows you to determine which users and groups can view or edit product requests owned by other users. If you attempt to create a record that matches an existing record, the existing record is returned.
ProductTransfer A product transfer records a part’s transfer to its new location.
Supported Calls create()delete() , describeLayout() , describeSObjects() , getDeleted() , getUpdated() , query() , retrieve() , search() , undelete() , update() , upsert() ,
Fields Field Name
Details
Description
Type textarea Properties Create, Nillable, Update
1519
Standard Objects
Field Name
ProductTransfer
Details Description Details not recorded in the provided fields.
DestinationLocationId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The place the product is to be delivered.
ExpectedPickupDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date the product is expected to be picked up.
IsReceived
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Checkbox identifying that the product was received.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the product request was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the product request was last viewed.
OwnerId
Type reference
1520
Standard Objects
Field Name
ProductTransfer
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Owner of the product transfer.
Product2Id
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field for the product associated with the product transfer.
ProductRequestId
Type reference Properties Filter, Group, Nillable, Sort Description Lookup field for the product request associated with the product transfer.
ProductRequestLineItemId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field for the product request line item associated with the product transfer.
ProductTransferNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-assigned number that identifies the product transfer.
QuantityReceived
Type double Properties Create, Filter, Nillable, Sort, Update Description Amount of product received at the destination location.
QuantitySent
Type double
1521
Standard Objects
Field Name
ProductTransfer
Details Properties Create, Filter, Sort, Update Description Amount of product sent from the source location.
QuantityUnitOfMeasure
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The units of the product, for example grams, liters, or units.
ReceivedById
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field for the contact who received the product at the destination location.
ShipmentExpectedDeliveryDate
Type dateTime Properties Filter, Nillable, Sort Description Lookup field for the shipment related to the product transfer.
ShipmentId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field for the shipment related to the product transfer.
ShipmentStatus
Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description Lookup field for the shipment related to the product transfer.
ShipmentTrackingNumber
Type string
1522
Standard Objects
Field Name
ProductTransferFeed
Details Properties Filter, Group, Nillable, Sort Description Lookup field for the shipment related to the product transfer.
ShipmentTrackingUrl
Type url Properties Filter, Group, Nillable, Sort Description Lookup field for the shipment related to the product transfer.
SourceLocationId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field for the source location related to the product transfer.
SourceProductItemId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup field for the product item related to the product transfer.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Status of the product transfer.
ProductTransferFeed Represents a single feed item in the feed displayed on the detail page for a product transfer record.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
1523
Standard Objects
ProductTransferFeed
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content of the FeedItem. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The numbers of FeedComments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if a client application migrates posts and comments from another application into a feed, then InsertedById is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • •
1524
Standard Objects
Field Name
ProductTransferFeed
Details • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the ProfileSkillUser record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort
1525
Standard Objects
Field Name
ProductTransferFeed
Details Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost. For example, set this field to an existing ContentVersion and post it to a feed as a FeedItem object of TypeContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the FeedItem. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item. Except for ContentPost, LinkPost, and TextPost, don’t create feed items directly from the API. • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher.
1526
Standard Objects
Field Name
ProductTransferHistory
Details • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated.
ProductTransferHistory Represents historical information about changes that have been made to the standard fields of the associated product transfer, or to any custom fields with history tracking enabled.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Name of the product transfer field that was modified, or a special value to indicate some other modification to the order.
NewValue
Type anyType
1527
Standard Objects
Field Name
ProductTransferOwnerSharingRule
Details Properties Nillable, Sort Description New value of the modified product transfer field. Maximum of 255 characters.
OldValue
Type anyType Properties Nillable, Sort Description Previous value of the modified product transfer field. Maximum of 255 characters.
ProductTransferId
Type reference Properties Filter, Group, Sort Description ID of the product transfer associated with this record.
ProductTransferOwnerSharingRule Represents the rules for sharing a product transfer with users other than the owner. Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer support to enable access to this object for your org.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Usage Use this object to manage the sharing rules for product transfer records.
ProductTransferShare Represents a sharing entry on a product transfer object.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
1528
Standard Objects
ProductTransferShare
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the product transfer. The possible values are: • Read • Edit • All This value is not valid when creating or updating these records.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The ID of the product transfer associated with the sharing entry.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. You can only write a value in this field when its value is either omitted or set to Manual (default). Values include: • Manual—The User or Group has access because a user with “All” access manually shared the Lead with them. • Owner—The User is the owner of the Lead. • Rule—The User or Group has access via a Lead sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the product request. This field can’t be updated.
1529
Standard Objects
Profile
Usage This object allows you to determine which users and groups can view or edit product transfers owned by other users. If you attempt to create a record that matches an existing record, the existing record is returned.
Profile Represents a profile, which defines a set of permissions to perform different operations, such as querying, adding, updating, or deleting information.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), create(), retrieve(), search(), update()delete()
Special Access Rules • Customer Portal users can't access this object. • Partner portal users can’t access this object.
Fields Field
Details
Description
Type string Properties Filter, Group, Nillable, Sort, Update Description Description of the profile.
IsSsoEnabled
Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, users assigned to this profile can delegate username and password authentication to a corporate database instead of the user database.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort
1530
Standard Objects
Field
Profile
Details Description The timestamp for when the current user last viewed a record related to this profile. Available in API version 29.0 and later.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this profile. Available in API version 29.0 and later.
Name
Type string Properties Filter, Group, Sort, Update Description The name of the profile.
PermissionsShowCompanyNameAsUserBadge Type
boolean Properties Create, Filter, Update Description When on, a user’s company name, if available, will be displayed in place of the community role. PermissionsPermissionName Type
boolean Properties Filter, Update Description One field for each permission. If true, users assigned to this profile have the named permission. The number of fields varies depending on the permissions for the organization and license type. Tip: To get a list of available permissions in the SOAP API, use describeSObjects(). UserLicenseId
Type reference Properties Filter, Group, Sort
1531
Standard Objects
Field
Profile
Details Description ID of the UserLicense associated with this profile.
UserType
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The category of user license. Each UserType is associated with one or more UserLicense records. Each UserLicense is associated with one or more profiles. In API version 10.0 and later, valid values include: • Standard: user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses. Label is Standard. • PowerPartner: User whose access is limited because he or she is a partner and typically accesses the application through a partner portal or community. Label is Partner. • CSPLitePortal: user whose access is limited because he or she is an organization's customer and accesses the application through aCustomer Portal or community. Label is High Volume Portal. • CustomerSuccess: user whose access is limited because he or she is an organization's customer and accesses the application through a Customer Portal. Label is Customer Portal User. • PowerCustomerSuccess: user whose access is limited because he or she is an organization's customer and accesses the application through a Customer Portal. Label is Customer Portal Manager. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the Customer Portal role hierarchy. • CsnOnly: user whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. Label is Chatter Free. UserType replaces LicenseType, which is unavailable as of API version 10.0. In API versions 8.0 and 9.0 LicenseType is still available with the following valid values:
• AUL: Force.com user license. Label is Apex Platform. • AUL1: Force.com user license with only one user. Label is Apex Platform One. • Salesforce: Salesforce user license. Label is Salesforce. • PackageManager: user who can create and work with managed packages for Force.com AppExchange. Label is Package Manager. • PRM: user whose access is limited because he or she is a partner and typically accesses the application through a partner portal. Label is Partner. • CustomerUser: user whose access is limited because he or she is an organization's customer and accesses the application through a Customer Portal. Label is Customer Portal User.
1532
Standard Objects
Field
ProfileSkill
Details • CustomerManager: user whose access is limited because he or she is an organization's customer and accesses the application through a Customer Portal. Label is Customer Portal Manager. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the Customer Portal role hierarchy.
Usage Use the Profile object to query the set of currently configured user profiles in your organization. Your client application can use Profile objects to obtain valid profile IDs for use when querying or modifying users through the API. In the user interface, profiles can be used to assign user licenses from specific pools (Force.com Platform user license or Salesforce user license, for example). If a user is assigned to a profile with a different license type, the number of available licenses in the old license type pool increases, one per user changed, and decreases by the same amount in the new license type pool. SEE ALSO: Object Basics PermissionSet
ProfileSkill Represents a profile skill, which describes a user’s professional knowledge. This is a global record for the organization, and users are associated through the ProfileSkillUser object. Note: For information about Live Agent skills, see the Skill topic.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field Name
Details
Description
Type textarea Properties Create, Nillable, Update Description Description of the profile skill.
1533
Standard Objects
ProfileSkill
Field Name
Details
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp indicating when the current user last viewed a record related to this profile skill. Available in API version 29.0 and later.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp indicating when the current user last viewed this profile skill. Available in API version 29.0 and later.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the profile skill.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the profile skill.
UserCount
Type int Properties Filter, Group, Nillable, Sort Description The number of users with the profile skill.
Usage Use the ProfileSkill object to look up the attributes of a skill that can be assigned to a user. This is a global object and is not owned by any specific user.
1534
Standard Objects
ProfileSkillEndorsement
ProfileSkillEndorsement Represents a detail relationship of ProfileSkillUser. An endorsement of a profile skill shows approval and support of another user’s publicly declared skill.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field Name
Details
Name
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the profile skill being endorsed.
ProfileSkillUserId
Type reference Properties Create, Filter, Group, Sort Description The ID of the ProfileSkillUser record that is being endorsed.
UserId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The user ID of the person giving the endorsement.
Usage Use the ProfileSkillEndorsement object to query about a single endorsement given to a user about a specific skill. Users can’t endorse themselves, they can only be endorsed by others unless they are administrators with the “Modify All Data” permission.
1535
Standard Objects
ProfileSkillEndorsementFeed
ProfileSkillEndorsementFeed Represents a single feed item in the feed displayed on the detail page for a ProfileSkillEndorsement record. This object is available in API version 34.0 and later.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content of the FeedItem. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The numbers of FeedComments associated with this feed item.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort
1536
Standard Objects
Field Name
ProfileSkillEndorsementFeed
Details Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The file uploaded to the feed. Required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. Automatically determined during insert. The size of the file (in bytes) uploaded to the feed.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. Automatically determined during insert. The MIME type of the file uploaded to the feed.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if a client application migrates posts and comments from another application into a feed, then InsertedById is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort
1537
Standard Objects
Field Name
ProfileSkillEndorsementFeed
Details Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
ParentId
Type reference
1538
Standard Objects
Field Name
ProfileSkillEndorsementFeed
Details Properties Filter, Group, Sort Description ID of the ProfileSkillEndorsement record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost. For example, set this field to an existing ContentVersion and post it to a feed as a FeedItem object of TypeContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the FeedItem. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item. Except for ContentPost, LinkPost, and TextPost, don’t create feed item types directly from the API. • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used.
1539
Standard Objects
Field Name
ProfileSkillEndorsementHistory
Details • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated.
ProfileSkillEndorsementHistory Represents the history of changes to the fields of a ProfileSkillEndorsement.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist
1540
Standard Objects
Field Name
ProfileSkillFeed
Details Properties Filter, Group, Restricted picklist, Sort Description The profile skill endorsement changed field.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the profile skill endorsement field.
OldValue
Type anyType Properties Nillable, Sort Description The old value of the profile skill endorsement field.
ProfileSkillEndorsementId
Type reference Properties Filter, Group, Sort Description The ID of the profile skill endorsement.
Usage Use this read-only object to identify changes to a ProfileSkillEndorsement.
ProfileSkillFeed Represents a single feed item in the feed displayed on the detail page for a profile skill. A ProfileSkill feed shows recent changes to a ProfileSkill record for any fields that are tracked in feeds, and comments and posts about the record. It is a useful way to stay up-to-date with changes to solutions.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
1541
Standard Objects
ProfileSkillFeed
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content of the ProfileSkillFeed. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort
1542
Standard Objects
Field Name
ProfileSkillFeed
Details Description Available in API version 36.0 and earlier only. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. This field is the size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. This field is the MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: •
1543
Standard Objects
Field Name
ProfileSkillFeed
Details Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the object type to which the FeedItem object is related. For example, set this field to a UserId to post to someone’s profile feed, or an AccountId to post to a specific account.
1544
Standard Objects
ProfileSkillFeed
Field Name
Details
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. For Work.com thanks posts, it’s the ID of the WorkThanks object associated with a RypplePost. This field is typically null for all posts except ContentPost and RypplePost. For example, set this field to an existing ContentVersion and post it to a feed as a FeedItem object of Type ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the FeedItem. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of ProfileSkillFeed item: • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group.
1545
Standard Objects
Field Name
ProfileSkillFeed
Details • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • AttachArticleEvent—generated event when a user attaches an article to a case. • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • CaseCommentPost—generated event when a user adds a case comment for a case object. • ChangeStatusPost—generated event when a user changes the status of a case. • ChatTranscriptPost—generated event when Live Agent transcript is saved to a case. • EmailMessageEvent—generated event when an email related to a case object is sent or received. • FacebookPost—generated when a Facebook post is created from a case. Deprecated. • MilestoneEvent—generated when a case milestone is completed or reaches violation status. • SocialPost—generated when a social post is created from a case. Note: If you set Type to ContentPost, also specify ContentData and ContentFileName.
1546
Standard Objects
ProfileSkillHistory
Usage Use this object to track changes for a ProfileSkill record.
ProfileSkillHistory Represents the history of changes to the fields of a ProfileSkill.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
ProfileSkillId
Type reference Properties Filter, Group, Sort Description Required. ID of the ProfileSkill.
1547
Standard Objects
ProfileSkillShare
Usage Use this read-only object to identify changes to a ProfileSkill.
ProfileSkillShare Represents a sharing entry on a ProfileSkill.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the ProfileSkill. The possible values are: • Read • Edit • All (This value is not valid for create() or update() calls.) This value must be set to an access level that is higher than the organization’s default access level for ProfileSkill objects.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the parent object, if any.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort
1548
Standard Objects
Field Name
ProfileSkillUser
Details Description Reason that this sharing entry exists. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Values may include: • Manual—The User or Group has access because a user with “All” access manually shared the ProfileSkill with them. • Owner—The User is the owner of the ProfileSkill or is in a role above the ProfileSkill owner in the role hierarchy.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the ProfileSkill.
Usage This object is read only. It is visible because of constraints to the ProfileSkill object, but it is ignored and does not control which users and groups can view and edit ProfileSkill records owned by other users.
ProfileSkillUser Represents a detail relationship of User. The object connects profile skills with users.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field Name
Details
EndorsementCount
Type int Properties Filter, Group, Nillable, Sort
1549
Standard Objects
Field Name
ProfileSkillUserFeed
Details Description The number of endorsements.
Name
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the skill user.
ProfileSkillId
Type reference Properties Create, Filter, Group, Sort Description The ID of the ProfileSkill.
UserId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user. This field can’t be changed once it is created.
Usage Use this object to assign specific skills to specific users. ProfileSkillUser appears on the Overview tab on the Chatter profile page. Users can only create a skill mapping for themselves, they can’t create skill mappings for others unless they are administrators with the “Modify All Data” permission. Additionally, users can only edit this object if they are the context user and are not editing the UserId field.
ProfileSkillUserFeed Represents a single feed item in the feed displayed on the detail page for a ProfileSkillUser record. This object is available in API version 34.0 and later.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
1550
Standard Objects
ProfileSkillUserFeed
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content of the FeedItem. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The numbers of FeedComments associated with this feed item.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort
1551
Standard Objects
Field Name
ProfileSkillUserFeed
Details Description Available in API version 36.0 and earlier only. The file uploaded to the feed. Required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. Automatically determined during insert. The size of the file (in bytes) uploaded to the feed.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. Automatically determined during insert. The MIME type of the file uploaded to the feed.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if a client application migrates posts and comments from another application into a feed, then InsertedById is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines.
1552
Standard Objects
Field Name
ProfileSkillUserFeed
Details • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the ProfileSkillUser record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference
1553
Standard Objects
Field Name
ProfileSkillUserFeed
Details Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost. For example, set this field to an existing ContentVersion and post it to a feed as a FeedItem object of TypeContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the FeedItem. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item. Except for ContentPost, LinkPost, and TextPost, don’t create feed items directly from the API. • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file.
1554
Standard Objects
Field Name
ProfileSkillUserHistory
Details • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated.
ProfileSkillUserHistory Represents the history of changes to the fields of a ProfileSkillUser.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType
1555
Standard Objects
Field Name
PushTopic
Details Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed.
ProfileSkillUserId
Type reference Properties Filter, Group, Sort Description Required. ID of the ProfileSkillUser.
Usage Use this read-only object to identify changes to a ProfileSkillUser.
PushTopic Represents a query that is the basis for notifying listeners of changes to records in an organization. This is available from API version 21.0 or later.
Supported Calls REST: DELETE, GET, PATCH, POST (query requests are specified in the URI) SOAP: create(), delete(), describe(), describeSObjects(), query(), retrieve(), update()
Special Access Rules • This object is only available if Streaming API is enabled for your organization. • Only users with “Create” permission can create this record.
1556
Standard Objects
PushTopic
Fields Field
Field Type
Description
ApiVersion
double
Required. API version to use for executing the query specified in Query. It must be an API version greater than 20.0. If your query applies to a custom object from a package, this value must match the package's ApiVersion. Example value: 40.0 Field Properties: Create, Filter, Sort, Update
Description
string
Description of the PushTopic. Limit: 400 characters Field Properties: Create, Filter, Sort, Update
ID
ID
System field: Globally unique string that identifies a record. Field Properties: Default on create, Filter, Group, idLookup, Sort
isActive
boolean
Indicates whether the record currently counts towards the organization's limit. Field Properties: Create, Default on create, Filter, Group, Sort, Update
IsDeleted
boolean
System field: Indicates whether the record has been moved to the Recycle Bin (true) or not (false). Field Properties: Default on create, Filter, Group, Sort
Name
string
Required. Descriptive name of the PushTopic, such as MyNewCases or TeamUpdatedContacts. Limit: 25 characters. This value identifies the channel and must be unique. Field Properties: Create, Filter, Group, Sort, Update
NotifyForFields
picklist
Specifies which fields are evaluated to generate a notification. Valid values: • All • Referenced (default) • Select • Where Field Properties: Create, Filter, Sort, Update
NotifyForOperations picklist
Specifies which record events may generate a notification. Valid values: • All (default) • Create • Extended • Update Field Properties for API version 28.0 and earlier: Create, Filter, Sort, Update
1557
Standard Objects
Field
QuantityForecast
Field Type
Description Field Properties for API version 29.0 and later: Filter, Sort In API version 29.0 and later, this field is read-only, and will not contain information about delete and undelete events. Use NotifyForOperationCreate, NotifyForOperationDelete, NotifyForOperationUndelete and NotifyForOperationUpdate to specify which record events should generate a notification. A value of Extended means that neither create or update operations are set to generate events.
NotifyForOperationCreate boolean
true if a create operation should generate a notification, otherwise, false. Defaults to true. This field is available in API version 29.0 and later.
NotifyForOperationDelete boolean
true if a delete operation should generate a notification, otherwise, false. Defaults to true. Clients must connect using the cometd/29.0 (or later) Streaming API
endpoint to receive delete and undelete event notifications. This field is available in API version 29.0 and later. NotifyForOperationUndelete boolean
true if an undelete operation should generate a notification, otherwise, false. Defaults to true. Clients must connect using the cometd/29.0 (or later) Streaming
API endpoint to receive delete and undelete event notifications. This field is available in API version 29.0 and later. NotifyForOperationUpdate boolean
Query
string
true if an update operation should generate a notification, otherwise, false. Defaults to true. This field is available in API version 29.0 and later.
Required. The SOQL query statement that determines which record changes trigger events to be sent to the channel. Limit: 1,300 characters Field Properties: Create, Filter, Sort, Update
PushTopic and Notifications The PushTopic defines when notifications are generated in the channel. This is specified by configuring the following PushTopic fields: • PushTopic Queries • Events • Notifications
QuantityForecast Represents a quantity-based forecast. The API also provides revenue-based forecasts using RevenueForecast.
1558
Standard Objects
QuantityForecast
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Special Access Rules • Requires the “View All Data” permission. • Customer Portal users can’t access this object.
Fields Field
Details
Closed
Type double Properties Filter, Nillable, Sort Description Read-only. A rollup of opportunities or opportunity line items that have closed in this period.
Commit
Type double Properties Filter, Nillable, Sort Description The owner's Commit total.
CommitComment
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Read-only. The comment entered when the owner edited his or her Commit total from the Adjusted Total link on the forecast edit page.
CommitOverride
Type double Properties Create, Filter, Nillable, Sort, Update Description Read-only. The owner's override of their own My Commit total.
1559
Standard Objects
QuantityForecast
Field
Details
DefaultRollupCommit
Type double Properties Filter, Nillable, Sort Description Read-only. The owner's standard Commit rollup, including their own opportunities and forecast-level overrides from subordinate users in the role hierarchy.
DefaultRollupUpside
Type double Properties Filter, Nillable, Sort Description Read-only. The owner's standard Best Case rollup, including their own opportunities and forecast-level overrides from subordinate users in the role hierarchy.
InvalidationDate
Type dateTime Properties Filter, Nillable, Sort Description Read-only. If not blank, indicates that the rollup numbers for Forecast Override fields that represent calculated (summarized) amounts may not be up to date.
ManagerChoiceCommit
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Read-only. The manager's choice regarding the commit amount: • DefaultRollup: Use the manager's default commit rollup for owner's forecast, which reflects the manager's opportunity forecast overrides. • AcceptForecast (default selection): Accept the forecast owner's Adjusted Total commit amount, which may or may not be an override. • ManagerManualOverride: Use the manager's manual override. • OpportunityOnlyRollup: Use the opportunity rollup, including opportunity forecast overrides, but excluding any forecast-level (Adjusted Total) overrides.
ManagerChoiceUpside
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update
1560
Standard Objects
Field
QuantityForecast
Details Description Read-only. The manager's choice regarding the best case amount: • DefaultRollup: Use the manager's default best case rollup for owner's forecast, which reflects the manager's opportunity forecast overrides. • AcceptForecast (default selection): Accept the forecast owner's Adjusted Total best case amount, which may or may not be an override. • ManagerManualOverride: Use the manager's manual override. • OpportunityOnlyRollup: Use the opportunity rollup, including opportunity forecast overrides, but excluding any forecast-level (Adjusted Total) overrides.
ManagerClosed
Type double Properties Filter, Nillable, Sort Description Read-only. The manager's closed total for the owner's forecast, including any opportunity or opportunity product overrides made by the manager.
ManagerCommit
Type double Properties Filter, Nillable, Sort Description The manager's Commit total.
ManagerCommitOverride
Type double Properties Create, Filter, Nillable, Sort, Update Description Read-only. The manager's manual override of the forecast owner's Commit total. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
ManagerDefaultRollupCommit
Type double Properties Filter, Nillable, Sort Description Read-only. The manager's standard Commit rollup for the forecast owner. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
1561
Standard Objects
QuantityForecast
Field
Details
ManagerDefaultRollupUpside
Type double Properties Filter, Nillable, Sort Description Read-only. The manager's standard Best Case rollup for the forecast owner. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
ManagerId
Type reference Properties Filter, Group, Nillable, Sort Description Read-only. ID of the direct manager of the user who owns this forecast.
ManagerOpportunityRollupCommit Type
double Properties Filter, Nillable, Sort Description Read-only. The manager's view of the forecast owner's opportunity-level Commit rollup, ignoring all forecast overrides. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report. ManagerOpportunityRollupUpside Type
double Properties Filter, Nillable, Sort Description Read-only. The manager's view of the forecast owner's opportunity-level Best Case rollup, ignoring all forecast overrides. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report. ManagerPipeline
Type double Properties Filter, Nillable, Sort
1562
Standard Objects
Field
QuantityForecast
Details Description The manager's pipeline total for the owner's forecast, including any opportunity or opportunity product overrides made by the manager.
ManagerUpside
Type double Properties Filter, Nillable, Sort Description The manager's Best Case total.
ManagerUpsideOverride
Type double Properties Create, Filter, Nillable, Sort, Update Description The manager's manual override of the forecast owner's Best Case total. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
OpportunityRollupClosed
Type double Properties Filter, Nillable, Sort Description The owner's Closed total for his or her opportunities only.
OpportunityRollupCommit
Type double Properties Filter, Nillable, Sort Description The owner's Commit total for his or her opportunities only.
OpportunityRollupPipeline
Type double Properties Filter, Nillable, Sort Description The owner's Pipeline total for his or her opportunities only.
1563
Standard Objects
QuantityForecast
Field
Details
OpportunityRollupUpside
Type double Properties Filter, Nillable, Sort Description The owner's Best Case total for his or her opportunities only.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort Description ID of the User who owns this forecast. Required on create.
PeriodId
Type reference Properties Filter, Nillable, Group, Sort Description The ID of the Period that contains the StartDate.
Pipeline
Type double Properties Filter, Nillable, Sort Description The total pipeline rollup from subordinates in the role hierarchy, including the owner's opportunities.
ProductFamily
Type picklist Properties Create, Filter, Group, Nillable, Sort Description The value chosen in the Product Family picklist, which can be configured from the object management settings for products. This field is relevant if you have chosen Product Families as the Forecast Type in Forecasts Settings. If you are not forecasting by product family or if the forecast represents opportunities that are not associated with a product family, then this field is blank. Required on create.
Quota
Type double
1564
Standard Objects
Field
QuantityForecast
Details Properties Create, Filter, Nillable, Sort, Update Description The quota amount for the period. You can create, update, upsert, and delete. Requires the “Modify All Data” and “Manage Users” permission. Required on create.
StartDate
Type date Properties Create, Filter, Group, Nillable, Sort Description The start date of this forecast. The ID of the Period that contains this date is written to the PeriodId field if it changes. A new Period is created if none exists. Required on create.
Upside
Type currency Properties Filter, Nillable Description The owner's Best Case total.
UpsideComment
Type string Properties Filter, Nillable, Update Description The comment entered when the owner edited his or her Best Case total.
UpsideOverride
Type double Properties Filter, Nillable, Update Description Read only. The owner's override of their own My Best Case total.
Usage Query this object to support customizable forecasts based on quantities.
1565
Standard Objects
QuantityForecastHistory
You can update one field, Quota, which means that you can mass update sales users' quotas instead of updating them one by one in the user interface. Editing Quota, which means that you can mass update sales users' quotas instead of updating them one by one in the user interface. Editing Quota requires the “Modify All Data” and “Manage Users” permissions. The rollup fields always reflect opportunity and opportunity product overrides by the forecast owner or one of the forecast owner’s subordinates in the role hierarchy. In addition, the manager rollup fields include overrides by the forecast owner's direct manager in the role hierarchy. Some of the rollup fields ignore forecast-level (Adjusted Total) overrides, but they never ignore opportunity forecast overrides that are visible to the owner or manager. SEE ALSO: RevenueForecast QuantityForecastHistory
QuantityForecastHistory Represents historical information about quantity-based forecasts that have been submitted (saved) in the user interface.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules • Requires the “View All Data” permission. • Customer Portal users can’t access this object.
Fields Field
Details
Closed
Type double Properties Filter, Nillable, Sort Description The closed amount of the forecast.
Commit
Type double Properties Filter, Nillable, Sort Description The commit amount of the forecast.
1566
Standard Objects
QuantityForecastHistory
Field
Details
CommitComments
Type string Properties Filter, Group, Nillable, Sort Description Comments about the commit value.
CommitOverridden
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the commit value was overridden (true) or not (false).
CurrencyIsoCode
Type picklist Properties Filter, Restricted picklist Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
ForecastOverrideId
Type reference Properties Filter, Group, Sort Description ID of the related forecast override.
Pipeline
Type double Properties Filter, Nillable, Sort Description The pipeline amount of the forecast.
Quota
Type currency Properties Filter, Nillable
1567
Standard Objects
Field
QueueRoutingConfig
Details Description The quota amount of the forecast.
Upside
Type currency Properties Filter, Nillable Description The best case amount of the forecast.
UpsideComments
Type string Properties Filter, Nillable Description Comments about the upside value.
UpsideOverridden
Type boolean Properties Defaulted on create, Filter Description Indicates whether the upside value was overridden (true) or not (false).
Usage This is a read-only object specific to customizable forecasting. When a user submits a revenue-based forecast in the user interface, a new record is created. If the same forecast is ever resubmitted, additional records are added. The CreatedDate of a record reflects the day on which the forecast was submitted. This object respects field level security on the parent object. SEE ALSO: QuantityForecast RevenueForecastHistory
QueueRoutingConfig Represents the settings that determine how work items are routed to agents. This object is available in API version 32.0 and later.
1568
Standard Objects
QueueRoutingConfig
Supported Calls create(), delete(), query(), retrieve(), update()
Fields Field
Details
CapacityPercentage
Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage of an agent’s capacity for work items that’s consumed by a specific type of work item from this service channel. For example, you might give phone calls a capacity percentage of 100. If an agent receives a phone call, the agent won’t receive new work items until the call ends, because at that point the agent’s capacity will have reached 100%. This field is available in API version 33.0 and later.
CapacityWeight
Type double Properties Create, Filter, Nillable, Sort, Update Description The amount of an agent’s capacity for work items that’s consumed by a work item from this service channel. For example, if an agent has a capacity of 6, and cases are assigned a capacity weight of 2, an agent can be assigned up to 3 cases before the agent is at capacity and can’t receive new work items. This field is available in API version 33.0 and later.
DeveloperName
Type string Properties Create, Filter, Group, Sort, Update 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.
1569
Standard Objects
Field
QueueRoutingConfig
Details Note: 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.
Language
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the presence status.
MasterLabel
Type string Properties Create, Filter, Group, Sort, Update Description The label of the presence status.
OverflowAssigneeId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user or queue that’s set as the Overflow Assignee.
PushTimeout
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of seconds set for push timeout. 0 is returned when push timeout isn’t enabled. Available in API version 36.0 and later.
RoutingModel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The routing type that determines how work items are routed (pushed) to agents. Possible values are Least Active and Most Available.
1570
Standard Objects
Question
Field
Details
RoutingPriority
Type int Properties Create, Filter, Group, Sort, Update Description The priority in which work items from the service channels that are related to this routing configuration are routed to agents. Work items from routing configurations that have lower priority values (for example, 0) are routed to agents first.
ServiceChannelId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the service channel that’s associated with this configuration.
Question Represents a question in a community that users can view and reply to.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field
Details
BestReplyId
Type reference Properties Filter, Group, Nillable, Sort, Update Description The ID of the Reply that has been identified as the best answer to the question. You must use the user interface to identify the best answer for a question.
BestReplySelectedById
Type reference Properties Filter, Group, Nillable, Sort
1571
Standard Objects
Field
Question
Details Description The ID of the User who selected the best answer to the question. This field is available in API version 24.0 and later. In API version 24.0 through version 29.0, you must update this field using the UI. In API version40.0 and later, you can update this field using the API.
Body
Type textarea Properties Create, Nillable, Update Description Description of the question.
CommunityId
Type reference Properties Create, Filter, Group, Sort Description The zone ID associated with the question. Once you create a question, you can’t change the zone ID associated with that question.
CreatorFullPhotoUrl
Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s profile photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later.
CreatorName
Type string Properties Filter, Group, Nillable, Sort Description Name of the user who posted the question or reply. Only the first name of internal users (agents) appears to portal users in the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later.
CreatorSmallPhotoUrl
Type string
1572
Standard Objects
Field
Question
Details Properties Filter, Group, Nillable, Sort Description URL of the user’s thumbnail photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later.
HasSingleFieldForContent
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the content of a Chatter Answers question is: • Included in only one field: Title if the content is unformatted and less than 255 characters; or Body if the content is formatted or more than 255 characters (true) • Included in two fields: Title and Body (false) This field also determines if content displays in one or two fields in Chatter Answers question feeds. This field is available in API version 25.0 and later.
LastReferencedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
LastReplyDate
Type dateTime Properties Filter, Nillable, Sort Description The date and time the last reply (child Reply object) was posted.
LastReplyId
Type reference Properties Filter, Group, Nillable, Sort Description Read only. The ID of the last reply (child Reply object) posted to the question.
1573
Standard Objects
Question
Field
Details
LastViewedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
MostReportAbusesOnReply
Type int Properties Filter, Group, Nillable, Sort Description The most number of user-reported abuses on a Reply associated with the question. This field is available in API version 24.0 and later.
NumReplies
Type int Properties Filter, Group, Nillable, Sort Description The number of replies (child Reply object) that users have submitted for the question.
NumReportAbuses
Type int Properties Filter, Group, Nillable, Sort Description Represents the number of user-reported abuses on the question. This field is available in API version 24.0 and later.
NumSubscriptions
Type int Properties Filter, Group, Nillable, Sort Description Represents the number of users following the question. This field is available in API version 24.0 and later.
1574
Standard Objects
Question
Field
Details
Origin
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The source of the question, such as Chatter Answers. This field is available in API version 24.0 and later.
Title
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The descriptive title of the question.
UpVotes
Type int Properties Filter, Group, Nillable, Sort Description The total number of up votes for the question.
VoteScore
Type double Properties Filter , Nillable, Sort Description The internal score of the question, used to sort questions and articles on the Popular tab in the application user interface. The internal algorithm that determines the score gives older votes less weight than newer votes, simulating exponential decay. The score itself does not display in the application user interface. Note: Unlike other fields of type double, you can't use a SOQL aggregate function with this field.
Usage Use this object to track questions in azone.
1575
Standard Objects
QuestionDataCategorySelection
QuestionDataCategorySelection A data category selection represents a data category that classifies a question. This object can be used to associate a question with a data category from a data category group or to query the categorization for a question.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules To create, read or update data category selection, you must have create, read or update permission on the categorized question. Users who can update question can also delete its category selection. Users who can create questions can only select categories visible to their role.
Fields Field Name
Details
DataCategoryGroupName
Type DataCategoryGroupReference Properties Create Description Unique name of the data category group which has a category associated with the question.
DataCategoryName
Type DataCategoryGroupReference Properties Create Description Unique name of the data category associated with the question.
ParentId
Type reference Properties Create, Filter Description ID of the question associated with the data category selection.
1576
Standard Objects
QuestionDataCategorySelection
Usage Every question can be categorized in a data category. You can use the QuestionDataCategorySelection object to query and manage question categorization. Client applications can create categorization for a question. They can also delete, query, and retrieve question categorization. Warning: Even though the API lets you select more than one category for QuestionDataCategorySelection, the Answers tab only supports one data category selection for questions. Selecting multiple categories through QuestionDataCategorySelection may result in unexpected behavior in the Answers tab, such as losing your multiple selections. You should only select one data category when using QuestionDataCategorySelection.
Sample Code—Java In the following example, the selectCategory method adds a category to a question data category selection. The retrieveCategorySelections method returns all the categories from a question data category selection. public void selectCategory(ID parentId, String categoryGroupName, String categoryName) { try { QuestionDataCategorySelection categorySelection = new QuestionDataCategorySelection(); categorySelection.setParentId(parentId); categorySelection.setDataCategoryGroupName(categoryGroupName); categorySelection.setDataCategoryName(categoryName); binding.create(new SObject[]{categorySelection}); } catch (RemoteException e) { System.out.println("An unexpected error has occurred." + e.getMessage()); } } public String[] retrieveCategorySelections(String parentId) { QueryResult qr = null; try { qr = binding.query("SELECT DataCategoryName FROM QuestionDataCategorySelection WHERE Id = '" + parentId + "'"); } catch (RemoteException e) { System.out.println("An unexpected error has occurred." + e.getMessage()); } String[] categoryNames = new String[qr.getRecords().length]; for (int index = 0; index < qr.getRecords().length; index++) { categoryNames[index] = ((QuestionDataCategorySelection)qr.getRecords()[index]).getDataCategoryName(); } return categoryNames; }
1577
Standard Objects
QuestionReportAbuse
Salesforce Knowledge uses a similar object for article data category selection. See Article Type__DataCategorySelection for SOQL examples using this object. SEE ALSO: Article Type__DataCategorySelection
QuestionReportAbuse Represents a user-reported abuse on a Question in a Chatter Answers community. This object is available in API version 24.0 and later.
Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field
Details
Name
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the Question from which the user reported abuse.
QuestionId
Type reference Properties Create, Filter, Group, Sort Description The ID of the Question from which the user reported abuse.
Reason
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The reason the user reported abuse on the Question, such as Spam, Hateful, or Inappropriate.
Usage Use this object to track user-reported abuse on questions created in a Chatter Answers community.
1578
Standard Objects
QuestionSubscription
QuestionSubscription Represents a subscription for a user following a Question. This object is available in API version 24.0 and later.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
Fields Field
Details
CommunityId
Type reference Properties Filter, Group, Nillable, Sort Description Required. ID of the zone associated with the Question the user is following. This field can’t be updated.
Name
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The name of the question subscription.
QuestionCreatedDate
Type dateTime Properties Filter, Nillable, Sort Description Required. Creation date of the Question which the user is following. This field can’t be updated.
QuestionId
Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the Question which the user is following. This field can’t be updated.
1579
Standard Objects
QueueSobject
Field
Details
SubscriberId
Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the User who is following the Question. This field can’t be updated.
Usage Things to consider when following a Question: • A user can only follow questions that they have permission to view. • Administrators and users with the “Modify All Data” permission can configure other users to follow questions that the other user has read access to. • Administrators and users with the “Modify All Data” permission can configure users to stop following questions. Queries on QuestionSubscription: • Users with the “Read” permission on Question can see which questions other users are following. • A query must include a LIMIT clause and the limit can’t exceed 1,000. • A query using a WHERE clause can only filter by fields on Question.
QueueSobject Represents the mapping between a queue Group and the sObject types associated with the queue, including custom objects.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Customer Portal users can't access this object. A queue is a Group whose Type is Queue. To create a Group, you must have the “Manage Users” permission.
Fields Field
Details
QueueId
Type reference Properties Create, Filter, Group, Sort
1580
Standard Objects
Field
QuickText
Details Description The ID of a queue.
SobjectType
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description A list of object types that can be associated with the queue specified by the QueueId.
Usage Use this object to associate a queue with the sObject that can be associated with the queue, including custom objects. SEE ALSO: Object Basics
QuickText This object stores a snippet of text that allows an agent to send a quick response to a customer in the Live Agent console. This object is available in API version 24.0 and later.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field Name
Details
Category
Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description A customizable picklist that can be used to group multiple related Quick Text records together
Channel
Type picklist
1581
Standard Objects
Field Name
QuickText
Details Properties Create, Defaulted on create, Filter, Nillable, Update Description A multi-select picklist that can be used to specify where specific Quick Text messages should be available, such as in Live Agent or in the Email publisher in Case Feed.
LastReferencedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Message
Type textarea Properties Create, Filter (unavailable in API version 25.0 and later), Sort (unavailable in API version 25.0 and later), Update Description The content of the Quick Text record
Name
Type string Properties Create, Filter (unavailable in API version 25.0 and later), Group, Sort (unavailable in API version 25.0 and later), Update Description A descriptive label for the Quick Text record
OwnerId
Type reference
1582
Standard Objects
Field Name
QuickTextHistory
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User who owns the Quick Text record
Usage Use this object to create and manage the Quick Text messages available to agents in the Live Agent console. You can categorize multiple QuickText records into groups using the Category field. The Category field can also be a parent to multiple custom dependent Picklist fields to create a hierarchical structure of categories.
QuickTextHistory Represents changes to field values on a QuickText object. This object is available in API version 24.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed
OldValue
Type anyType
1583
Standard Objects
Field Name
QuickTextOwnerSharingRule
Details Properties Nillable, Sort Description The old value of the field that was changed
QuickTextId
Type reference Properties Filter, Group, Sort Description The ID of the QuickText that was changed
Usage Use this object to identify changes to a QuickText.
QuickTextOwnerSharingRule Represents a rule for sharing a QuickText object with users other than the owner. Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer support to enable access to this object for your org.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Group, Sort, Update Description A value that represents the type of sharing allowed. The possible values are: • Read • Edit
1584
Standard Objects
QuickTextOwnerSharingRule
Field Name
Details
Description
Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later.
DeveloperName
Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update 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. Note: 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.
GroupID
Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. QuickText objects owned by users in the source group trigger the rule to give access.
Name
Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to Label in the user interface.
UserorGroupID
Type reference
1585
Standard Objects
Field Name
QuickTextShare
Details Properties Create, Filter Description The ID representing the target user or group. Target users or groups have access to the QuickText.
Usage Use this object to manage the sharing rules for a QuickText object. SEE ALSO: Metadata API Developer Guide: SharingRules
QuickTextShare Represents a sharing entry on a QuickText object. This object is available in API version 24.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the QuickText. The possible values are: • Read • Edit • All (This value is not valid for create() or update() calls.) This value must be set to an access level that is higher than the organization’s default access level for QuickText objects.
1586
Standard Objects
Quote
Field Name
Details
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the parent object, if any
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Values may include: • Manual—The User or Group has access because a user with “All” access manually shared the QuickText with them. • Owner—The User is the owner of the QuickText or is in a role above the QuickText owner in the role hierarchy.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the QuickText
Usage This object lets you determine which users and groups can view and edit QuickText records owned by other users. If you attempt to create a new record that matches an existing record, the create() call updates any modified fields and returns the existing record.
Quote The Quote object represents a quote, which is a record showing proposed prices for products and services. Available in API version 18.0 and later. Quotes can be created from and synced with opportunities, and emailed as PDFs to customers
1587
Standard Objects
Quote
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field
Details
AccountId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the account that’s associated with the quote.
AdditionalAddress
Type address Properties Filter, Nillable Description Compound form of the additional address. Read-only. See Address Compound Fields for details on compound address fields.
AdditionalCity
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City for the quote's additional address. Up to 40 characters allowed.
AdditionalCountry
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country for the quote's additional address. Up to 80 characters allowed.
AdditionalCountryCode
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO country code for the quote’s additional address.
1588
Standard Objects
Quote
Field
Details
AdditionalLatitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with AdditionalLongitude to specify the precise geolocation of an additional address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
AdditionalLongitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with AdditionalLatitude to specify the precise geolocation of an additional address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
AdditionalName
Type string Properties Filter, Group, Nillable, Sort Description Name associated with the quote's additional address. Limited: 255 characters.
AdditionalPostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal Code for the quote's additional address.
AdditionalState
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State for the quote's additional address. Up to 80 characters allowed.
AdditionalStateCode
Type picklist
1589
Standard Objects
Field
Quote
Details Properties Create, Filter, Group, Nillable, Sort, Update Description ISO state code for the quote’s additional address.
AdditionalStreet
Type textarea Properties Create, Filter, Nillable, Group, Sort, Update Description Street name for the quote's additional address.
BillingAddress
Type address Properties Filter, Nillable Description Compound form of the billing address. Read-only. See Address Compound Fields for details on compound address fields.
BillingCity
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City for the quote's billing address. Up to 40 characters allowed.
BillingCountry
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country for the quote's billing address. Up to 80 characters allowed.
BillingCountryCode
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO country code for the quote’s billing address.
1590
Standard Objects
Quote
Field
Details
BillingLatitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
BillingLongitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
BillingName
Type string Properties Filter, Group, Nillable, Sort Description Entity that the quote is billed to.
BillingPostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal Code for the quote's billing address.
BillingState
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State for the quote's billing address. Up to 80 characters allowed.
BillingStateCode
Type picklist
1591
Standard Objects
Field
Quote
Details Properties Create, Filter, Group, Nillable, Sort, Update Description ISO state code for the quote’s billing address.
BillingStreet
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street name for the quote's billing address.
CanCreateQuoteLineItems
Type boolean Properties Create, Defaulted on create, Group Description This field is not used.
ContactId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the contact that’s associated with the quote.
ContractId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the contract that’s associated with the quote.
CurrencyIsoCode
Type picklist Properties Defaulted on create, Filter, Restricted picklist Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
1592
Standard Objects
Field
Quote
Details If the organization has multicurrency and a Pricebook2Id specified on the quote, then the currency value of this field must match the currency of the PricebookEntry objects that are associated with any quote line items it has. This value is copied from the related Opportunity and can't be changed.
Description
Type textarea Properties Nillable Description Text description of the quote. Limit: 32,000 characters.
Discount
Type percent Properties Filter, Nillable, Sort Description Difference between the sum of the QuoteLineItem record'sSubtotal and the sum of the QuoteLineItem record's Discount totals. Expressed as a percentage.
Email
Type email Properties Filter, Group, Nillable, Sort Description The email address of the contact who’s associated with the quote.
ExpirationDate
Type date Properties Create, Filter, Nillable, Update Description The date when this quote is no longer valid.
Fax
Type phone Properties Create, Filter, Nillable, Update Description The fax number for the contact who’s associated with the quote.
1593
Standard Objects
Quote
Field
Details
GrandTotal
Type currency Properties Filter, Nillable Description The total price of the quote plus shipping and taxes.
IsSyncing
Type boolean Properties Defaulted on create, Filter Description Indicates whether the quote is syncing with an opportunity.
LastReferencedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
LineItemCount
Type int Properties Filter, Nillable Description The number of line items on the quote.
Name
Type string Properties Create, Filter, idLookup, Update
1594
Standard Objects
Field
Quote
Details Description Required. Name for the quote. Limit: 225 characters.
OpportunityId
Type reference Properties Create, Filter Description ID for the opportunity associated with the quote.
Phone
Type phone Properties Create, Filter, Nillable, Update Description The phone number of the contact who’s associated with the quote.
Pricebook2Id
Type reference Properties Create, Filter, Nillable, Update Description ID of the price book associated with the quote.
QuoteNumber
Type string Properties Defaulted on create, Filter Description A system-generated number that identifies the quote.
QuoteToAddress
Type address Properties Filter, Nillable Description Compound form of the quote to address. Read-only. See Address Compound Fields for details on compound address fields.
QuoteToCity
Type string
1595
Standard Objects
Field
Quote
Details Properties Create, Filter, Group, Nillable, Sort, Update Description City for the address to send the quote to for approval, such as a third party-agency representing a buyer. Up to 40 characters allowed.
QuoteToCountry
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country for the address to send the quote to for approval. Up to 80 characters allowed.
QuoteToLatitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with QuoteToLongitude to specify the precise geolocation of a quote to address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
QuoteToLongitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with QuoteToLatitude to specify the precise geolocation of a quote to address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
QuoteToName
Type string Properties Create, Filter, Nillable, Update Description The name of the entity (such as a person or business) that the quote is sent to for approval. Limit: 255 characters.
QuoteToPostalCode
Type string
1596
Standard Objects
Field
Quote
Details Properties Create, Filter, Group, Nillable, Sort, Update Description Postal code for the address to send the quote to for approval.
QuoteToState
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State for the address to send the quote to for approval. Up to 80 characters allowed.
QuoteToStreet
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street name for the address to send the quote to for approval.
RecordTypeID
Type reference Properties Create, Filter, Nillable, Update Description ID of the record type assigned to the object.
ShippingAddress
Type address Properties Filter, Nillable Description Compound form of the shipping address. Read-only. See Address Compound Fields for details on compound address fields.
ShippingCity
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City for the quote's shipping address. Up to 40 characters allowed.
1597
Standard Objects
Quote
Field
Details
ShippingCountry
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country for the quote's shipping address. Up to 80 characters allowed.
ShippingCountryCode
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO country code for the quote’s shipping address.
ShippingHandling
Type currency Properties Create, Filter, Nillable, Update Description The total shipping and handling costs for the quote.
ShippingLatitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
ShippingLongitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
ShippingName
Type string
1598
Standard Objects
Field
Quote
Details Properties Create, Filter, Nillable, Update Description The name of the entity (such as a person or business) that the quote is sent to for approval.
ShippingPostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal code for the quote's shipping address.
ShippingState
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State for the quote's shipping address. Up to 80 characters allowed.
ShippingStateCode
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ISO state code for the quote’s shipping address.
ShippingStreet
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street name for the quote's shipping address.
Status
Type picklist Properties Create, Defaulted on create, Filter, Nillable, Update Description The status of the quote. The standard options are: • —None—
1599
Standard Objects
Field
Quote
Details • Draft • Needs Review • In Review • Approved • Rejected • Presented • Accepted • Denied
Subtotal
Type currency Properties Filter, Nillable Description The line item’s sales price multiplied by the quantity and minus the discount.
Tax
Type currency Properties Create, Filter, Nillable, Update Description The total taxes for the quote.
TotalPrice
Type currency Properties Filter, Nillable Description The total of the quote line items after discounts and before taxes and shipping.
Usage Use Quote to manage proposed product prices for customers. To update a Quote, your client application needs “Edit” permission. • Client applications can create, update, delete, and query Attachment records associated with a quote via the API. • You can sync a quote and its parent Opportunity. SEE ALSO: QuoteLineItem QuoteDocument Opportunity
1600
Standard Objects
QuoteDocument
QuoteDocument Represents a quote in document format. Available in API version 18.0 and later.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete()
Fields Field
Details
ContentVersionDocumentId
Type reference Properties Create, Filter, Group, Sort Description ID for the document’s version.
CurrencyIsoCode
Type picklist Properties Defaulted on create, Filter, Restricted picklist Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. If the organization has multicurrency and a Pricebook2Id specified on the quote, then the currency value of this field must match the currency of the PricebookEntry objects that are associated with any quote line items it has.
Discount
Type percent Properties Filter, Nillable, Sort Description The discount for the quote used in the document.
Document
Type base64 Properties Create, Nillable
1601
Standard Objects
Field
QuoteFeed
Details Description The binary data of the document stored in the QuoteDocument object.
GrandTotal
Type currency Properties Filter, Nillable, Sort Description Grand total for the quote used in the document.
Name
Type string Properties Filter, idLookup, Sort Description Name of the quote document.
QuoteId
Type reference Properties Create, Filter, GroupSort Description ID for the quote used for the document.
Usage Use the QuoteDocument object to store a document that can be used to present the quote information to the customer. SEE ALSO: Quote QuoteLineItem
QuoteFeed Represents a single feed item on the quote record detail page. This object is available in API version 39.0 and later. A quote feed shows changes to a quote record for fields that are tracked in feeds, and posts and comments about the record. It’s a useful way to stay up-to-date with changes made to quotes in Salesforce.
1602
Standard Objects
QuoteFeed
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Account object • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content of QuoteFeed. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item. Tip: In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only one. In a moderated feed, your comment isn’t counted until it's approved by an admin or a person with “CanApproveFeedPostAndComment” or “ModifyAllData” permission. This has implications for how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until end of comments is returned.
1603
Standard Objects
QuoteFeed
Field Name
Details
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LikeCount
Type int
1604
Standard Objects
Field Name
QuoteFeed
Details Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the account record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item:
1605
Standard Objects
Field Name
QuoteFeed
Details • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • CaseCommentPost—generated event when a user adds a case comment for a case object
1606
Standard Objects
QuoteLineItem
Field Name
Details • EmailMessageEvent—generated event when an email related to a case object is sent or received • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • ChangeStatusPost—generated event when a user changes the status of a case • AttachArticleEvent—generated event when a user attaches an article to a case Note: If you set Type to ContentPost, also specify ContentData and ContentFileName.
Usage Use this object to track changes for a quote record.
QuoteLineItem The QuoteLineItem object represents a quote line item, which is a member of the list of Product2 products associated with a Quote, along with other information about those line items on that quote. Available in API version 18.0 and later.
Supported Calls create(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
Special Access Rules The user must have “Edit” permissions on Quote records in order to create or update quote line items on a quote. The user must have “Edit” permissions on Quote records to delete a quote line item.
Fields Field
Details
CurrencyIsoCode
Type picklist Properties Filter, Restricted picklist Description Available only for organizations enabled for multiples currencies. Contains the ISO code for any currency allowed by the organization.
1607
Standard Objects
Field
QuoteLineItem
Details If the organization has multicurrency and a Pricebook2 is specified on the quote (the Pricebook2Id field is not blank), then the currency value of this field must match the currency of the PricebookEntry objects for any associated quote line items. This value is copied from the related Quote and can't be changed.
Description
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the line item. Limit: 225 characters.
Discount
Type percent Properties Create, Filter, Nillable, Sort Description Editable number from 0 to 100.
HasQuantitySchedule
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether the opportunity line item that the quote line item is synced with has a quantity schedule.
HasRevenueSchedule
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether the opportunity line item that the quote line item is synced with has a revenue schedule. If this object has a revenue schedule, the GrandTotal and TotalPrice fields can't be updated. In addition, the Quantity field can't be updated if this object has a quantity schedule. The system ignores any attempt to update this field. The update isn't rejected but the updated value is ignored.
HasSchedule
Type boolean Properties Defaulted on create, Filter, Group, Sort
1608
Standard Objects
Field
QuoteLineItem
Details Description Read-only. Indicates whether the line item uses schedules.
LineNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description Read-only. Automatically generated number identifying the quote line item. In the form of QL-XXXXX.
ListPrice
Type currency Properties Filter, Nillable, Sort Description Read-only. Corresponds to the UnitPrice on the PricebookEntry that is associated with this line item, which can be in the standard price book or a custom price book. A client application can use this information to show whether the unit price (or sales price) of the line item differs from the price book entry list price.
OpportunityLineItemId
Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the related opportunity line item. This field is populated by the API during creation of the quote line item. Not editable. Available in API version 40.0 and later.
PricebookEntryId
Type reference Properties Create, Filter, Group, Sort Description Required. ID of the associated PricebookEntry. Exists only for orgs with Products enabled. In API 38.0 and earlier, if Product2Id is populated with PricebookEntryId data, you receive an error message. In API 39.0 and later, Product2Id is made null, and PricebookEntryId is populated with the PricebookEntryId data.
Product2Id
Type reference
1609
Standard Objects
Field
QuoteLineItem
Details Properties Create, Filter, Group, Sort Description Required. ID of the Product2 associated with this QuoteLineItem. In API 38.0 and earlier, if Product2Id is populated with PricebookEntryId data, you receive an error message. In API 39.0 and later, Product2Id is made null, and PricebookEntryId is populated with the PricebookEntryId data.
Quantity
Type double Properties Create, Filter, Sort, Update Description The number of units for the line item.
QuoteId
Type reference Properties Create, Filter, Group, Sort Description Required. ID of the associated Quote.
ServiceDate
Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when the product revenue will be recognized and the product quantity will be shipped.
SortOrder
Type int Properties Filter, Group, Nillable, Sort Description The value of where the line item is in the sorted order, such as 1, 2, and so on. The SortOrder value determines the order in which a quote line item displays in the Quote Detail page. Client applications can use this to match the sort order in Salesforce. This field is only available in API versions 21.0 and greater.
Subtotal
Type currency
1610
Standard Objects
Field
QuoteLineItem
Details Properties Filter, Nillable, Sort Description The line item's Quantity multiplied by the UnitPrice.
TotalPrice
Type currency Properties Filter, Nillable, Sort Description Read-only. Calculated by applying the Discount to the Subtotal. This field is nillable, but you can't set both TotalPrice and UnitPrice to null in the same update. To insert the TotalPrice for a quote line item via the API (given only a unit price and the quantity), calculate this field as the unit price multiplied by the quantity. This field is read-only if the quote line item has a revenue schedule.
UnitPrice
Type currency Properties Create, Filter, Sort, Update Description The price per unit for the quote line item.
Usage A Quote record can have QuoteLineItem records only if the Quote has a Pricebook2. A QuoteLineItem must correspond to a Product2 that is listed in the quote's Pricebook2. Note: If the multicurrency option has been enabled, the CurrencyIsoCode field is present. It can't be modified, it is always set to the value of the CurrencyIsoCode of the parent Quote.
Effects on Quotes Quotes that have associated QuoteLineItem objects are affected in the following ways: • Creating a QuoteLineItem increments the Quote value by the TotalPrice of the QuoteLineItem. • When you create or update a QuoteLineItem, the API verifies that the line item corresponds to a PricebookEntry in the Pricebook2 that is associated with the quote. SEE ALSO: Quote QuoteDocument Opportunity
1611
Standard Objects
RecentlyViewed
RecentlyViewed Represents records that the current user has recently viewed or referenced (by viewing a related record).
Supported Calls query(), update()
Special Usage Rules The RecentlyViewed object does not support the Report, KnowledgeArticle, and Article objects.
Fields Field
Details
Alias
Type string Properties Filter, Group, Nillable, Sort Description The alias on the record.
Email
Type email Properties Filter, Group, Nillable, Sort Description The email address on the record.
FirstName
Type string Properties Filter, Group, Nillable, Sort Description The first name on the record. If the recently viewed record is a user, this is the user’s first name.
Id
Type ID Properties Defaulted on create, Filter, Group, Sort
1612
Standard Objects
Field
RecentlyViewed
Details Description The ID of the recently viewed record.
IsActive
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the recently viewed record is an active user (true) or not (false). This field contains a value only if the recently viewed record is a user.
LastName
Type string Properties Filter, Group, Nillable, Sort Description The last name on the record.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Name
Type string Properties Filter, Group, Nillable, Sort Description The name on the recently viewed record. If the recently viewed record is a user, contact, or lead, the value is a concatenation of the firstname and lastname field values.
1613
Standard Objects
RecentlyViewed
Field
Details
NetworkId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the community that this group is part of. This field is available only if Salesforce Communities is enabled in your organization. You can add a NetworkId only when creating a group. You can’t change or add a NetworkId for an existing group. This field is available in API version 27.0 and later.
Phone
Type phone Properties Filter, Group, Nillable, Sort Description The phone number on the record.
ProfileId
Type reference Properties Filter, Group, Nillable, Sort Description If the recently viewed record is a user, this is the user’s profile ID.
Title
Type string Properties Filter, Group, Nillable, Sort Description If the recently viewed record is a user, this is the title of the user; for example CFO or CEO.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The sObject type for this recently viewed record. Valid values include any standard or custom objects that RecentlyViewed supports.
UserRoleId
Type reference
1614
Standard Objects
Field
RecordType
Details Properties Filter, Group, Nillable, Sort Description The ID of the user role associated with this object.
Usage This object provides a heterogeneous list of different object types and consists of recently viewed records or records that were recently referenced (a related record was viewed). A record is considered viewed when the user sees the details associated with it, but not when the user sees it in a list with other records. Use this object to programmatically construct a list of recently viewed items specific to the current user, for example, on a custom user interface or for search auto-complete options. You can also retrieve a filtered list of records by object type (Type). The RecentlyViewed data is periodically truncated down to 200 records per object. Use this query in your code to retrieve a list of all the records that were recently viewed. The results are ordered from most to least recent. SELECT Id, Name FROM RecentlyViewed WHERE LastViewedDate !=null ORDER BY LastViewedDate DESC
Use this query to retrieve data that was either viewed or referenced, but only for a limited set of objects. SELECT Id, Name FROM RecentlyViewed WHERE Type IN ('Account', 'Contact', 'Plan__c') ORDER BY LastViewedDate DESC
This query retrieves a list of all recently viewed contacts with contact-specific fields, such as the contact’s account name, and the custom website field. Records are ordered from most to least recent. SELECT Account.Name, Title, Email, Phone, Website__c FROM Contact WHERE LastViewedDate != NULL ORDER BY LastViewedDate DESC
RecordType Represents a record type.
Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
1615
Standard Objects
RecordType
Fields Field
Details
BusinessProcessId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Required for Opportunity and Lead record types in API version 17.0 and later. ID of an associated BusinessProcess.
Description
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A description of this record. Limit: 255 characters.
DeveloperName
Type string Properties Create, Filter, Group, Sort, Update Description Required. 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 Record Type Name. Note: 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.
IsActive
Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this record is active (true) or not (false). Only active record types can be applied to records. Label is Active.
IsPersonType
Type boolean
1616
Standard Objects
Field
RecordType
Details Properties Defaulted on create, Filter Description Indicates whether this record has been designated as a person account (true) or not (false). Visible only if the organization has the person account feature enabled.
Name
Type string Properties Create, Filter, Group, Sort, Update Description Required. Label of the record type in the user interface. Limit: 80 characters. Label is Record Type Label.
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value 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. This field can’t be accessed unless the logged-in user has the “Customize Application” permission.
SobjectType
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Object to which this record type applies, including custom objects.
1617
Standard Objects
RecordTypeLocalization
Usage Use this object to offer different BusinessProcess records and subsets of picklist values to different users based on their Profile. Your client application can describe or query RecordType records. The following objects have a RecordTypeId field: • Account • Campaign • CampaignMember • Case • Contact • Contract • Lead • Opportunity • QuickText • Solution • Custom objects Client applications can create or update values in RecordTypeId on these objects, specifying a valid record type ID associated with these objects. Note: You can’t create or update the RecordTypeId field on the CampaignMember records. Set the CampaignMember record type using the CampaignMemberRecordTypeId field on Campaign. A client application can retrieve the list of valid record type IDs for a given object by querying the RecordType. SEE ALSO: Record Type Objects
RecordTypeLocalization Represents the translated value of a label for a record type when the Translation Workbench is enabled for your organization.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Special Access Rules • Your organization must be using Professional, Enterprise, Developer, Unlimited, or Performance Edition and be enabled for the Translation Workbench. • To view this object, you must have the “View Setup and Configuration” permission.
1618
Standard Objects
RecordTypeLocalization
Fields Field
Details
Language
Type string Properties Create, Filter, Nillable, Restricted picklist Description The language for this translated label.
NamespacePrefix
Type string Properties Filter, Nillable Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value 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.
ParentId
Type reference Properties Create, Filter, Nillable Description The ID of the RecordType associated with the label that is being translated.
Value
Type string Properties Create, Filter, Nillable, Update Description The actual translated label for the record type. Label is Translation.
1619
Standard Objects
Reply
Usage Use this object to translate the labels of your record types into other supported languages.
Reply Represents a reply that a user has submitted to a question in an answers community.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field
Details
Body
Type textarea Properties Create, Update Description Body of this reply.
CommunityId
Type reference Properties Filter, Group, Nillable, Sort Description The zone ID associated with the question and its reply. This field is available in API version 27.0 and later.
CreatorFullPhotoUrl
Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s profile photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later.
CreatorName
Type string
1620
Standard Objects
Field
Reply
Details Properties Filter, Group, Nillable, Sort Description Name of the user who posted the question or reply. Only the first name of internal users (agents) appears to portal users in the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later
CreatorSmallPhotoUrl
Type string Properties Filter, Group, Nillable, Sort Description URL of the user’s thumbnail photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later.
DownVotes
Type int Properties Filter, Group, Nillable, Sort Description The total number of down votes for a reply.
Name
Type string Properties Filter, Group, idLookup, Sort Description When creating a Reply, the Name field is automatically populated with a truncated, plain text version of the Reply Body field.
NumReportAbuses
Type int Properties Filter, Group, Nillable, Sort Description Represents the number of reported abuses on the reply by users. This field is available in API version 24.0 and later.
QuestionId
Type reference
1621
Standard Objects
Field
ReplyReportAbuse
Details Properties Create, Filter, Group, Sort Description ID of the Question to which this reply was made.
UpVotes
Type int Properties Filter, Group, Nillable, Sort Description The total number of up votes for a reply.
VoteTotal
Type double Properties Filter, Nillable, Sort Description The total number of all votes for a reply, including up and down votes.
Usage Use this object to track replies to a Question.
ReplyReportAbuse Represents a user-reported abuse on a Reply in a Chatter Answers community. This object is available in API version 24.0 and later.
Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field
Details
Name
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort
1622
Standard Objects
Field
Report
Details Description The name of the Reply from which the user reported abuse.
Reason
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The reason the user reported abuse on the Reply, such as Spam, Hateful, or Inappropriate.
ReplyId
Type reference Properties Create, Filter, Group, Sort Description The ID of the Reply from which the user reported abuse.
Usage Use this object to track user-reported abuse on replies created in a Chatter Answers community.
Report Represents a report, a set of data that meets certain criteria, displayed in an organized way. Access is read-only. This object is available in API version 20.0 and later.
Supported Calls describeSObjects(), query(), retrieve(), search()
Fields Field
Details
Description
Type string Properties Filter, Group, Nillable, Sort Description The description of the report. Limit: 255 characters.
1623
Standard Objects
Report
Field
Details
DeveloperName
Type string Properties Filter, Group, Sort Description Required. 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 Report Unique Name. Note: 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.
FolderName
Type string Properties Filter, Nillable, Sort Description Name of the folder that contains the report. Available in API version 35.0 and later.
Format
Type picklist Properties Defaulted on create, Filter, Group, Sort Description Required. Indicates the format of the report. This field is available in API version 40.0 and later. Can have one of these values: • Tabular for reports in that format. The label is Tabular. • Summary for reports in that format. The label is Summary. • Matrix for reports in that format. The label is Matrix. • Multiblock for reports in joined format. The label is Joined.
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
1624
Standard Objects
Report
Field
Details
LastReferencedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
LastRunDate
Type dateTime Properties Filter, Nillable, Sort Description Returns the date the report was last run. Label is Last Run.
LastViewedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Name
Type string Properties Filter, Group, Sort Description Required. The report label used in the user interface.
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 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
1625
Standard Objects
Field
Report
Details installed managed package. This field’s value 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. This field can’t be accessed unless the logged-in user has the “Customize Application” permission.
OwnerId
Type reference Properties Filter Description The ID of the user who currently owns this report.
Supported Query Scopes Use these scopes to help specify the data your SOQL query returns. allPrivate Records saved in all users’ private folders. Requires the user permission "Manage All Private Reports and Dashboards" and Enhanced Analytics Folder Sharing. If your organziation was created after the Summer ’13 release, you already have Enhanced Analytics Folder Sharing. Available in API version 36.0 and later. created Records created by the user running the query. everything All records except records saved in other users’ private folders. mine Records saved in the private folder of the user running the query. organizationOwned Records saved in Unfiled Public Reports. In Lightning Experience, the Unfiled Public Reports folder is called Public Reports.
Usage Use the report object to get report metadata. Query, search, or retrieve specific metadata on reports. Report object fields are read-only.
Example: Reports with “Sales” in Their Name This SOQL query returns reports that contain the name “Sales” and lists their developer names, format, ID, and report name. SELECT DeveloperName,Format,Id,Name FROM Report WHERE Name LIKE '%Sales%'
1626
Standard Objects
ReportFeed
Example: Reports in an Inactive User’s Private Folder This SOQL query returns reports saved in a specific user’s private folder. SELECT Id FROM Report USING SCOPE allPrivate WHERE OwnerId = ‘005A0000000Bc2deFG’
SEE ALSO: ReportFeed ReportTag Dashboard
ReportFeed Represents a single feed item in the feed displayed on a report. This object is available in API version 20.0 and later.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.
Fields Field
Details
Body
Type textarea Properties Nillable, Sort Description The content of ReportFeed. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort
1627
Standard Objects
Field
ReportFeed
Details Description The number of FeedComments associated with this feed item. Tip: In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only one. In a moderated feed, your comment isn’t counted until it's approved by an admin or a person with “CanApproveFeedPostAndComment” or “ModifyAllData” permission. This has implications for how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until end of comments is returned.
ConnectionId
Type reference Properties Filter, Group, Nillable, Sort Description When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string
1628
Standard Objects
Field
ReportFeed
Details Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. This field is required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.
CreatedDate
Type dateTime Properties Defaulted on create, Filter, Sort Description Date and time when this record was created. This field is a standard system field. Ordering by CreatedDateDESC sorts the feed by the most recent feed item.
FeedPostId
Type reference Properties Filter, Group, Nillable, Sort Description This field was removed in API version 22.0, and is available in earlier versions for backward compatibility only. ID of the associated FeedPost. A FeedPost represents the following types of changes in an FeedItem: changes to tracked fields, text posts, link posts, and content posts.
1629
Standard Objects
ReportFeed
Field
Details
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
IsDeleted
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Standard system field. Indicates whether the record has been moved to the Recycle Bin (true) or not (false).
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
1630
Standard Objects
Field
ReportFeed
Details Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation.
LastModifiedDate
Type dateTime Properties Defaulted on create, Filter, Sort Description Date and time when a user last modified this record. This field is a standard system field. When a feed item is created, LastModifiedDate is the same as CreatedDate. If a FeedComment is inserted on that feed item, then LastModifiedDate becomes the CreatedDate for that FeedComment. Deleting the FeedComment does not change the LastModifiedDate. Ordering by LastModifiedDate DESC sorts the feed by both the most recent feed item or comment.
LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
NetworkScope
Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. NetworkScope can have the following values:
• NetworkId—The ID of the community in which the FeedItem is available. If left empty, the feed item is only available in the default community.
1631
Standard Objects
Field
ReportFeed
Details • AllNetworks—The feed item is available in all communities. Note the following exceptions for NetworkScope: • Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks. • You can’t filter a FeedItem on the NetworkScope field.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the account record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the report record. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item: • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging).
1632
Standard Objects
Field
ReportFeed
Details For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • CaseCommentPost—generated event when a user adds a case comment for a case object • EmailMessageEvent—generated event when an email related to a case object is sent or received • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • ChangeStatusPost—generated event when a user changes the status of a case • AttachArticleEvent—generated event when a user attaches an article to a case Note: If you set Type to ContentPost, also specify ContentData and ContentFileName.
1633
Standard Objects
ReportTag
Field
Details
Visibility
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. Visibility can have the following values:
• AllUsers—The feed item is available to all users who have permission to see the feed item. • InternalUsers—The feed item is available to internal users only. Note the following exceptions for Visibility: • For record posts, Visibility is set to InternalUsers for all internal users by default. • External users can set Visibility only to AllUsers. • On user and group posts, only internal users can set Visibility to InternalUsers.
Usage Use this object to retrieve the current contents of the feed fields, such as type of feed or feed ID. SEE ALSO: Report
ReportTag Associates a word or short phrase with a Report. This object is available in API version 20.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve()
Fields Field Name
Details
ItemId
Type reference
1634
Standard Objects
Field Name
ReportTag
Details Properties Create, Filter Description ID of the tagged item.
Name
Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically.
TagDefinitionId
Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag.
Type
Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: • Public—The tag can be viewed and manipulated by all users in an organization. • Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId.
Usage ReportTag stores the relationship between its parent TagDefinition and the Report being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries. SEE ALSO: Report
1635
Standard Objects
ReputationLevel
ReputationLevel Represents a reputation level defined for a community. This object is available in API version 32.0 and later.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules This object is available only if Salesforce Communities is enabled in your organization. Only users with permissions to create or manage a community can view the ReputationPointsRule records.
Fields Field Name
Details
Label
Type string Properties Filter, Group, Nillable, Sort Description The label for the reputation level.
LevelNumber
Type int Properties Filter, Group, Sort Description The rank of the reputation level.
ParentId
Type reference Properties Filter, Group, Sort Description The ID of the parent community (network) the reputation level applies to.
Threshold
Type double Properties Filter, Sort
1636
Standard Objects
Field Name
ReputationLevelLocalization
Details Description The lower limit of reputation points associated with this reputation level. The maximum number of reputation points a user can accrue is 999,999,999,999,999.
ReputationLevelLocalization Represents the translated value of a reputation level. Reputation level localization only applies for reputation levels in communities. This object is available in API version 35.0 and later.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Special Access Rules This object is available only if Salesforce Communities is enabled in your organization and reputation is enabled in your community.
Fields Field Name
Details
Language
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language the reputation level is translated into. The picklist contains the following fully-supported languages: • Chinese (Simplified): zh_CN • Chinese (Traditional): zh_TW • Danish: da • Dutch: nl_NL • English: en_US • Finnish: fi • French: fr • German: de • Italian: it • Japanese: ja • Korean: ko
1637
Standard Objects
Field Name
ReputationLevelLocalization
Details • Norwegian: no • Portuguese (Brazil): pt_BR • Russian: ru • Spanish: es • Spanish (Mexico): es_MX • Swedish: sv • Thai: th
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value 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.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The ID of the reputation level this translated value applies to.
Value
Type string Properties Create, Filter, Sort, Update Description The translated text for the reputation level. Label is Translation Text.
1638
Standard Objects
ReputationPointsRule
ReputationPointsRule Represents the reputation point rules for a community. Each rule specifies an action that community members can earn points from and the points associated with those actions in a particular community. This object is available in API version 32.0 and later.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules This object is available only if Salesforce Communities is enabled in your organization. Only users with permissions to create or manage a community can view the ReputationPointsRule records.
Fields Field Name
Details
ParentId
Type reference Properties Filter, Group, Sort Description The ID of the parent community (network) that the point rule applies to.
Points
Type int Properties Filter, Group, Sort Description The reputation points associated with the member action this rule is for. The maximum value this field can contain is 999,999.
Type
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The member action associated with this rule, limited to one of these values: • Write a post • Write a comment • Receive a comment • Like something
1639
Standard Objects
Field Name
ResourceAbsence
Details • Receive a like • Share a post • Someone shares your post • Mention someone • Receive a mention • Ask a question • Respond to a question • Receive an answer • Mark an answer as best • Your answer is marked as best
ResourceAbsence Represents a time period in which a service resource is unavailable to work. This object is available in API version 38.0 and later.
Supported Calls create(),delete(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),search(),update(),upsert()
Special Access Rules Field Service Lightning must be enabled. To create or update resource absences, you need “Read” access to service resources. To delete resource absences, you need “Edit” access to service resources.
Fields Field Name
Details
AbsenceNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description (Read only) An auto-generated number identifying the absence.
Address
Type address Properties Filter, Nillable
1640
Standard Objects
Field Name
ResourceAbsence
Details Description The compound form of the address associated with the absence.
City
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the address associated with the absence. Maximum length is 40 characters.
Country
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the address associated with the absence. Maximum length is 80 characters.
Description
Type textarea Properties Create, Nillable, Update Description The description of the absence.
End
Type dateTime Properties Create, Filter, Sort, Update Description The date and time when the absence ends.
GeocodeAccuracy
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates.
1641
Standard Objects
Field Name
ResourceAbsence
Details Note: This field is available in the API only.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the resource absence was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the resource absence was last viewed.
Latitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address associated with the absence. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. Note: This field is available in the API only.
Longitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address associated with the absence. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. Note: This field is available in the API only.
Postal Code
Type string
1642
Standard Objects
Field Name
ResourceAbsence
Details Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address associated with the absence. Maximum length is 20 characters.
ResourceId
Type reference Properties Create, Filter, Group, Sort Description The absent service resource.
Start
Type dateTime Properties Create, Filter, Sort, Update Description The date and time when the absence begins.
State
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address associated with the absence. Maximum length is 80 characters.
Street
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name of the address associated with the absence.
Type
Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The type of absence: Meeting, Training, Medical, or Vacation. The default value is Vacation. You can add custom values if needed.
1643
Standard Objects
ResourceAbsenceFeed
Usage The Absences related list on a service resource detail page lets you define periods of time when the resource is unavailable to work. Unless you’re using the Field Service Lightning managed packages with the scheduling optimizer, service resources can still be assigned appointments that conflict with their absences. Tip: Create a trigger that sends an approval request to a supervisor when a service resource creates an absence. If you’re not using the Field Service Lightning managed packages, a calendar view isn’t available for individual service resources.
ResourceAbsenceFeed Represents a single feed item on a resource absence record detail page. This object is available in API version 38.0 and later. A resource absence feed shows changes to tracked fields on a resource absence record. It also shows posts and comments about the record. It’s a useful way to stay up to date with changes made to resource absences in Salesforce.
Supported Calls delete(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Resource Absence object • “Moderate Chatter”
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int Properties Filter, Group, Sort
1644
Standard Objects
Field Name
ResourceAbsenceFeed
Details Description The number of comments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a link post.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the resource absence record tracked in the feed. The feed is displayed on the detail page for this record.
1645
Standard Objects
ResourceAbsenceHistory
Field Name
Details
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the Link URL is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
ResourceAbsenceHistory Represents the history of changes made to tracked fields on a resource absence. This object is available in API version 38.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled.
1646
Standard Objects
ResourcePreference
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
ResourceAbsenceId
Type reference Properties Filter, Group, Sort Description ID of the resource absence being tracked. The history is displayed on the detail page for this record.
ResourcePreference Represents an account’s preference for a specified service resource on field service work. Resource preferences indicate which service resources should be assigned to field service work. You can designate service resources as preferred, required, or excluded on specific accounts or work orders. Work orders inherit their associated account’s resource preferences.
Supported Calls create(),delete(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),update(),upsert()
1647
Standard Objects
ResourcePreference
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the resource preference was last modified.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the resource preference was last viewed.
PreferenceType
Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Resource preference type. Values include: • Preferred: Indicates that the customer would like their field service work assigned to the resource • Required: Indicates that the resource must be assigned to the customer’s field service work • Excluded: Indicates that the customer does not want their field service work assigned to the resource Resource preferences serve more as a suggestion than a requirement. You can still assign a service appointment to any resource regardless of the related work order’s resource preferences.
RelatedRecordId
Type reference Properties Create, Filter, Group, Sort Description The work order or account with the resource preference.
1648
Standard Objects
ResourcePreferenceFeed
Field Name
Details
ResourcePreferenceNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-generated number identifying the resource preference.
ServiceResourceId
Type reference Properties Create, Filter, Group, Sort, Update Description The service resource that is preferred, required, or excluded.
ResourcePreferenceFeed Represents a single feed item on a resource preference record detail page.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the ResourcePreference object • “Moderate Chatter”
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort
1649
Standard Objects
Field Name
ResourcePreferenceFeed
Details Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a link post.
1650
Standard Objects
ResourcePreferenceHistory
Field Name
Details
ParentId
Type reference Properties Filter, Group, Sort Description ID of the resource preference record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the LinkUrl field is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
ResourcePreferenceHistory Represents the history of changes made to tracked fields on a resource preference.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
1651
Standard Objects
RevenueForecast
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
ResourcePreferenceId
Type reference Properties Filter, Group, Sort Description ID of the resource preference being tracked. The history is displayed on the detail page for this record.
RevenueForecast Represents a revenue-based forecast. Use QuantityForecast for quantity-based forecasts.
1652
Standard Objects
RevenueForecast
Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Special Access Rules Customer Portal users can't access this object.
Fields Field
Details
Closed
Type currency Properties Create, Filter Description Read only. A rollup of opportunities or opportunity line items that have closed in this period.
Commit
Type currency Properties Filter, Nillable Description The owner's Commit total.
CommitComment
Type string Properties Filter, Nillable, Update Description Read only. The comment entered when the owner edited his or her Commit total from the Adjusted Total link on the forecast edit page.
CommitOverride
Type currency Properties Filter, Nillable, Update Description Read only. The owner's override of their own My Commit total.
CurrencyIsoCode
Type picklist
1653
Standard Objects
Field
RevenueForecast
Details Properties Filter, Restricted picklist, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. You can update or upsert this field and Quota only.
DefaultRollupCommit
Type currency Properties Filter, Nillable Description Read only. The owner's standard Commit rollup, including their own opportunities and forecast-level overrides from subordinate users in the role hierarchy.
DefaultRollupUpside
Type currency Properties Filter, Nillable Description Read only. The owner's standard Best Case rollup, including their own opportunities and forecast-level overrides from subordinate users in the role hierarchy.
InvalidationDate
Type dateTime Properties Filter, Nillable Description Read only. If not blank, indicates that the rollup numbers for Forecast Override fields that represent calculated (summarized) amounts may not be up to date.
ManagerChoiceCommit
Type picklist Properties Filter, Nillable, Restricted picklist, Update Description Read only. The manager's choice regarding the commit amount: • DefaultRollup: Use the manager's default commit rollup for owner's forecast, which reflects the manager's opportunity forecast overrides.
1654
Standard Objects
Field
RevenueForecast
Details • AcceptForecast (default selection): Accept the forecast owner's Adjusted Total commit amount, which may or may not be an override. • ManagerManualOverride: Use the manager's manual override. • OpportunityOnlyRollup: Use the opportunity rollup, including opportunity forecast overrides, but excluding any forecast-level (Adjusted Total) overrides.
ManagerChoiceUpside
Type picklist Properties Filter, Nillable, Restricted picklist, Update Description Read only. The manager's choice regarding the best case amount: • DefaultRollup: Use the manager's default best case rollup for owner's forecast, which reflects the manager's opportunity forecast overrides. • AcceptForecast (default selection): Accept the forecast owner's Adjusted Total best case amount, which may or may not be an override. • ManagerManualOverride: Use the manager's manual override. • OpportunityOnlyRollup: Use the opportunity rollup, including opportunity forecast overrides, but excluding any forecast-level (Adjusted Total) overrides.
ManagerClosed
Type currency Properties Filter, Nillable Description Read only. The manager's closed total for the owner's forecast, including any opportunity or opportunity product overrides made by the manager.
ManagerCommit
Type currency Properties Filter, Nillable Description The manager's Commit total.
ManagerCommitOverride
Type currency Properties Filter, Nillable, Update
1655
Standard Objects
Field
RevenueForecast
Details Description Read only. The manager's manual override of the forecast owner's Commit total. Represents an option in the override popup window, which allows managers to choose how to roll up the forecast numbers of a direct report.
ManagerDefaultRollupCommit
Type currency Properties Filter, Nillable Description Read only. The manager's standard Commit rollup for the forecast owner. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
ManagerDefaultRollupUpside
Type currency Properties Filter, Nillable Description Read only. The manager's standard Best Case rollup for the forecast owner. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
ManagerId
Type reference Properties Filter, Nillable Description Read only. ID of the direct manager of the user who owns this forecast.
ManagerOpportunityRollupCommit
Type currency Properties Filter, Nillable Description The manager's view of the forecast owner's opportunity-level Commit rollup, ignoring all forecast overrides. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
ManagerOpportunityRollupUpside
Type currency
1656
Standard Objects
Field
RevenueForecast
Details Properties Filter, Nillable Description The manager's view of the forecast owner's opportunity-level Best Case rollup, ignoring all forecast overrides. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
ManagerPipeline
Type currency Properties Filter, Nillable Description The manager's pipeline total for the owner's forecast, including any opportunity or opportunity product overrides made by the manager.
ManagerTerritoryId
Type reference Properties Filter, Nillable Description ID of the manager's UserRole or Territory.
ManagerUpside
Type currency Properties Filter, Nillable Description The manager's Best Case total.
ManagerUpsideOverride
Type currency Properties Filter, Nillable, Update Description The manager's manual override of the forecast owner's Best Case total. Represents an option in the override pop-up window, which allows managers to choose how to roll up the forecast numbers of a direct report.
OpportunityRollupClosed
Type currency
1657
Standard Objects
Field
RevenueForecast
Details Properties Filter, Nillable Description The owner's Closed total for his or her opportunities only.
OpportunityRollupCommit
Type currency Properties Filter, Nillable Description The owner's Commit total for his or her opportunities only.
OpportunityRollupPipeline
Type currency Properties Filter, Nillable Description The owner's Pipeline total for his or her opportunities only.
OpportunityRollupUpside
Type currency Properties Filter, Nillable Description Read only. The owner's Best Case total for his or her opportunities only.
OwnerId
Type reference Properties Create, Defaulted on create, Filter Description ID of the User who owns this forecast. Required on create.
PeriodId
Type reference Properties Filter, Nillable Description The ID of the Period that contains the StartDate.
Pipeline
Type currency
1658
Standard Objects
Field
RevenueForecast
Details Properties Filter, Nillable Description The total pipeline rollup from subordinates in the role hierarchy, including the owner's opportunities.
ProductFamily
Type picklist Properties Create, Filter, Nillable Description The value chosen in the Product Family picklist, which can be configured from the object management settings for products. This field is relevant if you have chosen Product Families as the Forecast Type in Forecasts Settings. If you are not forecasting by product family or if the forecast represents opportunities that are not associated with a product family, then this field is blank. Otherwise, this field is required on create.
Quota
Type currency Properties Create, Filter, Nillable, Update Description The quota amount for the period. You can update or upsert this field and CurrencyIsoCode, and for Quota only, create. Requires the “Modify All Data” and “Manage Users” permission. Required on create.
StartDate
Type date Properties Create, Filter, Nillable Description The start date of this forecast. The period ID of the period that contains this date is written to the PeriodId field if it changes. A new Period is created if none exists. Required on create.
TerritoryId
Type reference Properties Create, Filter, Nillable Description ID of the forecast owner's UserRole or Territory. Required on create if Territory Management is enabled (if this field is available).
1659
Standard Objects
RevenueForecast
Field
Details
Upside
Type currency Properties Filter, Nillable Description The owner's Best Case total.
UpsideComment
Type string Properties Filter, Nillable, Update Description Read only. The comment entered when the owner edited his or her Best Case total. Label is Best Case Comment.
UpsideOverride
Type currency Properties Filter, Nillable, Update Description Read only. The owner's override of their My Best Case total. Label is Best Case Override.
Usage Query this object to support customizable forecasts based on revenue. Requires the “View All Data” permission. You can also update CurrencyIsoCode and Quota, which means that you can mass update sales users' quotas instead of updating them one by one in the user interface. Editing Quota requires “Modify All Data” and “Manage Users” permissions. The rollup fields always reflect opportunity and opportunity product overrides by the forecast owner or one of the forecast owner’s subordinates in the role hierarchy. In addition, the manager rollup fields include overrides by the forecast owner's direct manager in the role hierarchy. Some of the rollup fields ignore forecast-level (Adjusted Total) overrides, but they never ignore opportunity forecast overrides that are visible to the owner or manager. SEE ALSO: QuantityForecast RevenueForecastHistory Object Basics
1660
Standard Objects
RevenueForecastHistory
RevenueForecastHistory Represents historical information about revenue-based forecasts that have been submitted (saved) in the user interface.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules • Requires the “View All Data” permission. • Customer Portal users can’t access this object.
Fields Field
Details
Closed
Type currency Properties Filter Nillable Description The closed amount of the forecast.
Commit
Type currency Properties Filter, Nillable Description The commit amount of the forecast.
CommitComments
Type string Properties Filter, Nillable Description Comments about the commit value.
CommitOverridden
Type boolean Properties Defaulted on create, Filter
1661
Standard Objects
Field
RevenueForecastHistory
Details Description Indicates whether the commit value was overridden (true) or not (false).
CurrencyIsoCode
Type picklist Properties Defaulted on create, Filter, Restricted picklist Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
ForecastOverrideId
Type reference Properties Filter Description ID of the related forecast override.
Pipeline
Type currency Properties Filter, Nillable Description The pipeline amount of the forecast.
Quota
Type currency Properties Filter, Nillable Description The quota amount of the forecast.
Upside
Type currency Properties Filter, Nillable Description The best case amount of the forecast.
UpsideComments
Type string
1662
Standard Objects
Field
RuleTerritory2Association
Details Properties Filter, Nillable Description Comments about the upside value.
UpsideOverridden
Type boolean Properties Defaulted on create Filter Description Indicates whether the upside value was overridden (true) or not (false).
Usage This is a read-only object specific to customizable forecasting. When a user submits a revenue-based forecast in the user interface, a new record is created. If the same forecast is ever resubmitted, additional records are added. The CreatedDate of a record reflects the day on which the forecast was submitted. This object respects field-level security on the parent object. SEE ALSO: QuantityForecastHistory RevenueForecast Object Basics
RuleTerritory2Association Represents a record-assignment rule and its association to an object, such as Account. Available only if Enterprise Territory Management has been enabled for your organization.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules If a territory model is in Active state, any user can view that model, including its territories and assignment rules. For territories in an active model, any user can view assigned records and assigned users subject to your organization’s sharing settings. Users cannot view territory models in other states (such as Planning or Archived).
1663
Standard Objects
SamlSsoConfig
Fields Field Name
Details
IsInherited
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates whether the rule is an inherited rule (true) or a local rule (false). Rule inheritance flows from the parent territory where the rule is created to the rule’s descendent territories (if any) in the territory model hierarchy. A local rule is created within a single territory and affects that territory only.
RuleId
Type reference Properties Create, Filter, Group, Sort Description The ID of the rule.
Territory2Id
Type reference Properties Create, Filter, Group, Sort Description The ID of the territory where the rule was created.
SamlSsoConfig Represents a SAML Single Sign-On configuration. This object is available in API version 32.0 and later. Single sign-on is a process that allows network users to access all authorized network resources without having to log in separately to each resource. Single sign-on allows you to validate usernames and passwords against your corporate user database or other client application rather than having separate user passwords managed by Salesforce.
Supported Calls describeSObjects(), query(), retrieve()
1664
Standard Objects
SamlSsoConfig
Fields Field Name
Details
AttributeFormat
Type string Properties Filter, Group, Nillable, Sort Description For SAML 2.0 only and when identityLocation is set to Attribute. Possible values include unspecified, emailAddress or persistent. All legal values can be found in the “Name Identifier Format Identifiers” section of the Assertions and Protocols SAML 2.0 specification.
AttributeName
Type string Properties Filter, Group, Nillable, Sort Description The name of the identity provider’s application. Get this name value from your identity provider.
Audience
Type string Properties Filter, Group, Sort Description The Issuer, also called the “Entity ID.” The value is a URL that uniquely identifies the SAML identity provider.
DeveloperName
Type string Properties Filter, Group, Sort 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.
1665
Standard Objects
SamlSsoConfig
Field Name
Details
ErrorUrl
Type string Properties Filter, Nillable, Sort Description The URL of the page users should be directed to if there’s an error during SAML login. It must be a publicly accessible page, such as a public site Visualforce page. The URL can be absolute or relative.
ExecutionUserID
Type reference Properties Filter, Group, Nillable, Sort Description The user that runs the Apex handler class. The user must have the “Manage Users” permission. A user is required if you specify a SAML JIT handler class.
IdentityLocation
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The location in the assertion where a user is identified. Valid values are: • SubjectNameId—The identity is in the statement of the assertion. • Attribute—The identity is specified in an , located in the of the assertion.
IdentityMapping
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The identifier that the service provider uses for the user during Just-in-Time user provisioning. Valid values are: • Username—The user’s Salesforce username. • FederationId—The federation ID from the user object; the identifier that’s used by the service provider for the user. • UserId—The user ID from the user’s Salesforce organization.
1666
Standard Objects
SamlSsoConfig
Field Name
Details
Issuer
Type string Properties Filter, idLookup, Group, Sort Description Also called the “Entity ID.” The value is a URL that uniquely identifies the SAML identity provider.
Language
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language for the organization.
LoginUrl
Type string Properties Filter, Nillable, Sort Description For SAML 2.0 only: The URL where Salesforce sends a SAML request to start the login sequence.
LogoutUrl
Type string Properties Filter, Nillable, Sort Description For SAML 2.0 only: The URL to direct users to where they click the Logout link. The default is http://www.salesforce.com.
MasterLabel
Type string Properties Filter, Group, Sort Description The text that’s used to identify the Visualforce page in the Setup area of Salesforce.
NamespacePrefix
Type string
1667
Standard Objects
Field Name
SamlSsoConfig
Details Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value 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.
OptionsSpInitBinding
Type boolean Properties Filter Description The service provider initiated request binding, either HTTP Redirect (true) or HTTP POST (false).
OptionsUserProvisioning
Type boolean Properties Filter Description If true, Just-in-Time user provisioning is enabled, which creates users on the fly the first time that they try to log in. Specify Federation ID for the identityMapping value to use this feature.
RequestSignatureMethod
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The method that’s used to sign the SAML request. Valid values are: • RSA-SHA1
1668
Standard Objects
Field Name
Scontrol
Details • RSA-SHA256
SamlJitHandlerId
Type reference Properties Filter, Group, Nillable, Sort Description The name of an existing Apex class that implements the Auth.SamlJitHandler interface.
ValidationCert
Type string Properties Filter, Sort Description The certificate that’s used to validate the request. Get this certificate value from your identity provider.
Version
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The SAML version. Valid values are: • SAML1_1 • SAML2_2
Scontrol A custom s-control, which is custom content that is hosted by the system but executed by the client application. Important: Visualforce pages supersede s-controls. Organizations that haven’t previously used s-controls can’t create them. Existing s-controls are unaffected, and can still be edited. We recommend that you move your s-controls to Visualforce. We continue to support the Scontrol object. Represents a custom s-control, which is custom content that the system hosts, but client applications execute. An s-control can contain any type of content that you can display or run in a Web browser.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update()
1669
Standard Objects
Scontrol
Special Access Rules • Your organization must be using Enterprise, Developer, or Unlimited Edition and be enabled for custom s-controls. • Customer Portal users can’t access this object.
Fields Field
Details
Binary
Type base64 Properties Nillable, Update Description Binary content of this custom s-control, such as an ActiveX control or a Java archive. Can be specified when created, but not when updated. Limit: 5 MB.
BodyLength
Type int Properties Filter, Group, Sort Description The length of the custom s-control. Label is Binary Length.
ContentSource
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the source of the s-control content, either custom HTML, a snippet (s-controls that are included in other s-controls), or a URL.
Description
Type string Properties Filter, Group, Nillable, Sort, Update Description Description of the custom s-control.
DeveloperName
Type string Properties Filter, Group, Sort, Update
1670
Standard Objects
Field
Scontrol
Details 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 S-Control Name. Note: 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.
EncodingKey
Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description Picklist of character set encodings, including ISO-08859-1, UTF-8, EUC, JIS, Shift-JIS, Korean (ks_c_5601-1987), Simplified Chinese (GB2312), and Traditional Chinese (Big5).
Filename
Type string Properties Filter, Group, Nillable, Sort, Update Description An uploaded object to display when the custom s-control is added to a custom link. Can be a Java applet, an ActiveX control, or any other type of desired content.
HtmlWrapper
Type textarea Properties Update Description Required. HTML page that will be delivered when the user views this custom s-control. This HTML page can be the entire content of the custom s-control, or it can reference the binary. Limit: 1,048,576 characters. Label is HTML Body.
Name
Type string Properties Filter, Group, Sort, Update Description Required. Name of this custom s-control. Label is Label.
1671
Standard Objects
ScontrolLocalization
Field
Details
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value 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.
SupportsCaching
Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the s-control supports caching (true) or not (false).
Usage Use custom s-controls to manage custom content that extends application functionality. All users can view custom s-controls, but the “Customize Application” permission is required to create or update custom s-controls. SEE ALSO: Object Basics
ScontrolLocalization The translated value of the field label for an s-control. Important: Visualforce pages supersede s-controls. Organizations that haven’t previously used s-controls can’t create them. Existing s-controls are unaffected, and can still be edited. When the Translation Workbench is enabled for your organization, provides the translation of the field label of an s-control.
1672
Standard Objects
ScontrolLocalization
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Special Access Rules • Your organization must be using Professional, Enterprise, Developer, or Unlimited Edition and be enabled for the Translation Workbench. • To view this object, you must have the “View Setup and Configuration” permission.
Fields Field
Details
LanguageLocaleKey
Type picklist Properties Create, Filter, Nillable, Restricted picklist Description This field is available in API version 16.0 and earlier. It is the same as the Language field.
Language
Type picklist Properties Create, Filter, Nillable, Restricted picklist Description This field is available in API version 17.0 and later. The combined language and locale ISO code, which controls the language for labels displayed in an application. This picklist contains the following fully-supported languages: • Chinese (Simplified): zh_CN • Chinese (Traditional): zh_TW • Danish: da • Dutch: nl_NL • English: en_US • Finnish: fi • French: fr • German: de • Italian: it
1673
Standard Objects
Field
ScontrolLocalization
Details • Japanese: ja • Korean: ko • Norwegian: no • Portuguese (Brazil): pt_BR • Russian: ru • Spanish: es • Spanish (Mexico): es_MX • Swedish: sv • Thai: th The following end-user only languages are available. • Arabic: ar • Bulgarian: bg • Croatian: hr • Czech: cs • English (UK): en_GB • Greek: el • Hebrew: iw • Hungarian: hu • Indonesian: in • Polish: pl • Portuguese (Portugal): pt_PT • Romanian: ro • Slovak: sk • Slovenian: sl • Turkish: tr • Ukrainian: uk • Vietnamese: vi The following platform languages are available for organizations that use Salesforce exclusively as a platform. • Albanian: sq • Arabic (Algeria): ar_DZ • Arabic (Bahrain): ar_BH • Arabic (Egypt): ar_EG • Arabic (Iraq): ar_IQ • Arabic (Jordan): ar_JO • Arabic (Kuwait): ar_KW • Arabic (Lebanon): ar_LB • Arabic (Libya): ar_LY
1674
Standard Objects
Field
ScontrolLocalization
Details • Arabic (Morocco): ar_MA • Arabic (Oman): ar_OM • Arabic (Qatar): ar_QA • Arabic (Saudi Arabia): ar_SA • Arabic (Sudan): ar_SD • Arabic (Syria): ar_SY • Arabic (Tunisia): ar_TN • Arabic (United Arab Emirates): ar_AE • Arabic (Yemen): ar_YE • Armenian: hy • Basque: eu • Bosnian: bs • Bengali: bn • Chinese (Simplified—Singapore): zh_SG • Chinese (Traditional—Hong Kong): zh_HK • Dutch (Belgium): nl_BE • English (Australia): en_AU • English (Canada): en_CA • English (Hong Kong): en_HK • English (India): en_IN • English (Ireland): en_IE • English (Malaysia): en_MY • English (Philippines): en_PH • English (Singapore): en_SG • English (South Africa): en_ZA • Estonian: et • French (Belgium): fr_BE • French (Canada): fr_CA • French (Luxembourg): fr_LU • French (Switzerland): fr_CH • Georgian: ka • German (Austria): de_AT • German (Belgium): de_BE • German (Luxembourg): de_LU • German (Switzerland): de_CH • Hindi: hi • Icelandic: is • Irish: ga
1675
Standard Objects
Field
ScontrolLocalization
Details • Italian (Switzerland): it_CH • Latvian: lv • Lithuanian: lt • Luxembourgish: lb • Macedonian: mk • Malay: ms • Maltese: mt • Romanian (Moldova): ro_MD • Montenegrin: sh_ME • Romansh: rm • Serbian (Cyrillic): sr • Serbian (Latin): sh • Spanish (Argentina): es_AR • Spanish (Bolivia): es_BO • Spanish (Chile): es_CL • Spanish (Colombia): es_CO • Spanish (Costa Rica): es_CR • Spanish (Dominican Republic): es_DO • Spanish (Ecuador): es_EC • Spanish (El Salvador): es_SV • Spanish (Guatemala): es_GT • Spanish (Honduras): es_HN • Spanish (Nicaragua): es_NI • Spanish (Panama): es_PA • Spanish (Paraguay): es_PY • Spanish (Peru): es_PE • Spanish (Puerto Rico): es_PR • Spanish (United States): es_US • Spanish (Uruguay): es_UY • Spanish (Venezuela): es_VE • Tagalog: tl • Tamil: ta • Urdu: ur • Welsh: cy The values in this field are not related to the default locale selection.
NamespacePrefix
Type string
1676
Standard Objects
Field
ScontrolLocalization
Details Properties Filter, Nillable Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value 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.
ScontrolId
Type reference Properties Create, Filter, Nillable Description The ID of the Scontrol that is being translated.
Value
Type string Properties Create, Filter, Nillable, Update Description The actual translated field label of the s-control. Label is Translation.
Usage Use this object to translate your s-controls into a supported language. Users with the Translation Workbench enabled can view s-control translations, but either the “Customize Application” or “Manage Translation” permission is required to create or update s-control translations. SEE ALSO: CategoryNodeLocalization WebLinkLocalization
1677
Standard Objects
ScratchOrgInfo (Beta)
ScratchOrgInfo (Beta) Represents a scratch org and its audit log. Use this object to create a scratch org and keep a log of its creation and deletion. This object is available in API version 40.0 and later.
Supported Calls Note: This release contains a beta version of ScratchOrgInfo, which means it’s a high-quality feature with known limitations. General availability, with complete documentation and support, is planned for a subsequent release. create(),delete(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),update(),upsert()
Fields Field Name
Details
AdminEmail
Type email Properties Create, Filter, Group, Nillable, Sort Description The email address of the scratch org’s Administration user. The read-only SignupEmail field is populated with this value. If you don't provide a value for AdminEmail, the field is left blank and the SignupEmail is populated with the email address of the org user who is creating this object.
AlmReference
Type textarea Properties Create, Nillable, Update Description A text area where you can enter a description of how this scratch org is associated with a particular continuous integration or delivery job.
AuthCode
Type string Properties Filter, Group, Nillable, Sort Description A one-time authorization code that can be exchanged for an OAuth access token and refresh token using standard Salesforce APIs. It’s used with ConnectedAppCallbackUrl and ConnectedAppConsumerKey, when the specified connected app hasn't been configured with an X.509 certificate. This field is read-only.
1678
Standard Objects
ScratchOrgInfo (Beta)
Field Name
Details
ConnectedAppCallbackUrl
Type textarea Properties Create Description When used with ConnectedAppConsumerKey, specifies a connected app that is approved automatically during the scratch org creation.
ConnectedAppConsumerKey
Type string Properties Create, Filter, Group, Sort Description When used with ConnectedAppCallbackUrl, specifies a connected app that is approved automatically during the scratch org creation.
Country
Type string Properties Create, Filter, Group, Nillable, Sort Description The two-character, upper-case ISO-3166 country code. You can find a full list of these codes at several sites, such as: www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html. The language of the scratch org is auto-determined based on the value of this field. If you do not specify a value, this field defaults to the Dev Hub’s country code.
DeletedBy
Type string Properties Filter, Group, Nillable, Sort Description The user who requested that the scratch org be deleted. This field is read-only.
DeletedDate
Type date Properties Filter, Group, Nillable, Sort Description The date when the DeletedBy user requested that the scratch org be deleted. This field is read-only.
1679
Standard Objects
ScratchOrgInfo (Beta)
Field Name
Details
Description
Type textarea Properties Create, Nillable, Update Description A free-form text field for you to enter a description of this scratch org.
Edition
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The org edition of this scratch org. Valid values are Group, Developer, Enterprise, and Professional.
ErrorCode
Type string Properties Filter, Group, Nillable, Sort Description The error code if the scratch org creation isn’t successful. This field is read-only.
ExpirationDate
Type date Properties Filter, Group, Nillable, Sort Description Date when the scratch org expires. This field is read-only.
Features
Type textarea Properties Create, Nillable Description A semi-colon delimited list of the features enabled in this scratch org, such as MultiCurrency. See the Salesforce DX Developer Guide for the full list of valid features.
Language
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort
1680
Standard Objects
Field Name
ScratchOrgInfo (Beta)
Details Description The language of the scratch org being created. Specify the language using a language code listed under "Supported Languages" in the Salesforce Help. For example, use zh_CN for simplified Chinese. The value you select overrides the language set by locale. If you don’t specify a value, the language is based on the Country used during scratch org creation. If you don’t specify a value for Country, the value defaults to the Dev Hub’s country.
LastLoginDate
Type date Properties Filter, Group, Nillable, Sort Description The date of the last user login to the scratch org. This field is read-only.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date this scratch org was last referenced. This field is read-only.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date this scratch org was last viewed. This field is read-only.
Name
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The auto-generated ID of this scratch org. This field is read-only.
Namespace
Type string Properties Create, Filter, Group, Nillable, Sort
1681
Standard Objects
Field Name
ScratchOrgInfo (Beta)
Details Description The namespace you want to associate with this scratch org. The value of this field corresponds to the NamespacePrefix field of the NamespaceRegistry object that describes your namespace.
OrgName
Type string Properties Create, Filter, Group, Sort Description The name of the scratch org.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who created this scratch org.
ScratchOrg
Type string Properties Filter, Group, Nillable, Sort Description The org ID of the scratch org. This field is read-only.
SignupCountry
Type string Properties Filter, Group, Sort Description The country code of the scratch org. This field is populated with the value of the Country field. If you didn’t provide a value for Country, it’s the country code of the Dev Hub. This field is read-only.
SignupEmail
Type email Properties Filter, Group, Sort Description The email address of the scratch org’s Administration user. This field is populated with the value of the AdminEmail field. If you didn't provide a value for
1682
Standard Objects
Field Name
ScratchOrgInfo (Beta)
Details AdminEmail, it's the email address of your user in the Dev Hub. This field is
read-only. SignupInstance
Type string Properties Filter, Group, Nillable, Sort Description The Salesforce instance on which this scratch org resides. This field is read-only.
SignupLanguage
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the scratch org. This field is populated with the value of the Language field. If you didn’t provide a value for Language, it’s the language of the Dev Hub. This field is read-only.
SignupTrialDays
Type int Properties Filter, Group, Nillable, Sort Description The number of days between the scratch org's creation and expiration. This field is read-only.
SignupUsername
Type string Properties Filter, Group, Sort Description The username of the Administration user of this scratch org. This field is populated with the value of the Username field. If you didn’t provide a value for Username, the value of this field is auto-generated. This field is read-only.
Status
Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort
1683
Standard Objects
Field Name
SearchPromotionRule
Details Description The status of the scratch org, such as active, expired, or deleted. This field is read-only.
Username
Type string Properties Create, Filter, Group, Nillable, Sort Description The username of the Administration user of this scratch org.
SEE ALSO: ActiveScratchOrg (Beta) NamespaceRegistry (Beta) Salesforce DX Developer Guide (Beta)
SearchPromotionRule Represents a promoted search term, which is one or more keywords that you associate with a Salesforce Knowledge article. When a user’s search query includes these keywords, the associated article is returned first in search results. This object is available in API version 31.0 and later.
Supported Calls create(),delete(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),undelete(),update(),upsert()
Special Access Rules A user must have the “Manage Promoted Search Terms” permission.
Fields Field Name
Details
PromotedEntityId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the KnowledgeArticleVersion that the promoted search term is associated with. The article must be in published status.
1684
Standard Objects
SecureAgent
Field Name
Details
Query
Type string Properties Create, Filter, Group, Sort, Update Description The text of the promoted search term. Maximum length: 100 characters. You can associate the same promoted search term with multiple articles. If the user’s search matches the promoted term, all associated articles are promoted in search results, ordered by relevancy. For best results, create promoted search terms selectively and limit the number of articles that are promoted per term.
Usage Use this object to optimize article search results in Salesforce Knowledge.
SecureAgent Represents a Secure Agent that connects Salesforce to on-premises external data sources like SharePoint 2010 and 2013. This object is available in API version 32.0 and later.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
DeveloperName
Type string Properties Filter, Group, Sort 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.
1685
Standard Objects
Field Name
SecureAgent
Details Note: 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.
Language
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of agent labels in the user interface.
MasterLabel
Type string Properties Filter, Group, Sort Description The user-interface name for the agent.
Priority
Type int Properties Filter, Group, Nillable, Sort Description Specifies the order in which this agent is accessed relative to others in a Secure Agent cluster. This field is available in API version 35 and later.
ProxyUserId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user profile specific to the agent.
SecureAgentsClusterId
Type reference Properties Filter, Group, Nillable, Sort
1686
Standard Objects
Field Name
SecureAgentsCluster
Details Description The ID of a cluster of agents that contains this individual agent. Clusters provide failover protection if an agent on a particular server becomes inaccessible. To edit them, use the SecureAgentsCluster object. This field is available in API version 35 and later.
SecureAgentsCluster Represents a cluster consisting of several Secure Agents on different servers. Clusters provide failover protection if an agent on a particular server becomes inaccessible. This object is available in API version 35.0 and later. Secure Agents connect Salesforce to content in on-premises external data sources, such as SharePoint 2010 and 2013. To edit individual agents that are part of a cluster, use the SecureAgent object.
Supported Calls describeLayout(), describeSObjects(), query(), retrieve()
Fields Field Name
Details
Description
Type textarea Properties Filter, Group, Nillable, Sort Description Describes details about the cluster, providing context to other developers.
DeveloperName
Type string Properties Filter, Group, Sort 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.
1687
Standard Objects
Field Name
SecurityCustomBaseline (Beta)
Details Note: 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.
Language
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of cluster labels in the user interface.
MasterLabel
Type string Properties Filter, Group, Sort Description The user-interface name for the cluster.
SecurityCustomBaseline (Beta) Provides the ability to read, create, and delete user-defined custom security baselines, which define an org’s security standards. This object is available in API version 39.0 and later. This release contains a beta version of Custom Baseline, which means it’s a high-quality feature with known limitations. General availability, with complete documentation and support, is planned for a subsequent release.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Special Access Rules You must have the “View Health Check” permission to read a custom baseline, and the “Manage Health Check” permission to create, edit, or delete one.
Fields Field Name
Details
Baseline
Type textarea
1688
Standard Objects
Field Name
SecurityCustomBaseline (Beta)
Details Properties Create, Nillable, Update Description The definition an org’s security settings standards.
DeveloperName
Type string Properties Create, Filter, Group, Sort, Update 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. Note: 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.
Language
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the presence status.
MasterLabel
Type string Properties Create, Filter, Group, Sort, Update Description Label for the category node.
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with the package.
1689
Standard Objects
SelfServiceUser
SelfServiceUser Represents a Contact who has been enabled to use your organization’s Self-Service portal, where he or she can obtain online support. Note: Starting with Spring ’12, the Self-Service portal isn’t available for new orgs. Existing orgs continue to have access to the Self-Service portal.
Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Special Access Rules Customer Portal users can't access this object.
Fields Field
Details
ContactId
Type reference Properties Create, Filter, Group, Sort Description Required. All Self-Service users must be associated with a Contact. The contact’s email should match the Self-Service user email. The contact must have a value in the AccountId field or an error occurs.
Email
Type email Properties Create, Filter, Group, Sort, Update Description Required. Make this the same as the email address for the Contact associated with this SelfServiceUser. Password resets and other system communication will be sent to this email address.
FirstName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description First name of the Self-Service user.
1690
Standard Objects
SelfServiceUser
Field
Details
IsActive
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Self-Service user is allowed to log in to the Self-Service portal (true) or not (false). Note that there is no way to delete a Self-Service user. They can only be marked as inactive.
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
LanguageLocaleKey
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. This is a restricted picklist field. It is the primary language for the user. All on-screen text in the Self-Service portal is displayed in this language.
LastLoginDate
Type dateTime Properties Filter, Nillable, Sort Description The date and time when the Self-Service user last logged in.
LastName
Type string Properties Create, Filter, Group, Sort, Update Description Required. Last name of the Self-Service user.
LocaleSidKey
Type picklist
1691
Standard Objects
Field
SelfServiceUser
Details Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. This is a restricted picklist field. The value of this field affects the formatting and parsing of values, especially numeric values, in the Self-Service portal. Values are two-letter codes that indicate language and sometimes language and country. The codes are based on ISO standards.
Name
Type string Properties Filter, Group, Sort Description Concatenation of FirstName and LastName. Limited to 121 characters.
SuperUser
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this Self-Service user is a super user with additional access on his or her company's Self-Service portal (true) or not (false).
TimeZoneSidKey
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. This is a restricted picklist field. The time zone of a affects the offset used when displaying or entering times in the Self-Service portal.
Username
Type string Properties Create, Filter, Group, Sort, Update Description Required. This contains the name that a Self-Service user enters to log into the Self-Service portal. Value must be unique in your organization. If you try to create or update a user with a duplicate value, the operation is rejected and an error is returned.
1692
Standard Objects
ServiceAppointment
Usage For security reasons, you can’t query Self-Service user passwords via the API or the user interface. However, the API allows you to set and reset Self-Service user passwords using the setPassword() and resetPassword() calls. SelfServiceUser records created from the API don’t cause a notification email to be sent. If you want to notify the user, you must send them an email after creating the user. SEE ALSO: Contact User
ServiceAppointment Represents an appointment to complete field service work for a customer. This object is available in API version 38.0 and later.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
AccountId
Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The account associated with the appointment. If the parent record is a work order or work order line item, this field’s value is inherited from the parent. Otherwise, it remains blank.
ActualDuration
Type int Properties Create, Filter, Nillable, Sort, Update Description The number of minutes that it took the resource to complete the appointment after arriving at the address. When values are first added to the Actual
1693
Standard Objects
Field Name
ServiceAppointment
Details Start and Actual End fields, the Actual Duration is automatically populated to list the difference between the Actual Start and Actual End. If the Actual Start and Actual End fields are subsequently updated, the Actual Duration field doesn’t re-update, but you can
manually update it. ActualEndTime
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The actual date and time the appointment ended.
ActualStartTime
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The actual date and time the appointment started.
Address
Type address Properties Filter Description The address where the appointment is taking place. The address is inherited from the parent record if the parent record is a work order or work order line item.
AppointmentNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-assigned number that identifies the appointment.
ArrivalWindowEndTime
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The end of the window of time in which the technician is scheduled to arrive at the site. This window is typically larger than the Scheduled Start and End window
1694
Standard Objects
Field Name
ServiceAppointment
Details to allow time for delays and scheduling changes. You may choose to share the Arrival Window Start and End with the customer, but keep the Scheduled Start and End internal-only.
ArrivalWindowStartTime
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The beginning of the window of time in which the technician is scheduled to arrive at the site. This window is typically larger than the Scheduled Start and End window to allow time for delays and scheduling changes. You may choose to share the Arrival Window Start and End with the customer, but keep the Scheduled Start and End internal-only.
City
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city where the appointment is completed. Maximum length is 40 characters.
ContactId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The contact associated with the parent record. If needed, you can manually update the service appointment contact.
Country
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country where the work order is completed. Maximum length is 80 characters.
Description
Type textarea Properties Create, Nillable, Update Description The description of the appointment.
1695
Standard Objects
ServiceAppointment
Field Name
Details
DueDate
Type dateTime Properties Create, Filter, Sort, Update Description The date by which the appointment must be completed. Earliest Start Permitted and Due Date typically reflect terms in the customer’s service-level agreement.
Duration
Type double Properties Create, Nillable, Filter, Sort, Update Description The estimated length of the appointment. If the parent record is work order or work order line item, the appointment inherits its parent’s duration, but it can be manually updated. The duration is in minutes or hours based on the value selected in the Duration Type field.
DurationType
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit of the Duration: Minutes or Hours.
EarliestStartTime
Type dateTime Properties Create, Filter, Sort, Update Description The date after which the appointment must be completed. Earliest Start Permitted and Due Date typically reflect terms in the customer’s service-level agreement.
GeocodeAccuracy
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates.
1696
Standard Objects
Field Name
ServiceAppointment
Details Note: This field is available in the API only.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the service appointment was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the service appointment was last viewed.
Latitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the service appointments is completed. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. Note: This field is available in the API only.
Longitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the service appointment is completed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. Note: This field is available in the API only.
OwnerId
Type reference
1697
Standard Objects
Field Name
ServiceAppointment
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the service appointment.
ParentRecordId
Type reference Properties Create, Filter, Group, Sort Description The parent record associated with the appointment.
ParentRecordStatusCategory
Type string Properties Group, Nillable, Sort Description (Read only) The Status Category of the parent record. If the parent record is a work order or work order line item, this field is populated; otherwise, it remains blank.
ParentRecordType
Type string Properties Group, Nillable, Sort Description (Read only) The type of parent record: Account, Asset, Opportunity, Work Order, or Work Order Line Item.
PostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code where the work order is completed. Maximum length is 20 characters.
SchedEndTime
Type dateTime Properties Create, Filter, Nillable, Sort, Update
1698
Standard Objects
Field Name
ServiceAppointment
Details Description The time at which the appointment is scheduled to end. If you are using the Field Service Lightning managed packages with the scheduling optimizer, this field is populated once the appointment is assigned to a resource. Scheduled End – Scheduled Start = Estimated Duration.
SchedStartTime
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time at which the appointment is scheduled to start. If you are using the Field Service Lightning managed packages with the scheduling optimizer, this field is populated once the appointment is assigned to a resource.
ServiceTerritoryId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service territory associated with the appointment. If the parent record is a work order or work order line item, the appointment inherits its parent’s service territory.
State
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state where the service appointment is completed. Maximum length is 80 characters.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the appointment. The picklist includes the following values, which can be customized: • None—Default value. • Scheduled—Appointment has been assigned to a service resource.
1699
Standard Objects
Field Name
ServiceAppointment
Details • Dispatched—Assigned service resource has been notified about their assignment. • In Progress—Work has begun. • Completed—Work is complete. • Cannot Complete—Work could not be completed. • Canceled—Work is canceled, typically before any work began
StatusCategory
Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The category that each Status value falls into. The Status Category field has seven values which are identical to the default Status values. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Customer Absent value, you may decide that it belongs in the Cannot Complete category. The Status Category field can be useful to reference in custom apps, triggers, and validation rules. Status categories let you extend and customize the work life cycle while still maintaining a consistent work classification for tracking, reporting, and business process management.
Street
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name where the service appointment is completed.
Subject
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A short phrase describing the appointment.
WorkTypeId
Type reference Properties Filter, Group, Nillable, Sort
1700
Standard Objects
Field Name
ServiceAppointmentFeed
Details Description The work type associated with the service appointment. The work type is inherited from the appointment’s parent record if the parent is a work order or work order line item.
Usage Service appointments always have a parent record, which can be a work order, work order line item, opportunity, account, or asset. The type of parent record tells you about the nature of the service appointment: • Service appointments on work orders and work order line items offer a more detailed view of the work being performed. While work orders and work order line items let you enter general information about a task, service appointments are where you add the details about scheduling and ownership. • Service appointments on assets represent work being performed on the asset. • Service appointments on accounts represent work being performed for the account. • Service appointments on opportunities represent work that is related to the opportunity.
ServiceAppointmentFeed Represents a single feed item on a service appointment record detail page. This object is available in API version 38.0 and later. A service appointment feed shows changes to tracked fields on a service appointment record. It also shows posts and comments about the record. It’s a useful way to stay up to date with changes made to service appointments in Salesforce.
Supported Calls delete(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Operating Hours object • “Moderate Chatter”
Fields Field Name
Details
Body
Type textarea
1701
Standard Objects
Field Name
ServiceAppointmentFeed
Details Properties Nillable, Sort Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort
1702
Standard Objects
Field Name
ServiceAppointmentHistory
Details Description The URL of a link post.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the service appointment record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the Link URL is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
ServiceAppointmentHistory Represents the history of changes made to tracked fields on a service appointment. This object is available in API version 38.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
1703
Standard Objects
ServiceAppointmentOwnerSharingRule
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
ServiceAppointmentId
Type reference Properties Filter, Group, Sort Description ID of the service appointment being tracked. The history is displayed on the detail page for this record.
ServiceAppointmentOwnerSharingRule Represents the rules for sharing a service appointment with user records other than the owner or anyone above the owner in the role hierarchy. This object is available in API version 38.0 and later.
1704
Standard Objects
ServiceAppointmentOwnerSharingRule
Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer support to enable access to this object for your org.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Fields Field
Details
Description
Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters.
DeveloperName
Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update 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. Corresponds to Rule Name in the user interface. Note: 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.
GroupId
Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. A service appointment owned by a User in the source Group triggers the rule to give access.
Name
Type string
1705
Standard Objects
Field
ServiceAppointmentShare
Details Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to Label on the user interface.
ServiceAppointmentAccessLevel Type
picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target Group, or UserRole. The possible values are: • Read • Edit • All UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description The ID representing the User or Group being granted access.
ServiceAppointmentShare Represents a sharing entry on a service appointment. This object is available in API version 38.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Special Access Rules Field Service Lightning must be enabled.
1706
Standard Objects
ServiceAppointmentShare
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the service appointment. The possible values are: • Read • Edit • All (This value isn’t valid for create or update calls.) Set to an access level that is at least equal to the organization’s default service appointment access level.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The service appointment associated with the sharing entry.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The reason why this sharing entry exists. You can write to this field only when its value is omitted or set to Manual (default). Valid values include: • Manual—The user or group has access because a user with “All” access manually shared the service appointment. • Owner—The user is the owner of the service appointment. • Team—The user or group has team access. • Rule—The user or group has access via a service appointment sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description (Read only) ID of the user or group that has access to the service appointment.
1707
Standard Objects
ServiceChannel
ServiceChannel Represents a channel of work items that are received from your organization—for example, cases, chats, or leads. This object is available in API version 32.0 and later.
Supported Calls create(), query(), retrieve(), update(), upsert()
Fields Field
Details
CapacityPercentage
Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage of an agent’s capacity for work items that’s consumed by a specific type of work item from this service channel. For example, you might give phone calls a capacity percentage of 100. If an agent receives a phone call, the agent won’t receive new work items until the call ends, because at that point the agent’s capacity will have reached 100%. This field is available in API version 32.0 and earlier. For later API versions, you can set the capacity percentage of work items on the QueueRoutingConfig object.
CapacityWeight
Type double Properties Create, Filter, Nillable, Sort, Update Description The amount of an agent’s capacity for work items that’s consumed by a work item from this service channel. For example, if an agent has a capacity of 6, and cases are assigned a capacity weight of 2, an agent can be assigned up to 3 cases before the agent is at capacity and can’t receive new work items. This field is available in API version 32.0 and earlier. For later API versions, you can set the capacity weight of work items on the QueueRoutingConfig object.
DeveloperName
Type string Properties Create, Filter, Group, Sort, Update
1708
Standard Objects
Field
ServiceChannelStatus
Details 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. Note: 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.
Language
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the service channel.
MasterLabel
Type string Properties Create, Filter, Group, Sort, Update Description The label of the service channel.
RelatedEntity
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Unique, Update Description The type of object that’s associated with this service channel.
ServiceChannelStatus Represents the status that’s associated with a specific service channel. This object is available in API version 32.0 and later.
Supported Calls create(), delete(), query(), retrieve(), update()
1709
Standard Objects
ServiceContract
Fields Field
Details
ServiceChannelId
Type reference Properties Create, Filter, Group, Sort Description The ID of the service channel.
ServicePresenceStatusId Type
reference Properties Create, Filter,Group, Nillable, Sort Description The ID of the presence status that’s associated with the service channel that’s specified by the ServicePresenceChannelId.
ServiceContract Represents a customer support contract (business agreement). This object is available in API version 18.0 and later.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field
Details
AccountId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the account associated with the service contract.
ActivationDate
Type dateTime
1710
Standard Objects
Field
ServiceContract
Details Properties Filter, Nillable, Sort Description The initial day the service contract went into effect (whereas StartDate may include a renewal date).
ApprovalStatus
Type picklist Properties Defaulted on create, Filter, Group, Nillable, Sort Description Approval status of the service contract.
BillingAddress (beta)
Type address Properties Filter, Nillable Description The compound form of the billing address. Read-only. See Address Compound Fields for details on compound address fields.
BillingCity
Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address. Maximum size is 40 characters.
BillingCountry
Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address. Maximum size is 40 characters.
BillingCountryCode
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the service contract’s billing address.
1711
Standard Objects
ServiceContract
Field
Details
BillingLatitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
BillingLongitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
BillingPostalCode
Type string Properties Filter, Group, Nillable, Sort Description Details for the billing address. Maximum size is 20 characters.
BillingState
Type string Properties Group, Sort, Filter, Nillable Description Details for the billing address. Maximum size is 20 characters.
BillingStateCode
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code for the service contract’s billing address.
BillingStreet
Type textarea Properties Filter, Group, Nillable, Sort
1712
Standard Objects
Field
ServiceContract
Details Description Street address for the billing address.
ContactId
Type reference Properties Filter, Group, Nillable, Sort Description Required. ID of the Contact associated with the service contract. Must be a valid ID.
ContractNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description Unique number automatically assigned to the service contract.
Description
Type textarea Properties Nillable Description Description of the service contract.
Discount
Type percent Properties Filter, Nillable, Sort Description The last day the service contract is in effect. Weighted average of all contract line item discounts on the service contract.
EndDate
Type date Properties Filter, Group, Nillable, Sort Description The last day the service contract is in effect.
GrandTotal
Type currency
1713
Standard Objects
Field
ServiceContract
Details Properties Filter, Nillable, Sort Description Total price of the service contract plus shipping and taxes.
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
LastReferencedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
LineItemCount
Type int Properties Filter, Nillable, Group, Sort Description Number of ContractLineItem records associated with the service contract.
Name
Type string Properties Create, Filter, Group, Sort, Update Description Name of the service contract.
1714
Standard Objects
ServiceContract
Field
Details
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns the service contract.
ParentServiceContractId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service contract’s parent service contract, if it has one.
Pricebook2Id
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Pricebook2 associated with the service contract. Must be a valid ID.
RootServiceContractId
Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The top-level service contract in a service contract hierarchy. Depending on where a service contract lies in the hierarchy, its root could be the same as its parent.
ShippingAddress (beta)
Type address Properties Filter, Nillable Description The compound form of the shipping address. Read-only. See Address Compound Fields for details on compound address fields.
ShippingCity
Type string Properties Filter, Group, Nillable, Sort
1715
Standard Objects
Field
ServiceContract
Details Description Details of the shipping address. Maximum size is 40 characters.
ShippingCountry
Type string Properties Filter, Group, Nillable, Sort Description Details of the shipping address. Country maximum size is 40 characters.
ShippingCountryCode
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code for the service contract’s shipping address.
ShippingLatitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
ShippingLongitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
ShippingPostalCode
Type string Properties Create, Filter, Nillable, Update Description Details of the shipping address. Postal code maximum size is 20 characters.
1716
Standard Objects
ServiceContract
Field
Details
ShippingState
Type string Properties Create, Filter, Nillable, Update Description Details of the shipping address. State maximum size is 20 characters.
ShippingStateCode
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code for the service contract’s shipping address.
ShippingStreet
Type textarea Properties Create, Filter, Nillable, Update Description The street address of the shipping address. Maximum of 255 characters.
SpecialTerms
Type textarea Properties Create, Nillable, Update Description Any terms specifically agreed to and tracked in the service contract.
StartDate
Type date Properties Create, Filter, Nillable, Update Description The first day the service contract is in effect.
Status
Type picklist Properties Filter, Nillable Description The status of the service contract, such as Inactive.
1717
Standard Objects
ServiceContract
Field
Details
Subtotal
Type currency Properties Filter, Nillable Description Total of the service contract line items (products) before discounts, taxes, and shipping are applied.
Tax
Type currency Properties Create, Filter, Nillable, Update Description Total taxes for the service contract.
Term
Type int Properties Create, Filter, Nillable, Update Description Number of months that the service contract is valid.
TotalPrice
Type currency Properties Filter, Nillable Description Total of the contract line items (products) after discounts and before taxes and shipping.
Usage Use this object to query and manage service contracts. SEE ALSO: ServiceContractHistory ServiceContractShare ServiceContractOwnerSharingRule
1718
Standard Objects
ServiceContractFeed
ServiceContractFeed Represents a single feed item in the feed displayed on the detail page for a service contract record. This object is available in API version 23.0 and later. A service contract feed shows recent changes to a service contract for any fields that are tracked in feeds, and comments and posts about the record. It's a useful way to stay up-to-date with changes to service contracts.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the ServiceContract object • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content for the ServiceContractFeed. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item. Tip: In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only
1719
Standard Objects
Field Name
ServiceContractFeed
Details one. In a moderated feed, your comment isn’t counted until it's approved by an admin or a person with “CanApproveFeedPostAndComment” or “ModifyAllData” permission. This has implications for how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until end of comments is returned.
ConnectionId
Type reference Properties Filter, Group, Nillable, Sort Description When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The file uploaded to the feed. Required if Type is ContentPost. Setting ContentFileName automatically sets Type to ContentPost.
1720
Standard Objects
ServiceContractFeed
Field Name
Details
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if a client application migrates multiple posts and comments from another application into a feed, InsertedById is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • •
1721
Standard Objects
Field Name
ServiceContractFeed
Details • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LastModifiedDate
Type dateTime Properties Defaulted on create, Filter, Sort Description This field is a standard system field. When a feed item is created, LastModifiedDate is the same as CreatedDate. If a FeedComment is inserted on the feed item, then LastModifiedDate becomes the CreatedDate for the FeedComment. Deleting the FeedComment does not change the LastModifiedDate. Ordering by LastModifiedDate DESC sorts the feed by both the most recent feed item or comment.
LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
1722
Standard Objects
ServiceContractFeed
Field Name
Details
NetworkScope
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. NetworkScope can have the following values:
• NetworkId—The ID of the community in which the FeedItem is available. If left empty, the feed item is only available in the default community. • AllNetworks—The feed item is available in all communities. Note the following exceptions for NetworkScope: • Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks. • You can’t filter a FeedItem on the NetworkScope field. ParentId
Type reference Properties Filter, Group, Sort Description ID of the service contract record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost. For example, set this field to an existing ContentVersion and post it to a feed as a ServiceContractFeed object of Type ContentPost.
Title
Type string Properties Group, Nillable, Sort
1723
Standard Objects
Field Name
ServiceContractFeed
Details Description Title of the ServiceContractFeed. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of ServiceContractFeed: • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply.
1724
Standard Objects
Field Name
ServiceContractFeed
Details • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • AttachArticleEvent—generated event when a user attaches an article to a case. • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • CaseCommentPost—generated event when a user adds a case comment for a case object. • ChangeStatusPost—generated event when a user changes the status of a case. • ChatTranscriptPost—generated event when Live Agent transcript is saved to a case. • EmailMessageEvent—generated event when an email related to a case object is sent or received. • FacebookPost—generated when a Facebook post is created from a case. Deprecated. • MilestoneEvent—generated when a case milestone is completed or reaches violation status. • SocialPost—generated when a social post is created from a case.
Visibility
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. Visibility can have the following values:
• AllUsers—The feed item is available to all users who have permission to see the feed item. • InternalUsers—The feed item is available to internal users only. Note the following exceptions for Visibility: • For record posts, Visibility is set to InternalUsers for all internal users by default.
1725
Standard Objects
Field Name
ServiceContractHistory
Details • External users can set Visibility only to AllUsers. • Visibility can be updated on record posts. • The Update property is supported only for feed items posted on records.
Usage Use this object to track changes for a service contract record. SEE ALSO: ServiceContract ServiceContractHistory ServiceContractOwnerSharingRule FeedItem
ServiceContractHistory Represents the history of changes to the values in the fields on a ServiceContract (customer support agreement). This object is available in API version 18.0 and later.
Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field
Details
Field
Type picklist Properties Filter, Restricted picklist Description The name of the field that was changed.
IsDeleted
Type boolean Properties Defaulted on create, Filter
1726
Standard Objects
Field
ServiceContractOwnerSharingRule
Details Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
NewValue
Type anyType Properties Nillable Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable Description The latest value of the field before it was changed.
ServiceContractId
Type reference Properties Filter Description Required. ID of the ServiceContract.
Usage Use this object to identify changes to a service contract. This object respects field level security on the parent object. SEE ALSO: ServiceContract ServiceContractShare ServiceContractOwnerSharingRule
ServiceContractOwnerSharingRule Represents the rules for sharing a ServiceContract (customer service agreement) with users other than the owner. This object is available in API version 18.0 and later.
1727
Standard Objects
ServiceContractOwnerSharingRule
Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer support to enable access to this object for your org.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Sort, Update Description A value that represents the type of sharing allowed. The possible values are: • Read • Edit
Description
Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later.
DeveloperName
Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update 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. Corresponds to Rule Name in the user interface. This field is available in API version 24.0 and later.
1728
Standard Objects
Field Name
ServiceContractShare
Details Note: 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.
GroupId
Type reference Properties Create, Filter, Group, Sort, Description The ID representing the source group. Service contracts owned by users in the source group trigger the rule to give access.
Name
Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to Label in the user interface.
UserorGroupId
Type reference Properties Create, Filter Description The ID representing the target user or group. Target users or groups are given access.
Usage Use this object to manage the sharing rules for a service contract. General sharing and territory management-related sharing use this object. SEE ALSO: ServiceContract ServiceContractShare ServiceContractHistory Metadata API Developer Guide: SharingRules
ServiceContractShare Represents a sharing entry on a ServiceContract (customer support agreement). This object is available in API version 18.0 and later.
1729
Standard Objects
ServiceContractShare
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Sort, Update Description Level of access that the User or Group has to the ServiceContract. The possible values are: • Read • Edit • All (This value is not valid for create or update calls.) This field must be set to an access level that is higher than the organization’s default access level for service contracts.
ParentId
Type reference Properties Create, Filter Description ID of the parent object, if any.
RowCause
Type picklist Properties Create, Filter, Defaulted on create, Restricted picklist Description Reason that this sharing entry exists. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Values may include: • Manual—The User or Group has access because a user with “All” access manually shared the ServiceContract with them. • Owner—The User is the owner of the ServiceContract or is in a role above the service contract owner in the role hierarchy.
1730
Standard Objects
ServicePresenceStatus
Field
Details
UserOrGroupId
Type reference Properties Create, Filter Description ID of the User or Group that has been given access to the ServiceContract.
Usage This object allows you to determine which users and groups can view and edit ServiceContract records owned by other users. If you attempt to create a new record that matches an existing record, the create call updates any modified fields and returns the existing record. SEE ALSO: ServiceContract ServiceContractHistory ServiceContractOwnerSharingRule
ServicePresenceStatus Represents a presence status that can be assigned to a service channel. This object is available in API version 32.0 and later.
Supported Calls create(), delete(), query(), retrieve(), update(), upsert()
Fields Field
Details
DeveloperName
Type string Properties Create, Filter, Group, Sort, Update 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.
1731
Standard Objects
Field
ServiceReport
Details Note: 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.
Language
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the presence status.
MasterLabel
Type string Properties Create, Filter, Group, Sort, Update Description The label of the presence status.
ServiceReport Represents a report that summarizes a work order, work order line item, or service appointment. The fields that appear on a service report are determined by its service report template. Service reports can be signed by the customer and shared as a PDF.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete()
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
ContentVersionDocumentId
Type reference Properties Filter, Group, Nillable, Sort
1732
Standard Objects
Field Name
ServiceReport
Details Description ID of the service report version, used for storage.
DocumentBody
Type base64 Properties Create, Nillable Description The report output.
DocumentContentType
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of data used for the report output: application/pdf.
DocumentLength
Type int Properties Filter, Group, Nillable, Sort Description The length of the report output.
DocumentName
Type string Properties Create, Filter, Group, Nillable, Sort Description The name of the report output, always set to Service Report.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The ID of the service appointment, work order, or work order line item that the service report summarizes. For example, if you click Create Service Report on a service appointment, this field lists the service appointment’s record ID.
ServiceReportNumber
Type string
1733
Standard Objects
Field Name
ServiceResource
Details Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-generated number identifying the service report.
Template
Type string Properties Create, Filter, Group, Nillable, Sort Description The service report template used to generate the service report. Note: If the person creating the service report doesn’t have access to certain objects or fields that are included in the service report template, those fields won’t be visible in the report they create.
ServiceResource Represents a service technician or dispatcher in field service. This object is available in API version 38.0 and later.
Supported Calls create(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),search(),update(),upsert()
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Description
Type textarea Properties Create, Nillable, Update Description The description of the resource.
IsActive
Type boolean
1734
Standard Objects
Field Name
ServiceResource
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update Description When selected, this option means that the resource can be assigned to work orders. For service tracking purposes, resources can’t be deleted, so deactivating a resource is the best way to send them into retirement.
IsCapacityBased
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Capacity-based resources are limited to a certain number of hours or appointments in a specified time period. Tip: The Capacities related list shows a resource’s capacity.
IsOptimizationCapable
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description When selected, this option means that the service scheduling optimizer can assign this resource to work orders during the optimization process. Use only if the Field Service Lightning managed packages are installed. Its label in the user interface is Include in Scheduling Optimization. Only users with the “Field Service Scheduling” permission set license can be included in scheduling optimization.
LastKnownLatitude
Type double Properties Create, Filter, Nillable, Sort, Update Description The latitude of the last known location.
LastKnownLongitude
Type double Properties Create, Filter, Nillable, Sort, Update Description The longitude of the last known location.
1735
Standard Objects
ServiceResource
Field Name
Details
LastKnownLocation
Type location Properties Nillable Description The service resource’s last known location. You can configure this field to display data collected from a custom mobile app. This field is not visible in the user interface, but you can expose it on service resource page layouts or set up field tracking to be able to view a resource’s location history.
LastKnownLocationDate
Type dateTime Properties Filter, Nillable, Sort Description The date and time of the last known location.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the service resource was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the service resource was last viewed.
Name
Type string Properties Create, Filter, Group, Sort, Update Description The resource’s name. You’ll likely want this to be the name or title of the associated user.
OwnerId
Type reference
1736
Standard Objects
Field Name
ServiceResourceCapacity
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the service resource.
RelatedRecordId
Type reference Properties Create, Filter, Group, Sort Description The associated user.
ResourceType
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether a resource is a technician or a dispatcher. Resources who are dispatchers can’t be capacity-based or included in scheduling optimization. Only users with the “Field Service Dispatcher” permission set license can be dispatchers. Note: You can’t add additional resource types.
Usage View service resources on the Service Resources tab. In addition: • Service resources that are assigned to a service appointment appear in the Assigned Resources related list on the appointment detail page. You can assign multiple service resources to an appointment. • Service resources that belong to a service territory appear in the Service Territory Members related list on the territory detail page. For tracking purposes, service resources can only be deactivated, not deleted. To deactivate a service resource, deselect Active on their detail page. Deactivating a user deactivates the related service resource. You can’t create a service resource that is linked to an inactive user.
ServiceResourceCapacity Represents the maximum number of scheduled hours or number of service appointments that a capacity-based service resource can complete within a specific time period. This object is available in API version 38.0 and later.
1737
Standard Objects
ServiceResourceCapacity
Supported Calls create(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert()
Fields Field Name
Details
CapacityInHours
Type double Properties Create, Filter, Nillable, Sort, Update Description The number of hours that the resource can work per time period. You must fill out this field, the CapacityInWorkItems field, or both.
CapacityInWorkItems
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of service appointments that the resource can complete per time period. You must fill out this field, the CapacityInHours field, or both.
CapacityNumber
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description (Read only) An auto-generated number identifying the capacity record.
EndDate
Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the capacity ends; for example, the end date of a contract.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort
1738
Standard Objects
Field Name
ServiceResourceCapacity
Details Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
ServiceResourceId
Type reference Properties Create, Filter, Group, Sort Description The associated service resource.
StartDate
Type date Properties Create, Filter, Group, Sort Description The date the capacity goes into effect.
TimePeriod
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Days, Hours, or Months. For example, if a resource can work 80 hours per month, the capacity’s Time Period would be Month and Hours per Time Period would be 80.
Usage Service resources who are capacity-based can only work a certain number of hours or complete a certain number of service appointments within a specified time period. Contractors tend to be capacity-based. To indicate that a service resource is capacity-based, select Capacity-Based on the service resource detail page, then define their capacity in the Capacities related list: 1. Click New Resource Capacity.
1739
Standard Objects
ServiceResourceCapacityFeed
2. Enter a start date and an end date to indicate when the capacity is in effect for the resource. For example, if the capacity represents a six-month contract, enter the contract’s start and end dates. 3. Specify how much the resource can work: • Select the Time Period that the capacity is based on: hours, days, or months. For example, if the resource can work 80 hours per month, select Month. • If you want the resource’s capacity to be based on the number of hours worked, fill out Hours per Time Period. For example, if the resource can work 80 hours per month, enter 80. • If you want the resource’s capacity to be based on the number of service appointments they are assigned to, fill out Work Items per Time Period. For example, if the resource can complete 20 appointments per month, enter 20. Note: You must fill out at least one of these fields: Work Items per Time Period and Hours per Time Period. If you’re using the Field Service Lightning managed packages and would like to measure capacity both in hours and in number of work items, enter a value for both. The resource is considered to reach their capacity based on whichever term is met first—hours or number of work items. 4. Click Save. You can set multiple capacities for a resource as long as their start and end dates do not overlap. Important: If you aren’t using the Field Service Lightning managed packages, capacity serves more as a suggestion than a rule. Resources can still be as scheduled beyond their capacity, and you aren’t notified when a resource exceeds their capacity.
ServiceResourceCapacityFeed Represents a single feed item on a service resource capacity record detail page. This object is available in API version 38.0 and later. A service resource capacity feed shows changes to tracked fields on a service resource capacity record. It also shows posts and comments about the record. It’s a useful way to stay up to date with changes made to service resource capacities in Salesforce.
Supported Calls delete(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Operating Hours object • “Moderate Chatter”
Fields Field Name
Details
Body
Type textarea
1740
Standard Objects
Field Name
ServiceResourceCapacityFeed
Details Properties Nillable, Sort Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort
1741
Standard Objects
Field Name
ServiceResourceCapacityHistory
Details Description The URL of a link post.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the service resource capacity record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the Link URL is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
ServiceResourceCapacityHistory Represents the history of changes made to tracked fields on a service resource capacity record. This object is available in API version 38.0 and later.
1742
Standard Objects
ServiceResourceCapacityHistory
Supported Calls getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and field tracking for service resource capacity fields must be configured.
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
ServiceResourceCapacityId
Type reference Properties Filter, Group, Sort Description ID of the service resource capacity being tracked. The history is displayed on the detail page for this record.
1743
Standard Objects
ServiceResourceFeed
ServiceResourceFeed Represents a single feed item on a service resource record detail page. This object is available in API version 38.0 and later. A service resource feed shows changes to tracked fields on a service resource record. It also shows posts and comments about the record. It’s a useful way to stay up to date with changes made to service resources in Salesforce.
Supported Calls delete(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the ServiceResource object • “Moderate Chatter”
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort
1744
Standard Objects
Field Name
ServiceResourceFeed
Details Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a link post.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the service resource record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
1745
Standard Objects
ServiceResourceHistory
Field Name
Details
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the LinkURL field is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
ServiceResourceHistory Represents the history of changes made to tracked fields on a service resource. This object is available in API version 38.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType
1746
Standard Objects
ServiceResourceOwnerSharingRule
Field Name
Details Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
ServiceResourceId
Type reference Properties Filter, Group, Sort Description ID of the service resource being tracked. The history is displayed on the detail page for this record.
ServiceResourceOwnerSharingRule Represents the rules for sharing a service resource with user records other than the owner or anyone above the owner in the role hierarchy. This object is available in API version 38.0 and later. Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer support to enable access to this object for your org.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Fields Field
Details
Description
Type textarea Properties Create, Filter, Nillable, Sort, Update
1747
Standard Objects
Field
ServiceResourceOwnerSharingRule
Details Description A description of the sharing rule. Maximum size is 1000 characters.
DeveloperName
Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update 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. Corresponds to Rule Name in the user interface. Note: 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.
GroupId
Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. A service resource owned by a User in the source Group triggers the rule to give access.
Name
Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to Label on the user interface.
ServiceResourceAccessLevel Type
picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target Group, or UserRole. The possible values are: • Read
1748
Standard Objects
Field
ServiceResourceShare
Details • Edit • All
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description The ID representing the User or Group being granted access.
ServiceResourceShare Represents a sharing entry on a service resource. This object is available in API version 38.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the service resource. The possible values are: • Read • Edit • All (This value isn’t valid for create or update calls.) Set to an access level that is at least equal to the organization’s default service resource access level.
1749
Standard Objects
ServiceResourceSkill
Field Name
Details
ParentId
Type reference Properties Create, Filter, Group, Sort Description The service resource associated with the sharing entry.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The reason why this sharing entry exists. You can write to this field only when its value is omitted or set to Manual (default). Valid values include: • Manual—The user or group has access because a user with “All” access manually shared the service resource. • Owner—The user is the owner of the service resource. • Team—The user or group has team access. • Rule—The user or group has access via a service resource sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description (Read only) ID of the user or group that has access to the service resource.
ServiceResourceSkill Represents a skill that a service resource possesses. This object is available in API version 38.0 and later.
Supported Calls create(),delete(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),search(),update(),upsert()
Special Access Rules Field Service Lightning must be enabled.
1750
Standard Objects
ServiceResourceSkill
Fields Field Name
Details
EffectiveEndDate
Type date Properties Create, Filter, Nillable, Sort, Update Description The date when the skill expires. For example, if a service resource needs to be re-certified after six months, the end date would be the date their certification expires.
EffectiveStartDate
Type date Properties Create, Filter, Sort, Update Description The date when the service resource gains the skill. For example, if the skill represents a certification, the start date would be the date of certification.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the resource skill was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the resource skill was last viewed.
ServiceResourceId
Type reference Properties Create, Filter, Group, Sort Description The service resource who possesses the skill.
1751
Standard Objects
ServiceResourceSkillFeed
Field Name
Details
SkillId
Type reference Properties Create, Filter, Group, Sort, Update Description The skill the service resource possesses.
SkillLevel
Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The service resource’s skill level. Skill level can range from zero to 99.99.
SkillNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-generated number identifying the resource skill assignment.
Usage You can assign skills to all service resources in your org to indicate their certifications and areas of expertise, and specify each resource’s skill level from 0 to 99.99. For example, you can assign Maria the “Welding” skill, level 50. If you intend to use the skills feature, determine which skills you want to track and how skill level should be determined. For example, you may want the skill level to reflect years of experience, certification levels, or license classes.
ServiceResourceSkillFeed Represents a single feed item on a service resource skill record detail page. This object is available in API version 38.0 and later. A service resource skill feed shows changes to tracked fields on a service resource skill record. It also shows posts and comments about the record. It’s a useful way to stay up to date with changes made to service resource skills in Salesforce.
Supported Calls delete(), getDeleted(), getUpdated(), query(), retrieve()
1752
Standard Objects
ServiceResourceSkillFeed
Special Access Rules Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Operating Hours object • “Moderate Chatter”
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
1753
Standard Objects
ServiceResourceSkillFeed
Field Name
Details
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a link post.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the service resource skill record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the Link URL is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort
1754
Standard Objects
Field Name
ServiceResourceSkillHistory
Details Description The type of feed item.
ServiceResourceSkillHistory Represents the history of changes made to tracked fields on a service resource skill. This object is available in API version 38.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
1755
Standard Objects
ServiceTerritory
Field Name
Details
ServiceResourceSkillId
Type reference Properties Filter, Group, Sort Description ID of the resource skill being tracked. The history is displayed on the detail page for this record.
ServiceTerritory Represents a region in which field service work can be performed. This object is available in API version 38.0 and later.
Supported Calls create()delete() , describeLayout() , describeSObjects() , getDeleted() , getUpdated() , query() , retrieve() , search() , undelete() , update() , upsert() ,
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Address
Type address Properties Filter Description An address to associate with the territory. You may want to list the address of the territory’s headquarters.
City
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the associated address. Maximum length is 40 characters.
Country
Type string
1756
Standard Objects
Field Name
ServiceTerritory
Details Properties Create, Filter, Group, Nillable, Sort, Update Description The country to associate with the territory. Maximum length is 80 characters.
Description
Type textarea Properties Create, Nillable, Update Description The description of the territory.
GeocodeAccuracy
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. Note: This field is available in the API only.
IsActive
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the service territory is meant to be used. If a territory is inactive, you can’t add members to it or link it to work orders, work order line items, or service appointments.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the territory was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate
Type dateTime
1757
Standard Objects
Field Name
ServiceTerritory
Details Properties Filter, Nillable, Sort Description The date when the territory was last viewed.
Latitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address associated with the territory. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. Note: This field is available in the API only.
Longitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address associated with the territory. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. Note: This field is available in the API only.
Name
Type string Properties Create, Filter, Group, Sort, Update Description The name of the territory.
OperatingHoursId
Type reference Properties Create, Filter, Group, Sort, Update Description The territory’s operating hours, which indicate when service appointments within the territory can occur. Service resources who are members of a territory automatically inherit the territory’s operating hours unless different hours are specified on the resource record.
1758
Standard Objects
ServiceTerritory
Field Name
Details
ParentTerritoryId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The territory’s parent service territory, if it has one. For example, a Northern California territory can have a State of California territory as its parent. A service territory hierarchy can contain up to 500 territories.
PostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address associated with the territory. Maximum length is 20 characters.
State
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address associated with the territory. Maximum length is 80 characters.
Street
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name of the address associated with the territory.
TopLevelTerritoryId
Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The top-level territory in a hierarchy of service territories. Depending on where a territory lies in the hierarchy, its top-level territory might be the same as its parent.
1759
Standard Objects
ServiceTerritoryFeed
Usage View service territories on the Service Territories tab. You can also view a service resource’s territories on the Service Territories related list on the resource detail page. If you want to use service territories, determine which territories you need to create. Depending on how your business works, you may decide to create territories based on cities, counties, or other factors. If you plan to build out a hierarchy of service territories, create the highest-level territories first. Create service territories from the Service Territories tab in Salesforce. After you create a territory, you can add members to it via the Service Territory Members related list. Service territory members are resources who work within the territory, and associating them with a territory ensures that they’re assigned to appointments near their home base. For example, you can create a hierarchy of territories to represent the areas where your team works in California. Include a top-level territory named California, three child territories named Northern California, Central California, and Southern California, and a series of third-level territories corresponding to California counties. Assign service resources to each county territory to indicate who is available to work in that county.
ServiceTerritoryFeed Represents a single feed item on a service territory record detail page. This object is available in API version 38.0 and later. A service territory feed shows changes to tracked fields on a service territory record. It also shows posts and comments about the record. It’s a useful way to stay up to date with changes made to service territories in Salesforce.
Supported Calls delete(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Operating Hours object • “Moderate Chatter”
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
1760
Standard Objects
ServiceTerritoryFeed
Field Name
Details
CommentCount
Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a link post.
ParentId
Type reference Properties Filter, Group, Sort
1761
Standard Objects
Field Name
ServiceTerritoryHistory
Details Description ID of the service territory record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the Link URL is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
ServiceTerritoryHistory Represents the history of changes made to tracked fields on a service territory. This object is available in API version 38.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled.
1762
Standard Objects
ServiceTerritoryMember
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
ServiceTerritoryId
Type reference Properties Filter, Group, Sort Description ID of the service territory being tracked. The history is displayed on the detail page for this record.
ServiceTerritoryMember Represents a service resource who is able to be assigned to service appointments in the service territory. This object is available in API version 38.0 and later.
Supported Calls create(),delete(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),search(),update(),upsert()
1763
Standard Objects
ServiceTerritoryMember
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Address
Type address Properties Filter Description The member’s address. You may want to list the related service resource’s address in this field.
City
Type string Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The city of the member’s address. Maximum length is 40 characters.
Country
Type string Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The country of the member’s address. Maximum length is 80 characters.
EffectiveEndDate
Type date Properties Create, Filter, Nillable, Sort, Update Description The date when the service resource is no longer a member of the territory. If the resource will be working in the territory for the foreseeable future, leave this field blank. This field is mainly useful for indicating when a temporary relocation ends.
EffectiveStartDate
Type date Properties Create, Filter, Sort, Update
1764
Standard Objects
Field Name
ServiceTerritoryMember
Details Description The date when the service resource becomes a member of the service territory.
GeocodeAccuracy
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. Note: This field is available in the API only.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the territory member was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the territory member was last viewed.
Latitude
Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the member’s address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. Note: This field is available in the API only.
Longitude
Type double
1765
Standard Objects
Field Name
ServiceTerritoryMember
Details Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the member’s address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. Note: This field is available in the API only.
MemberNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description (Read only) An auto-generated number identifying the service territory member.
OperatingHoursId
Type reference Properties Create, Filter, Group, Sort, Nillable, Update Description The operating hours assigned to the service territory member. If no operating hours are specified, the member is assumed to use their parent service territory’s operating hours. If a member needs special operating hours, create them in Setup and select them in the Operating Hours lookup field on the member’s detail page.
PostalCode
Type string Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The postal code of the member’s address. Maximum length is 20 characters.
ServiceResourceId
Type reference Properties Create, Filter, Group, Sort, Update Description The service resource assigned to the service territory.
ServiceTerritoryId
Type reference
1766
Standard Objects
Field Name
ServiceTerritoryMember
Details Properties Create, Filter, Group, Sort Description The service territory that the service resource is assigned to.
State
Type string Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The state of the member’s address. Maximum length is 80 characters.
Street
Type textarea Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The street number and name of the member’s address.
TerritoryType
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Primary, Secondary, or Relocation. • The primary territory is typically the territory where the resource works most often—for example, near their home base. Service resources can only have one primary territory. • Secondary territories are territories where the resource can be assigned to appointments if needed. Service resources can have multiple secondary territories. • Relocation territories represent temporary moves for service resources. If you’re using the Field Service Lightning managed packages with the scheduling optimizer, resources with relocation territories are always assigned to services within their relocation territories during the specified relocation dates; if they don’t have a relocation territory, the primary territories are favored over the secondary. For example, a service resource might have the following territories: • Primary territory: West Chicago • Secondary territories: – East Chicago
1767
Standard Objects
Field Name
ServiceTerritoryMemberFeed
Details – South Chicago • Relocation territory: Manhattan, for a three-month period
Usage If you delete a service territory with members, the service resources who were members no longer have any connection to the territory.
ServiceTerritoryMemberFeed Represents a single feed item on a service territory member record detail page. This object is available in API version 38.0 and later. A service territory member feed shows changes to tracked fields on a service territory member record. It also shows posts and comments about the record. It’s a useful way to stay up to date with changes made to service territory members in Salesforce.
Supported Calls delete(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Operating Hours object • “Moderate Chatter”
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int
1768
Standard Objects
Field Name
ServiceTerritoryMemberFeed
Details Properties Filter, Group, Sort Description The number of comments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a link post.
ParentId
Type reference Properties Filter, Group, Sort
1769
Standard Objects
Field Name
ServiceTerritoryMemberHistory
Details Description ID of the service territory member record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the Link URL is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
ServiceTerritoryMemberHistory Represents the history of changes made to tracked fields on a service territory member. This object is available in API version 38.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled.
1770
Standard Objects
SessionPermSetActivation
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
ServiceTerritoryMemberId
Type reference Properties Filter, Group, Sort Description ID of the service territory member being tracked. The history is displayed on the detail page for this record.
SessionPermSetActivation The SessionPermSetActivation object represents a permission set assignment activated during an individual user session. When a SessionPermSetActivation object is inserted into a permission set, an activation event fires, allowing the permission settings to apply to the user’s specific session. This object is available in API versions 37.0 and later.
Supported Calls describeCompactLayouts(), describeLayout(), query(), retrieve()
1771
Standard Objects
SessionPermSetActivation
Fields Field Name
Details
AuthSessionId
Type reference Properties Filter, Group, Sort Description The session ID related to this permission set assignment for its duration.
Description
Type string Properties Filter, Group, Nillable, Sort Description The session details, such as device used and browser.
PermissionSetId
Type reference Properties Filter, Group, Sort Description The permission set ID related to this permission set assignment and user for its duration.
UserId
Type reference Properties Filter, Group, Sort Description The user ID of the user to whom this permission set assignment applies for its duration.
Usage Use SessionPermSetActivation to create a permission set available only for a specified session’s duration. For example, create permission sets that provide access to specific applications only during authenticated sessions. In the following Apex example, an identified session is activated after session information is submitted via a button. Successful activation results in a confirmation message displayed to the user. public class SessionPermSetActivationController { // id of the session permission set to be activated
1772
Standard Objects
SetupAuditTrail
private final String sessionPermSetId = '0PSxx00000004rJ'; private final String sessionId; public SessionPermSetActivationController() { Map sessionManagement = Auth.SessionManagement.getCurrentSession(); sessionId = sessionManagement.get('SessionId'); } public PageReference activate() { // activate the permission set SessionPermSetActivation activation = new SessionPermSetActivation(); activation.AuthSessionId = sessionId; activation.PermissionSetId = sessionPermSetId; activation.Description = 'created by SessionPermSetActivationController'; insert activation; return null; } public boolean getActivated() { Integer alreadyActivated = [SELECT count() FROM SessionPermSetActivation WHERE AuthSessionId = :sessionId And PermissionSetId = :sessionPermSetId 1]; return alreadyActivated > 0; } }
LIMIT
Activate Session Permission Set
Session Permission Set is already active.
SetupAuditTrail Represents changes you or other admins made in your org’s Setup area for at least the last 180 days. This object is available in API version 15.0 and later. Note: SetupAuditTrail is not a supported standard controller. Using SetupAuditTrail as a standard controller in a Visualforce page results in an error.
1773
Standard Objects
SetupAuditTrail
Supported Calls query(), retrieve()
Note: Aggregate queries aren’t supported on this object. For example, SELECT count() FROM SetupAuditTrail works but SELECT count(Id) FROM SetupAuditTrail fails.
Fields Field
Details
Action
Type string Properties Filter, Sort Description The category of the change made in Setup. For example, a value of PermSetCreate indicates that an administrator created a permission set. The Display field contains more specific information.
DelegateUser
Type string Properties Filter, Nillable, Sort Description The Login-As user who executed the action in Setup. If a Login-As user didn’t perform the action, this field is blank. This field is available in API version 35.0 and later.
Display
Type string Properties Nillable, Sort Description The full description of changes made in Setup. For example, if the Action field has a value of PermSetCreate, the Display field has a value like “Created permission set MAD: with user license Salesforce.”
Section
Type string Properties Nillable, Sort Description The section in the Setup menu where the action occurred. For example, Manage Users or Company Profile.
1774
Standard Objects
SetupEntityAccess
Note: You can use SOQL joins to get the information you need more quickly. For example, running SELECT CreatedBy.Name FROM SetupAuditTrail LIMIT 10 returns the first and last names of the last 10 people to make changes in Setup.
SetupEntityAccess Represents the enabled setup entity access settings (such as for Apex classes) for the parent PermissionSet. This object is available in API version 25.0 and later. To grant users access to an entity, associate the appropriate SetupEntityAccess record with a PermissionSet that’s assigned to a user.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve()
Fields Field Name
Details
ParentId
Type reference Properties Create, Filter, Group, Sort Description The ID of the entity’s parent PermissionSet.
SetupEntityId
Type reference Properties Create, Filter, Group, Sort Description The ID of the entity for which access is enabled, such as an Apex class or Visualforce page.
SetupEntityType
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of setup entity for which access is enabled. Valid values are: • ApexClass for Apex classes • ApexPage for Visualforce pages • In API version 28.0 and later, ConnectedApplication for OAuth connected apps • In API version 31.0 and later, CustomPermission for custom permissions
1775
Standard Objects
Field Name
SetupEntityAccess
Details • In API version 28.0 and later, ServiceProvider for service providers • In API version 28.0 and later, TabSet for apps
Usage Because SetupEntityAccess is a child of the PermissionSet object, the usage is similar to other PermissionSet child objects like FieldPermissions and ObjectPermissions. For example, the following code returns all permission sets that grant access to any setup entities for which access is enabled: SELECT Id, ParentId, Parent.Name, SetupEntityId FROM SetupEntityAccess
The following code returns permission sets that grant access only to Apex classes: SELECT Id, ParentId, Parent.Name, SetupEntityId FROM SetupEntityAccess WHERE SetupEntityType='ApexClass'
The following code returns permission sets that grant access to any setup entities, and are not owned by a profile: SELECT Id, ParentId, Parent.Name, SetupEntityId FROM SetupEntityAccess WHERE ParentId IN (SELECT Id FROM PermissionSet WHERE isOwnedByProfile = false)
You may want to return only those permission sets that have access to a specific setup entity. To do this, query the parent object. For example, this code returns all permission sets that grant access to the helloWorld Apex class: SELECT Id, Name, (SELECT Id, Parent.Name, Parent.Profile.Name FROM SetupEntityAccessItems) FROM ApexClass WHERE Name = 'helloWorld'
While it’s possible to return permission sets that have access to a ConnectedApplication, ServiceProvider, or TabSet by SetupEntityId, it’s not possible to return permission sets that have access to these SetupEntityType fields by any other AppMenuItem attribute, such as Name or Description. For example, to find out if a user has access to the Recruiting app, you’d run two queries. First, query to get the AppMenuItem ID: SELECT Id, Name, Label FROM AppMenuItem WHERE Name = 'Recruiting'
Let’s say the previous query returned the AppMenuItem ID 02uD0000000GIiMIAW. Using this ID, you can now run a query to find out if a user has access to the Recruiting app: SELECT Id, SetupEntityId, SetupEntityType FROM SetupEntityAccess WHERE ParentId IN
1776
Standard Objects
Shipment
(SELECT PermissionSetId FROM PermissionSetAssignment WHERE AssigneeId = '005D0000001QOzF') AND (SetupEntityId = '02uD0000000GIiMIAW')
SEE ALSO: PermissionSet FieldPermissions ObjectPermissions ApexClass ApexPage
Shipment Represents the transport of product items in field service. Use shipments to track product items while they are in transit.
Supported Calls create()delete() , describeLayout() , describeSObjects() , getDeleted() , getUpdated() , query() , retrieve() , search() , undelete() , update() , upsert() ,
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
ActualDeliveryDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date the product was delivered.
DeliveredToId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The person or entity the product was delivered to.
1777
Standard Objects
Shipment
Field Name
Details
Description
Type textarea Properties Create, Nillable, Update Description Details not recorded in the provided fields
DestinationLocationId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The place the product is to be delivered.
ExpectedDeliveryDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date the product is expected to be delivered.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update
1778
Standard Objects
Field Name
Shipment
Details Description The owner of the shipment.
Provider
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The company or person making the transfer.
ShipFromAddress
Type address Properties Filter, Nillable Description The place the product is coming from.
ShipFromCity
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the address where the shipment originates.
ShipFromCountry
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the address where the shipment originates.
ShipFromGeocodeAccuracy
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address where the shipment originates. See Compound Field Considerations and Limitations for details on geolocation compound fields. Note: This field is available in the API only.
1779
Standard Objects
Shipment
Field Name
Details
ShipFromLatitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the shipment originates. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. Note: This field is available in the API only.
ShipFromLongitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the shipment originates. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. Note: This field is available in the API only.
ShipFromPostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address where the shipment originates.
ShipFromState
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address where the shipment originates.
ShipFromStreet
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update
1780
Standard Objects
Field Name
Shipment
Details Description The street of the address where the shipment originates.
ShipToAddress
Type address Properties Filter, Nillable Description The physical address where the shipment is delivered.
ShipToCity
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the address where the shipment is delivered.
ShipToCountry
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the address where the shipment is delivered.
ShipToGeocodeAccuracy
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address where the shipment is delivered. See Compound Field Considerations and Limitations for details on geolocation compound fields. Note: This field is available in the API only.
ShipToLatitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the shipment is delivered. Acceptable values are numbers between –90 and 90 with
1781
Standard Objects
Field Name
Shipment
Details up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. Note: This field is available in the API only.
ShipToLongitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the shipment is delivered. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. Note: This field is available in the API only.
ShipToName
Type string Properties Create, Filter, Group, Sort, Update Description The shipment recipient.
ShipToPostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address where the shipment is delivered.
ShipToState
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address where the shipment is delivered.
ShipToStreet
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update
1782
Standard Objects
Field Name
Shipment
Details Description The street of the address where the shipment is delivered.
ShipmentNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-generated number identifying the shipment.
SourceLocationId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The field service location where the shipment originates.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the shipment. The picklist includes the following values, which can be customized: • Shipped—The product is in transit. • Delivered—The product is at the source location.
TrackingNumber
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Tracking number for the shipment.
TrackingUrl
Type url Properties Create, Filter, Group, Nillable, Sort, Update Description URL of website used for tracking the shipment.
1783
Standard Objects
SignupRequest
SignupRequest Represents a request for a new Trialforce sign-up. This object is available in API version 27.0 and later. Note: You are limited to 20 sign-ups per day. If you need to make additional sign-ups, log a case in the Partner Community.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete()
Fields Field Name
Details
AuthCode
Type string Properties Create, Filter, Group, Sort Description A one-time authorization code that can be exchanged for an OAuth access token and refresh token using standard Salesforce APIs. It’s used in conjunction with ConnectedAppCallbackUrl and ConnectedAppConsumerKey, when the specified connected app hasn't been configured with an X.509 certificate. This is a read-only field provided by the system once the sign-up request has been processed. This field is available in API version 29.0 and later.
Company
Type string Properties Create, Filter, Group, Sort Description The name of the company requesting the trial sign-up.
ConnectedAppCallbackUrl Type
string Properties Create, Filter, Group, Sort Description When used in conjunction with ConnectedAppConsumerKey, specifies a connected app that should be approved automatically during the sign-up creation. This field is available in API version 28.0 and later.
1784
Standard Objects
Field Name
SignupRequest
Details
ConnectedAppConsumerKey Type
string Properties Create, Filter, Group, Sort Description When used in conjunction with ConnectedAppCallbackUrl, specifies a connected app that should be approved automatically during the sign-up creation. This field is available in API version 28.0 and later. Country
Type string Properties Create, Filter, Group, Sort Description The two-character, upper-case ISO-3166 country code. You can find a full list of these codes at a number of sites, such as: www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html. The language of the trial organization is auto-determined based on the value of this field.
CreatedOrgId
Type string Properties Filter, Group, Nillable, Sort Description The 15–character organization ID of the trial organization created. This is a read-only field provided by the system once the sign-up request has been processed.
CreatedOrgInstance
Type string Properties Filter, Group, Nillable, Sort Description The server instance of the new trial organization, for example, “na8.” This field is available in API version 29.0 and later.
Edition
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The Salesforce template that is used to create the trial organization. Possible values are Partner Group, Professional, Partner Professional, Sales
1785
Standard Objects
Field Name
SignupRequest
Details Professional, Professional TSO, Enterprise, Partner Enterprise, Service Enterprise, Enterprise TSO, Developer, and Partner Developer. This field is available in API version 35.0 and later.
ErrorCode
Type string Properties Filter, Group, Nillable, Sort Description The error code if the sign-up request isn’t successful. This is a read-only field provided by the system to be used for support purposes.
FirstName
Type string Properties Create, Filter, Nillable, Sort Description The first name of the admin user for the trial sign-up.
LastName
Type string Properties Create, Filter, Group, Sort Description The last name of the admin user for the trial sign-up.
PreferredLanguage
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the trial organization being created. Specify the language using a language code listed under Fully Supported Languages in “Supported Languages ” in the Salesforce Help. For example, use zh_CN for simplified Chinese. The value you select overrides the language set by locale. If you specify an invalid language, the organization defaults to English. Likewise, if you specify a language that isn’t supported by the Salesforce edition associated with your trial template, the trial organization defaults to English. This field is available in API version 35.0 and later.
ResolvedTemplateId
Type string Properties Filter, Group, Nillable, Sort
1786
Standard Objects
Field Name
SignupRequest
Details Description Populated during the sign-up request and for internal use by Salesforce. This field is available in API version 35.0 and later.
ShouldConnectToEnvHub
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description When set to true, the trial organization is connected to the Environment Hub. The sign-up must take place in the hub master organization or a spoke organization. This field is available in API version 35.0 and later.
SignupEmail
Type email Properties Create, Filter, Group, Sort Description The email address of the admin user for the trial sign-up.
SignupSource
Type string Properties Create, Filter, Group, Nillable, Sort Description A user-specified description of the trial sign-up, up to 60 characters in length. This field is available in API version 36.0 and later.
Status
Type picklist Properties Defaulted on create, Filter, Group, Sort, Update Description The status of the request. Possible values are New, In Progress, Error, or Success. The default value is New.
Subdomain
Type string Properties Create, Filter, Group, Sort
1787
Standard Objects
Field Name
SignupRequest
Details Description The subdomain for the new trial organization when it uses a custom My Domain. The maximum length is 33 characters for Developer Edition (DE) and 40 characters for all other editions (because a suffix is appended to all DE organizations).
SuppressSignupEmails
Type boolean Properties Filter, Group, Nillable, Sort Description When set to true, no sign-up emails are sent when the trial organization is created. This field is used for the Proxy Signup feature, and is available in API version 29.0 and later.
TemplateId
Type string Properties Create, Filter, Group, Nillable, Sort Description The 15–character ID of the Trialforce template that is the basis for the trial sign-up. The template must be approved by Salesforce. If you don’t specify an edition, a template ID is required.
TrialDays
Type anyType Properties Create, Defaulted on create, Filter, Group, Sort Description The duration of the trial sign-up in days. Must be equal to or less than the trial days for the approved Trialforce template. If not provided, it defaults to the trial duration specified for the Trialforce template.
TrialSourceOrgId
Type string Properties Filter, Group, Nillable, Sort Description The 15–character organization ID of the Trialforce Source Organization from which the Trialforce template was created.
Username
Type string Properties Create, Filter, Group, Sort
1788
Standard Objects
Field Name
SignupRequest
Details Description The username of the admin user for the trial sign-up. It must follow the address convention specified in RFC822: www.w3.org/Protocols/rfc822/#z10
Usage The Java class below uses the REST API to create a SignupRequest object. It authenticates to the Trialforce Management Organization and then posts a request to the SignupRequest object. Here are the variables you need to specify in this example. • SERVER — The name of the host server for the Trialforce Management Organization (TMO), for example, “yourInstance.salesforce.com.” • USERNAME — The admin username for the TMO. • PASSWORD — The concatenation of the admin password and the security token for the TMO. To get an email with the security token, from your personal settings in Salesforce select Reset My Security Token and click Reset Security Token. • CLIENT_ID — From Setup in Salesforce, enter Apps in the Quick Find box, select Apps, and click New under Connected Apps. Enter values for the required fields (the Callback URL is required but can initially be set to any valid URL as it's not used), grant full access for the OAuth scopes in the "Selected OAuth Scopes" selector, and click Save. Then copy the value of “Consumer Key” and use it for this variable. • CLIENT_SECRET — On the same page, click Click to reveal. Then copy the value of "Consumer Secret" and use it for this variable. public class IsvSignupDriver { private static final String private static final String private static final String private static final String private static final String
SERVER = server_name:port; USERNAME = tmo_username; PASSWORD = tmo_passwordsecurity_token; CLIENT_ID = consumer_key; CLIENT_SECRET = consumer_secret;
private static SignupRequestInfo signupRequest = null; public static String createSignupRequest (SignupRequestInfo sr) throws JSONException, IOException { JSONObject createResponse = null; signupRequest = sr; JSONObject loginResponse = login(SERVER, USERNAME, PASSWORD); String instanceUrl = loginResponse.getString("instance_url"); String accessToken = loginResponse.getString("access_token"); createResponse = create(instanceUrl, accessToken); System.out.println("Created SignupRequest object: " + createResponse + "\n"); return createResponse.toString(); } /* Authenticates to the TMO using the required credentials */ private static JSONObject login(String server, String username, String password) throws ClientProtocolException, IOException, JSONException { String authEndPoint = server + "/services/oauth2/token"; HttpClient httpclient = new DefaultHttpClient();
1789
Standard Objects
SignupRequest
try { HttpPost post = new HttpPost(authEndPoint); List params = new ArrayList(); params.add(new BasicNameValuePair("grant_type", "password")); params.add(new BasicNameValuePair("client_id", CLIENT_ID)); params.add(new BasicNameValuePair("client_secret", CLIENT_SECRET)); params.add(new BasicNameValuePair("username", username)); params.add(new BasicNameValuePair("password", password)); post.setEntity(new UrlEncodedFormEntity(params, Consts.UTF_8)); BasicResponseHandler handler = new BasicResponseHandler(); String response = httpclient.execute(post, handler); return new JSONObject(response); } finally { httpclient.getConnectionManager().shutdown(); } } /* Posts a request to the SignupRequest object */ private static JSONObject create(String instanceUrl, String accessToken) throws ClientProtocolException, IOException, JSONException { HttpClient httpClient = new DefaultHttpClient(); try { HttpPost post = new HttpPost(instanceUrl + "/services/data/v27.0/sobjects/SignupRequest/"); post.setHeader("Authorization", "Bearer " + accessToken); post.setHeader("Content-Type", "application/json"); JSONObject requestBody = new JSONObject(); requestBody.put("TemplateId", signupRequest.getTemplateID()); requestBody.put("SignupEmail", signupRequest.getEmail()); requestBody.put("username", signupRequest.getUsername()); requestBody.put("Country", "US"); requestBody.put("Company", signupRequest.getCompanyName()); requestBody.put("lastName", signupRequest.getLastName()); StringEntity entity = new StringEntity(requestBody.toString()); post.setEntity(entity); BasicResponseHandler handler = new BasicResponseHandler(); String response = httpClient.execute(post, handler); return new JSONObject(response); } finally { httpClient.getConnectionManager().shutdown(); } } }
Error Codes If the sign-up fails, the system generates an error code that can help you identify the cause. This table shows the most important error codes.
1790
Standard Objects
Site
Error Code
Description
C-1007
Duplicate username.
C-1015
Error while establishing the new organization's My Domain settings. Contact Salesforce support for assistance.
C-1016
Error while configuring the OAuth connected app for Proxy Signup. Verify that your connected app has a valid consumer key, callback URL, and unexpired certificate (if applicable).
C-1018
Invalid subdomain value provided during sign-up.
C-1019
Subdomain in use. Please choose a new subdomain value.
C-9999
Generic “fatal error.” Contact Salesforce support for assistance.
S-1006
Invalild email address (not in a proper email address format).
S-2006
Invalid country code.
T-0001
Template ID not valid (not in the format 0TTxxxxxxxxxxxx).
T-0002
Template not found. Either the template doesn't exist (it may have been deleted), or it doesn't exist at the appropriate version.
T-0003
Template not approved for use by Salesforce.
Site Represents a public website that is integrated with an Organization. This object is generally available in API version 16.0 and later. To access this object, Force.com Sites or Site.com must be enabled for your organization.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules • Customer Portal users can’t access this object. • To view this object, you must have the “View Setup and Configuration” permission.
Fields Field
Description
AdminId
Type reference Properties Filter, Group, Sort
1791
Standard Objects
Field
Site
Description Description The site administrator designated as the contact for the site. This user receives site-related communications from site visitors and from Salesforce.
AnalyticsTrackingCode
Type string Properties Filter, Group, Nillable, Sort Description The tracking code associated with your site. This code can be used by services like Google Analytics to track page request data for your site.
ClickjackProtectionLevel
Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Sets the clickjack protection level. The options are: • AllowAllFraming—Allow framing by any page (no protection) • SameOriginOnly—Allow framing by the same origin only (recommended) • NoFraming—Don’t allow framing by any page (most protection) This field is available in API version 30.0 and later.
DailyBandwidthLimit
Type int Properties Filter, Group, Nillable, Sort Description The rolling 24-hour daily bandwidth limit for the sites in your organization.
DailyBandwidthUsed
Type double Properties Filter, Group, Nillable, Sort Description The current rolling 24-hour daily bandwidth usage for the sites in your organization.
DailyRequestTimeLimit
Type int
1792
Standard Objects
Field
Site
Description Properties Filter, Group, Nillable, Sort Description The rolling 24-hour daily service request time limit for the sites in your organization. Service request time is calculated as the total server time in minutes required to generate pages for the site.
DailyRequestTimeUsed
Type int Properties Filter, Group, Nillable, Sort Description The current rolling 24-hour daily service request time for the sites in your organization.
Description
Type textarea Properties Filter, Nillable, Sort Description An optional description of the site.
GuestUserId
Type reference Properties Filter, Group, Nillable, Sort Description The site or Salesforce Communities specific user that anonymous, unauthenticated users run as when interacting with the site.
MasterLabel
Type string Properties Filter, Group, Sort Description The name of the site as it appears in the user interface.
MonthlyPageViewsEntitlement
Type int Properties Filter, Group, Nillable, Sort
1793
Standard Objects
Field
Site
Description Description The number of page views allowed for the current calendar month for the sites in your organization.
Name
Type string Properties Filter, Group, Sort Description The name used when referencing the site in the API.
OptionsAllowHomePage
Type boolean Properties Filter Description The option to enable the standard page associated with the Home tab (/home/home.jsp).
OptionsAllowStandardAnswersPages Type
boolean Properties Filter Description The option to enable standard pages associated with an answers community. If you want to use default Answers pages (such as AnswersHome), enable these pages. OptionsAllowStandardIdeasPages Type
boolean Properties Filter Description The option to enable standard pages associated with an Ideas community. If you want to use default Ideas pages (such as IdeasHome), enable these pages. OptionsAllowStandardLookups
Type boolean Properties Filter
1794
Standard Objects
Field
Site
Description Description The option to enable the standard lookup pages. These are the popup windows associated with lookup fields on Visualforce pages.
OptionsAllowStandardSearch
Type boolean Properties Filter Description The option to enable the standard search pages. To allow public users to perform standard searches, enable these pages.
OptionsEnableFeeds
Type boolean Properties Filter Description The option that displays the Syndication Feeds related list, where you can create and manage syndication feeds for users on your public sites. This field is visible only if you have the feature enabled for your organization.
OptionsRequireHttps
Type boolean Properties Filter Description When true, the site requires secure connections. When false, the site operates normally via insecure connections instead of redirecting to a secure connection.
SiteType
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Identifies whether the site is a Visualforce (Force.com Sites) or a Site.com site. SiteType is available in API version 21.0 and later. In API version 26.0 and later, if Salesforce Communities is enabled for your organization, the site could also be a Network Visualforce or Network Site.com site.
Status
Type picklist Properties Filter, Group, Restricted picklist, Sort
1795
Standard Objects
Field
SiteDomain
Description Description The status for the site. For example, Active or In Maintenance.
Subdomain
Type string Properties Filter, Group, Nillable, Sort Description The Force.com domain that you registered for your site. For example, if your Force.com domain is mycompany.force.com, then mycompany is the subdomain.
TopLevelDomain
Type url Properties Filter, Nillable Description The optional branded custom Web address that you registered with a third-party domain name registrar. The custom Web address acts as an alias to your Force.com address. Beginning with API version 21.0, TopLevelDomain is no longer available. Instead, use the Domain and DomainSite objects.
UrlPathPrefix
Type string Properties Filter, Group, Nillable, Sort Description The unique Force.com URL that the public uses to access this site.
Usage Use this read-only object to query or retrieve information on your Force.com site.
SiteDomain SiteDomain is a read-only object, and a one-to-many replacement for the Site.TopLevelDomain field. This object is available in API version 21.0, and has been deprecated as of API version 26.0. In API version 26.0 and later, use the Domain and DomainSite objects instead. To access this object, Force.com Sites or Site.com must be enabled for your organization.
1796
Standard Objects
SiteDomain
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules • Customer Portal users can’t access this object. • To view this object, you must have the “View Setup and Configuration” permission.
Fields Field
Description
Domain
Type url Properties Filter, Sort Description The branded custom Web address within the global namespace identified by this domain's type. In the Domain Name System (DNS) global namespace, this field is the custom Web address that you registered with a third-party domain name registrar. The custom Web address can be used to access the site of this domain.
SiteId
Type reference Properties Filter, Group, Sort Description The ID of the associated Site.
DomainType
Type picklist Properties Filter, Group, Sort, Nillable Description The global namespace that this custom Web address belongs to. This value is set to DNS for custom Web addresses in the global DNS. This field is available in version 24.0 of the API.
Usage Use this read-only object to query the custom Web addresses that are associated with each website in your organization.
1797
Standard Objects
SiteHistory
SiteHistory Represents the history of changes to the values in the fields of a site. This object is generally available in API version 18.0 and later. To access this object, Force.com Sites must be enabled for your organization.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules • Customer Portal users can't access this object. • To view this object, you must have the “View Setup and Configuration” permission.
Fields Field
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The last value of the field before it was changed.
SiteId
Type reference Properties Filter, Group, Sort
1798
Standard Objects
Field
Skill
Details Description The ID of the associated Site.
Skill Represents a category or group that Live Agent users or field service resources can be assigned to. This object is available in API version 24.0 and later. Note: For information about Work.com skills on a user’s profile, see the ProfileSkill topic.
Supported Calls create(), describeSObjects(), query(), retrieve(), search(), update(), upsert()
Fields Field Name
Details
Description
Type textarea Properties Create, Nillable, Update Description The description of the skill.
DeveloperName
Type string Properties Create, Filter, Group, Sort, Update 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. Note: 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.
1799
Standard Objects
SkillProfile
Field Name
Details
Language
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the skill.
LastViewedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed the skill.
MasterLabel
Type string Properties Create, Filter, Group, Sort, Update, idLookup Description The name of the skill.
Usage Live Agent Use this object to assign Live Agent users to groups based on their abilities. The skills associated with a LiveChatButton determine which agents receive chat requests that come in through that button. Field Service Lightning Use this object to track certifications and areas of expertise in your workforce. After you create a skill, you can: • Assign it to a service resource via the Skills related list on the resource’s detail page. When you assign a skill to a service resource, you can specify their skill level and the duration of the skill. • Add it as a required skill via the Skill Requirements related list on any work type, work order, or work order line item. When you add a required skill to a work record, you can specify the skill level.
SkillProfile Represents a join between Skill and Profile. This object is available in API version 24.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
1800
Standard Objects
SkillRequirement
Fields Field Name
Details
ProfileId
Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the profile.
SkillId
Type reference Properties Create, Filter, Group, Sort Description The ID of the skill.
Usage Use this object to assign specific skills to specific profiles.
SkillRequirement Represents a skill that is required to complete a particular task. Skill requirements can be added to work types, work orders, and work order line items. This object is available in API version 38.0 and later.
Supported Calls create(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert()
Fields Field Name
Details
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort
1801
Standard Objects
Field Name
SkillRequirement
Details Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
RelatedRecordId
Type reference Properties Create, Filter, Group, Sort Description The record that the skill is required for. The related record can be a work order, work order line item, or work type.
SkillId
Type reference Properties Create, Filter, Group, Sort, Update Description The skill that is required.
SkillLevel
Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The level of the skill required. Skill levels can range from zero to 99.99. Depending on your business needs, you may want the skill level to reflect years of experience, certification levels, or license classes.
SkillNumber
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort
1802
Standard Objects
Field Name
SkillRequirementFeed
Details Description An auto-generated number identifying the skill requirement.
Usage If a work order or work order line item can only be completed by a service resource with a particular set of skills, add required skills to the record via the Skill Requirements related list. Required skills help dispatchers assign the record to a service resource with the proper expertise. You can still assign a work order, work order line item, or related service appointment to a service resource that does not possess the required skills, so required skills serve more as a suggestion than a rule. Note: If you’re using the Field Service Lightning managed packages, you can use matching rules to ensure that appointments are only assigned to service resources who possess the required skills listed on the parent work order. If many of your work orders require the same skills, we recommend adding required skills to work types to save yourself some time and keep your processes consistent. When you add a required skill to a work type, work orders and work order line items that use that type automatically inherit the required skill. For example, if you know that all annual maintenance visits for your Classic Refrigerator product require a Refrigerator Maintenance skill level of at least 50, you can add that required skill to the Annual Maintenance Visit work type. When it’s time to create a work order for a customer’s annual fridge maintenance, adding that work type to the work order adds the required skill as well.
SkillRequirementFeed Represents a single feed item on a skill requirement record detail page. This object is available in API version 38.0 and later. A skill requirement feed shows changes to tracked fields on a skill requirement record. It also shows posts and comments about the record. It’s a useful way to stay up to date with changes made to skill requirements in Salesforce.
Supported Calls delete(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Operating Hours object • “Moderate Chatter”
1803
Standard Objects
SkillRequirementFeed
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
1804
Standard Objects
SkillRequirementFeed
Field Name
Details
LinkUrl
Type url Properties Nillable, Sort Description The URL of a link post.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the skill requirement record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the Link URL is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
1805
Standard Objects
SkillRequirementHistory
SkillRequirementHistory Represents the history of changes made to tracked fields on a skill requirement. This object is available in API version 38.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
SkillRequirementId
Type reference Properties Filter, Group, Sort
1806
Standard Objects
Field Name
SkillUser
Details Description ID of the skill requirement being tracked. The history is displayed on the detail page for this record.
SkillUser Represents a join between Skill and User. This object is available in API version 24.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
SkillId
Type reference Properties Create, Filter, Group, Sort Description The ID of the skill.
UserId
Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the user.
Usage Use this object to assign specific skills to specific users.
SlaProcess Represents an entitlement process associated with an Entitlement. This object is available in API version 19.0 and later. An entitlement process is a timeline that includes all the steps (MilestoneType records) that your support team must complete to resolve cases. Each process includes the logic necessary to determine how to enforce the correct service level for your customers.
1807
Standard Objects
SlaProcess
Supported Calls describeSObjects(), query(), retrieve(), search(), describeLayout()
Special Access Rules Customer Portal users can’t access this object. All users, even those without the “View Setup and Configuration” user permission, can view entitlement processes via the API.
Fields Field
Details
BusinessHoursId
Type reference Properties Filter, Group, Nillable, Sort Description Required. ID of the BusinessHours associated with the entitlement. Must be a valid business hours ID.
Description
Type textarea Properties Filter, Nillable Description A description of the entitlement process.
IsActive
Type boolean Properties Defaulted on create, Filter Description Indicates whether the entitlement process is active (true) or not (false).
IsVersionDefault
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the entitlement process is the default version (true) or not (false). This field is available in API version 28.0 and later in organizations that have entitlement versioning enabled.
1808
Standard Objects
SlaProcess
Field
Details
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the SlaProcess was last viewed.
Name
Type string Properties Filter, idLookup Description The name of the entitlement process.
NameNorm
Type string Properties Filter, Group, Sort Description The read-only value for the unique name of the entitlement process or the entitlement process version. If entitlement versioning is enabled, this value is automatically generated for each version of an entitlement process in this form: process name+_v + x, where x is the version number (for example, “gold_support_v2”). If entitlement versioning isn’t enabled, this value is the same as Name. This field is available in API version 28.0 and later.
SObjectType
Type picklist Properties Restricted picklist, Filter, Group, Sort Description The type of records that the entitlement process can run on. Its values are: • Case • Work Order An entitlement process runs only on records that match its type. For example, a Case entitlement process that’s applied to an entitlement runs only on cases associated with the entitlement, not on work orders. As a best practice, therefore, manage customers’ work orders and cases on separate entitlements. The field label in the user interface is Entitlement Process Type.
1809
Standard Objects
SlaProcess
Field
Details
StartDateField
Type picklist Properties Filter, Restricted picklist Description The criteria for cases to enter the entitlement process. Cases can enter the process based on: • The creation date on a case • A custom date/time field on a case
VersionMaster
Type string Properties Filter, Group, Nillable, Sort Description Identifies the sequence of versions to which this entitlement process belongs. This field’s contents can be any value as long as it is identical among all versions of the entitlement process. This field is available in API version 28.0 and later in organizations that have entitlement versioning enabled.
VersionNotes
Type textarea Properties Filter, Group, Nillable, Sort Description The description of the entitlement process version. This field is available in API version 28.0 and later in organizations that have entitlement versioning enabled.
VersionNumber
Type int Properties Filter, Group, Nillable, Sort Description The version number of the entitlement process. Must be 1 or greater. This field is available in API version 28.0 and later in organizations that have entitlement versioning enabled.
1810
Standard Objects
Solution
Usage Use this object to query entitlement processes on entitlements. SEE ALSO: Entitlement MilestoneType CaseMilestone
Solution Represents a detailed description of a customer issue and the resolution of that issue.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field
Details
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
IsHtml
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the Solution is an HTML solution (true) or not (false).
IsOutOfDate
Type boolean Properties Defaulted on create, Filter
1811
Standard Objects
Field
Solution
Details Description Read-only field that indicates whether a solution master has been updated since the translated version was created (true) or not (false). Note that this field does not appear in the page layout of master solutions.
IsPublished
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Solution has been published (true) or not (false). A solution’s published state does not affect how it can be used, or whether you can query, update, or delete it. Label is Public. Note: Prior to Spring ‘14, the label was Visible in Self-Service Portal.
IsPublishedInPublicKb
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Solution has been published as a Public Solution (true) or not (false). Label is Visible in Public Knowledge Base. This field only applies to solutions, not articles in the public knowledge base.
IsReviewed
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the Solution has been reviewed (true) or not (false). This flag can only be set indirectly via the Status picklist. Each predefined Status value implies an IsReviewed value. Label is Reviewed.
LastReferencedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
1812
Standard Objects
Solution
Field
Details
LastViewedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User who owns the Solution.
ParentId
Type reference Properties Create, Defaulted on create, Filter, Update Description ID of the master solution, if this is the translation of a master solution.
RecordTypeId
Type reference Properties Create, Filter, Nillable, Update Description ID of the RecordType to which the Solution is associated.
SolutionLanguage
Type picklist Properties Create, Filter, Restricted picklist, Update Description The language that the solution is written in, such as French or Chinese (Traditional).
SolutionName
Type string Properties Create, Filter, Group, Sort, Update
1813
Standard Objects
Field
Solution
Details Description Required. If a client application creates a new Solution and a value for this field is unspecified, a hyphen (-), the default value for this field, is used. Limit: 255 characters. Label is Title.
SolutionNote
Type textarea Properties Create, Nillable, Update Description The details of the Solution record. Limit: 32,000 characters. Label is Solution Details. Note: If you have HTML Solutions enabled, any HTML tags used in this field are verified before the object is created or updated. If invalid HTML is entered, an error is thrown. Any JavaScript used in this field is removed before the object is created or updated.
SolutionNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An identifying number that is assigned automatically when a solution is created. It can’t be set directly, and it can’t be modified.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. The status of the solution. Directly controls the IsReviewed value. To obtain the status values in the picklist, a client application can query the SolutionStatus.
TimesUsed
Type int Properties Filter, Group, Sort Description Number of times this solution has been used. Label is Num Related Case.
1814
Standard Objects
SolutionFeed
Usage Use this object to manage your organization’s solutions. Client applications can create, update, delete, and query Attachment records associated with a solution. SEE ALSO: CategoryData CategoryNode
SolutionFeed Represents a single feed item in the feed displayed on the detail page for a solution record. This object is available in API version 18.0 and later. A solution feed shows recent changes to a solution record for any fields that are tracked in feeds, and comments and posts about the record. It is a useful way to stay up-to-date with changes to solutions.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Solution object • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content of the SolutionFeed. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
1815
Standard Objects
SolutionFeed
Field Name
Details
CommentCount
Type int Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item. Tip: In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only one. In a moderated feed, your comment isn’t counted until it's approved by an admin or a person with “CanApproveFeedPostAndComment” or “ModifyAllData” permission. This has implications for how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until end of comments is returned.
ConnectionId
Type reference Properties Filter, Group, Nillable, Sort Description When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only.
1816
Standard Objects
Field Name
SolutionFeed
Details The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The file uploaded to the feed. Required if Type is ContentPost. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.
FeedPostId
Type reference Properties Filter. Group, Nillable, Sort Description This field was removed in API version 22.0, and is available in earlier versions for backward compatibility only. Use FeedItem instead. The ID of the associated FeedPost. A FeedPost represents the following types of changes in a SolutionFeed: status updates, changes to tracked fields, text posts, link posts, and content posts.
InsertedById
Type reference Properties Group, Nillable, Sort
1817
Standard Objects
Field Name
SolutionFeed
Details Description The ID of the user who added this object to the feed. For example, if a client application migrates multiple posts and comments from another application into the feed, InsertedById is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LastModifiedDate
Type dateTime Properties Defaulted on create, Filter, Sort Description This field is a standard system field.
1818
Standard Objects
Field Name
SolutionFeed
Details When a feed item is created, LastModifiedDate is the same as CreatedDate. If a FeedComment is inserted on the feed item, then LastModifiedDate becomes the CreatedDate for the FeedComment. Deleting the FeedComment does not change the LastModifiedDate. Ordering by LastModifiedDate DESC sorts the feed by both the most recent feed item or comment.
LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of the LinkPost.
NetworkScope
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. NetworkScope can have the following values:
• NetworkId—The ID of the community in which the FeedItem is available. If left empty, the feed item is only available in the default community. • AllNetworks—The feed item is available in all communities. Note the following exceptions for NetworkScope: • Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks. • You can’t filter a FeedItem on the NetworkScope field.
1819
Standard Objects
SolutionFeed
Field Name
Details
ParentId
Type reference Properties Filter, Group, Sort Description ID of the solution record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion article associated with a ContentPost. This field is null for all posts except ContentPost. For example, set this field to an existing ContentVersion and post it to a feed as a SolutionFeed object of Type ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the SolutionFeed. When the Type is LinkPost, the LinkUrl is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of SolutionFeed item: • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence.
1820
Standard Objects
Field Name
SolutionFeed
Details • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • AttachArticleEvent—generated event when a user attaches an article to a case. • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • CaseCommentPost—generated event when a user adds a case comment for a case object. • ChangeStatusPost—generated event when a user changes the status of a case. • ChatTranscriptPost—generated event when Live Agent transcript is saved to a case.
1821
Standard Objects
Field Name
SolutionHistory
Details • EmailMessageEvent—generated event when an email related to a case object is sent or received. • FacebookPost—generated when a Facebook post is created from a case. Deprecated. • MilestoneEvent—generated when a case milestone is completed or reaches violation status. • SocialPost—generated when a social post is created from a case.
Visibility
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. Visibility can have the following values:
• AllUsers—The feed item is available to all users who have permission to see the feed item. • InternalUsers—The feed item is available to internal users only. Note the following exceptions for Visibility: • For record posts, Visibility is set to InternalUsers for all internal users by default. • External users can set Visibility only to AllUsers. • Visibility can be updated on record posts. • The Update property is supported only for feed items posted on records.
Usage Use this object to track changes for a solution record. SEE ALSO: Solution EntitySubscription NewsFeed UserProfileFeed
SolutionHistory Represents the history of changes to the values in the fields of a solution.
1822
Standard Objects
SolutionHistory
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed. Label is Custom Field Definition ID.
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed. Limited to 255 characters.
OldValue
Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed. Limited to 255 characters.
SolutionId
Type reference Properties Filter, Group, Sort Description ID of the Solution. Label is Solution ID.
1823
Standard Objects
SolutionStatus
Usage Use this read-only object to identify changes to a solution. This object respects field-level security on the parent object. SEE ALSO: SolutionStatus
SolutionStatus Represents the status of a Solution, such as Draft, Reviewed, and so on.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field
Details
ApiName
Type string Properties Filter, Group, NillableSort Description Uniquely identifies a picklist value so it can be retrieved without using an id or master label.
IsDefault
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this is the default solution status value (true) or not (false) in the picklist. Only one value can be the default value.
IsReviewed
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this solution status value represents a reviewed Solution (true) or not (false). Multiple solution status values can represent a reviewed Solution.
1824
Standard Objects
SolutionTag
Field
Details
MasterLabel
Type string Properties Filter, Group, Nillable, Sort Description Master label for this solution status value. This display value is the internal label that does not get translated.
SortOrder
Type int Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the solution status picklist. These numbers are not guaranteed to be sequential, as some previous solution status values might have been deleted.
Usage This object represents a value in the solution status picklist. The solution status picklist provides additional information about the status of a Solution, such as whether a given status value represents a reviewed or unreviewed solution. Your client application can query this object to retrieve the set of values in the solution status picklist, and then use that information while processing Solution objects to determine more information about a given solution. For example, the application could test whether a given case has been reviewed or not based on its Status value and the value of the IsReviewed property in the associated SolutionStatus record. SEE ALSO: Solution
SolutionTag Associates a word or short phrase with a Solution.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve()
1825
Standard Objects
SolutionTag
Fields Field Name
Details
ItemId
Type reference Properties Create, Filter Description ID of the tagged item.
Name
Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically.
TagDefinitionId
Type reference Properties Filter Description ID of the parent TagDefinition object that owns the tag.
Type
Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: • Public—The tag can be viewed and manipulated by all users in an organization. • Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId.
Usage SolutionTag stores the relationship between its parent TagDefinition and the Solution being tagged. Tag objects act as metadata, allowing users to describe and organize their data.
1826
Standard Objects
SOSDeployment
When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries.
SOSDeployment Represents the general settings for deploying SOS video call capability in a native mobile application. This object is available in API version 34.0 and later.
Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
DeveloperName
Type string Properties Create, Filter, Group, Sort, Update 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. Note: 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.
Language
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the deployment.
MasterLabel
Type string Properties Create, Filter, Group, Sort, Update
1827
Standard Objects
Field Name
SOSDeployment
Details Description The name of the deployment.
OptionsIsBackwardFacingCameraEnabled Type
boolean Properties Create, Filter, Update Description Determines whether customers can use the backwards-facing camera on their mobile devices to talk to SOS agents. OptionsIsEnabled
Type boolean Properties Create, Filter, Update Description Determines whether the deployment is enabled for customers to request new SOS video calls.
OptionsIsVoiceOnlyMode
Type boolean Properties Create, Filter, Update Description Determines whether video functionality is disabled for customers, making it so customers can only talk to SOS agents using only audio.
QueueId
Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the queue that’s associated with the SOS deployment.
Usage Use this object to query and manage SOS deployments.
1828
Standard Objects
SOSSession
SOSSession This object is automatically created for each SOS session and stores information about the session. This object is available in API versions 34.0 and later.
Supported Calls create()delete() , describeLayout() , describeSObjects() , getDeleted() , getUpdated() , query() , retrieve() , search() , undelete() , update() , upsert() ,
Fields Field Name
Details
AppVersion
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The version of the customer’s mobile application in which SOS is implemented.
CaseId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the case that’s associated with the SOS session.
ContactId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the contact that’s associated with the SOS session.
DeploymentId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the SOS deployment that the SOS session originated from.
EndTime
Type dateTime
1829
Standard Objects
Field Name
SOSSession
Details Properties Create, Filter, Nillable, Sort, Update Description The time that the SOS session ended.
IpAddress
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The IP address from which the customer’s SOS call originated.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date and time that the session record was last referenced by a user.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date and time that the session record was last viewed.
Name
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The name of the session.
OpentokSession
Type encryptedstring Properties Create, Nillable, Update Description The ID of the OpenTok session that’s associated with the SOS video call.
OwnerId
Type reference
1830
Standard Objects
Field Name
SOSSession
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the session record’s owner.
SessionDuration
Type int Properties Filter, Group, Nillable, Sort Description The amount of time that the SOS session lasted.
SessionRecordingUrl
Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The URL where the SOS session recording is stored.
SosVersion
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The version of SOS that was used in your organization’s mobile application when this session occurred.
StartTime
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time that the SOS session began.
SystemInfo
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Information about the customer’s mobile device from which the SOS call originated, such as the device’s operating system.
1831
Standard Objects
SOSSessionActivity
Field Name
Details
WaitDuration
Type int Properties Filter, Group, Nillable, Sort Description The amount of time the customer waited before an agent accepted the SOS session and the call began.
Usage Use this object to query and manage SOS session records.
SOSSessionActivity Captures information about specific events that occur during an SOS video call, such as when an SOS call begins or ends. This object is available in API version 34.0 and later.
Supported Calls create(),delete(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),undelete(),update(),upsert()
Fields Field Name
Details
ActivityTime
Type dateTime Properties Create, Filter, Sort Description The time at which the activity occurred.
Name
Type string Properties Autonumber, Defaulted on create, idLookup, Filter, Sort Description The name of the activity.
SessionId
Type reference
1832
Standard Objects
Field Name
SOSSessionHistory
Details Properties Create, Filter, Group, Sort Description The ID of the SOS session that’s associated with the event.
Type
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The kind of activity that occurred.
Usage Use this object to query and manage SOS session activities.
SOSSessionHistory This object is automatically created for each SOS session and stores information about changes made to the session. This object is available in API versions 34.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed in a session record.
NewValue
Type anyType Properties Nillable, Sort
1833
Standard Objects
Field Name
SOSSessionOwnerSharingRule
Details Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The original value of the field that was changed.
SOSSessionId
Type reference Properties Filter, Group, Sort Description ID of the session record that was changed.
Usage Use this object to identify changes to SOS session records.
SOSSessionOwnerSharingRule Represents the rules for sharing an SOS session record with users other than the record owner. This object is available in API version 34.0 and later. Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer support to enable access to this object for your org.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update
1834
Standard Objects
Field Name
SOSSessionOwnerSharingRule
Details Description Determines the level of access users have to session records. Specifies whether or not users can read, edit, or transfer session records. Corresponds to the Default Access column in the UI.
Description
Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum length is 1000 characters.
DeveloperName
Type string Properties Create, Filter, Group, Nillable, Sort, Update 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. Corresponds to Rule Name in the UI. Note: 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.
GroupId
Type reference Properties Create, Filter, Group, Sort Description The ID that represents the source group. Session records that are owned by users in the source group trigger the rule to give access.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update
1835
Standard Objects
Field Name
SOSSessionShare
Details Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to Label in the UI.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description The ID that represents the User or Group that you are granting access to.
Usage Use this object to manage the sharing rules for SOS session records. SEE ALSO: Metadata API Developer Guide: SharingRules
SOSSessionShare Represents a sharing entry on an SOS session. This object is available in API version 34.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the SOSSession. The possible values are: • Read
1836
Standard Objects
Field Name
SOSSessionShare
Details • Edit • All (This value is not valid for create() or update() calls.) This field must be set to an access level that is higher than the organization’s default access level for live chat transcripts.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the parent object, if any.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Values can include: • Manual—The user or group has access because a user with “All” access manually shared the SOSSession with them. • Owner—The user is the owner of the SOSSession or is in a role above the SOSSession owner in the role hierarchy.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that has been given access to the SOSSession.
Usage This object lets you determine which users and groups can view and edit SOSSession records that are owned by other users. If you attempt to create a new record that matches an existing record, the create() call updates any modified fields and returns the existing record.
1837
Standard Objects
Stamp
Stamp Represents a User Specialty. This object is available in API version 39.0 and later. Create User Specialty labels. Specialties can be any term you want, up to 50 characters, including spaces and underscores.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field
Description
Description
Type string Properties Filter, Group, Nillable, Sort Description Use this field to describe what the user specialty means and how it applies to a user. You have a 255 character maximum including spaces and underscores.
MasterLabel
Type string Properties Filter, Group, Sort Description The User Specialty label that appears under the user’s profile picture. You can create any label you want as long as it’s within the 50 character maximum, including spaces and underscores.
ParentId
Type reference Properties Filter, Group, Sort Description The id of the org or network.
StampAssignment Represents assignment of a User Specialty to a user. This object is available in API version 39.0 and later. Assign a User Specialty to users. This label appears beneath their profile photo.
1838
Standard Objects
StaticResource
Supported Calls describeSObjects(), query(), retrieve()
Fields Field
Details
StampId
Type reference Properties Filter, Group, Sort Description The unique id generated when creating a user specialty.
SubjectId
Type reference Properties Filter, Group, Sort Description The id for the user getting the User Specialty label.
StaticResource Represents a static resource that can be used in Visualforce markup.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert()
Fields Field
Details
Body
Type base64 Properties Create, Nillable, Update Description Required. Encoded file data.
1839
Standard Objects
StaticResource
Field
Details
BodyLength
Type int Properties Filter, Group, Sort Description Size of the file (in bytes).
CacheControl
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The sharing policy for the static resource when cached. The cache control can have one of the following values: • Private specifies that the static resource data cached on the Salesforce server shouldn’t be shared with other users. The static resource is only stored in cache for the current user’s session. • Public specifies that the static resource data cached on the Salesforce server be shared with other users in your organization for faster load times.
ContentType
Type string Properties Create, Filter, Group, Sort, Update Description Type of content. Label is Mime Type. Limit: 120 characters.
Description
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of the static resource. Limit: 255 characters.
Name
Type string Properties Create, Filter, Group, Sort, Update Description Required. Name of the static resource.
1840
Standard Objects
StaticResource
Field
Details
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value 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. This field can’t be accessed unless the logged-in user has the “Customize Application” permission.
Usage Use static resources to upload content that you can reference in Visualforce markup, including archives (such as .zip and .jar files), images, stylesheets, JavaScript, and other files. Using a static resource is preferable to uploading a file to the Documents tab because: • You can package a collection of related files into a directory hierarchy and upload that hierarchy as a .zip or .jar archive. • You can reference a static resource in page markup by name using the $Resource global variable instead of hard-coding document IDs.
Encoded Data 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).
1841
Standard Objects
StreamingChannel
Maximum Static Resource Size You can create or update static resources to a maximum size of 5 MB. An organization can have up to 250 MB of static resources, total. SEE ALSO: ApexComponent ApexPage Developer Guide: Visualforce Developer Guide
StreamingChannel Represents a channel that is the basis for notifying listeners of generic Streaming API events. Available from API version 29.0 or later.
Supported Calls REST: DELETE, GET, PATCH, POST (query requests are specified in the URI) SOAP: create(), delete(), describe(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update()
Special Access Rules • This object is available only if Streaming API is enabled for your organization. • Only users with “Create” permission can create this record. • You can create a permission set and grant users read and create access to all streaming channels in the org. This access isn’t for a specific channel, like with user sharing. • You can apply user sharing to StreamingChannel. You can restrict access to receiving or sending events on a channel by sharing channels with specific users or groups. Channels shared with public read-only or read-write access send events only to clients subscribed to the channel that also are using a user session associated with the set of shared users or groups. Only users with read-write access to a shared channel can generate events on the channel, or modify the actual StreamingChannel record.
Dynamic Streaming Channel Generic Streaming also supports dynamic streaming channel creation, which creates a StreamingChannel when a client first subscribes to the channel. To enable dynamic streaming channels in your org, from Setup, enter User Interface in the Quick Find box, then select User Interface and enable Enable Dynamic Streaming Channel Creation.
Fields Field
Field Type
Description
Description
string
Description of the StreamingChannel. Limit: 255 characters. Field Properties: Create, Filter, Group, Nillable, Sort, Update Label: Description
1842
Standard Objects
TagDefinition
Field
Field Type
Description
ID
ID
System field: Globally unique string that identifies a StreamingChannel record. Field Properties: Default on create, Filter, Group, idLookup, Sort
IsDeleted
boolean
System field: Indicates whether the record has been moved to the Recycle Bin (true) or not (false). Field Properties: Default on create, Filter, Group, Sort
IsDynamic
boolean
true if the channel gets dynamically created on subscribe if necessary, false
otherwise. Field Properties: Default on create, Filter, Group, Sort LastReferencedDate
date
The timestamp for when the current user last viewed a record related to this record. Field Properties: Filter, Sort
LastViewedDate
date
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. Field Properties: Filter, Sort
Name
string
Required. Descriptive name of the StreamingChannel. Limit: 80 characters, alphanumeric and “_”, “/” characters only. Must start with “/u/”. This value identifies the channel and must be unique. Field Properties: Create, Filter, Group, idLookup, Sort, Update Label: Streaming Channel Name
OwnerId
reference
The ID of the owner of the StreamingChannel. Field Properties: Create, Default on create, Filter, Group, Sort, Update Label: Owner Name
TagDefinition Defines the attributes of child Tag objects.
Supported Calls delete(), describeSObjects(), query(), retrieve(), search(), undelete(), update()
1843
Standard Objects
TagDefinition
Fields Field
Detail
Name
Type string Properties Filter, Nillable, Update Description Identifies the tag word or phrase.
Type
Type picklist Properties Filter, Nillable, Restricted picklist Description Defines the visibility of a tag. Possible value are: • Public: The tag can be viewed and manipulated between all users in an organization. • Personal: The tag can be viewed or manipulated only by a user with a matching OwnerId.
Usage When you create a tag for a record, an association is created with to a corresponding TagDefinition: • If the value in the tag's Name field is new, a new TagDefinition record is automatically created and becomes the parent of the tag. • If the value in the tag's Name field already exists in a TagDefinition, that TagDefinition automatically becomes the parent of the tag. Each TagDefinition record has a one-to-many relationship with its child tag records. The following standard objects represent tags for records: • AccountTag • AssetTag • CampaignTag • CaseTag • ContactTag • ContractTag • DocumentTag • EventTag • LeadTag • NoteTag • OpportunityTag • SolutionTag • TaskTag
1844
Standard Objects
Task
Custom objects may also be tagged. Tags for custom objects are identified by a suffix of two underscores immediately followed by the word tag. For example, a custom object named Meeting has a corresponding tag named Meeting__tag in that organization’s WSDL. Meeting__tag is only valid for Meeting objects. TagDefinition is useful for mass operations on any tag record. For instance, if you want to rename existing tags, you can search for the appropriate TagDefinition object, update it, and the child tag's Name values are also changed. The following Java example replaces all WC tags with the phrase West Coast: public void tagDefinitionSample() { String soqlQuery = "SELECT Id, Name FROM TagDefinition " + "WHERE Name = 'WC'"; QueryResult qResult = null; try { qResult = connection.query(soqlQuery); TagDefinition tagDef = (TagDefinition) qResult.getRecords()[0]; tagDef.setName("West Coast"); connection.update(new SObject[]{tagDef}); } catch (ConnectionException ce) { ce.printStackTrace(); } }
When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries.
Task Represents a business activity such as making a phone call or other to-do items. In the user interface, Task and Event records are collectively referred to as activities. Note: Task fields related to calls are exclusive to Salesforce CRM Call Center. Additionally, query(), delete(), and update() aren’t allowed with tasks related to more than one contact in API versions 23.0 and earlier.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field
Field Type
AccountId
Type reference Properties Group, Sort, Filter, Nillable Description Represents the ID of the related Account. The AccountId is determined as follows.
1845
Standard Objects
Field
Task
Field Type If the value of WhatId is any of the following objects, then Salesforce uses that object’s AccountId. • Account • Opportunity • Contract • Custom object that is a child of Account If the value of the WhatIdfield is any other object, and the value of the WhoId field is a Contact object, then Salesforce uses that contact’s AccountId. (If your organization uses Shared Activities, then Salesforce uses the AccountId of the primary contact.) Otherwise, Salesforce sets the value of the AccountId field to null. For information on IDs, see ID Field Type.
ActivityDate
Type date Properties Group, Sort, Create, Filter, Nillable, Update Description Represents the due date of the task. This field has a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant; do not attempt to alter it in order to accommodate time zone differences. Label is Due Date. Note: This field can’t be set or updated for a recurring task (IsRecurrence is true).
CallDisposition
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the result of a given call, for example, “we'll call back,” or “call unsuccessful.” Limit is 255 characters. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center.
CallDurationInSeconds
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Duration of the call in seconds.
1846
Standard Objects
Field
Task
Field Type Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center.
CallObject
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of a call center. Limit is 255 characters. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center.
CallType
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of call being answered: Inbound, Internal, or Outbound.
ConnectionReceivedId
Type reference Properties Filter, Nillable Description ID of the PartnerNetworkConnection that shared this record with your organization. This field is only available if you have enabled Salesforce to Salesforce.
ConnectionSentId
Type reference Properties Filter, Nillable Description ID of the PartnerNetworkConnection that you shared this record with. This field is only available if you have enabled Salesforce to Salesforce. Beginning with API version 15.0, the ConnectionSentId field is no longer supported. The ConnectionSentId field is still visible, but the value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections.
Description
Type textarea Properties Create, Nillable, Update
1847
Standard Objects
Field
Task
Field Type Description Contains a text description of the task.
IsArchived
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event has been archived.
IsClosed
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the task has been completed (true) or not (false). Is only set indirectly via the Status picklist. Label is Closed.
IsHighPriority
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates a high-priority task. This field is derived from the Priority field.
IsRecurrence
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the task is scheduled to repeat itself (true) or only occurs once (false). This is a read-only field on update, but not on create. If this field value is true, then RecurrenceStartDateOnly, RecurrenceEndDateOnly, RecurrenceType, and any recurrence fields associated with the given recurrence type must be populated. See Recurring Tasks.
IsReminderSet
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a popup reminder has been set for the task (true) or not (false).
1848
Standard Objects
Task
Field
Field Type
IsVisibleInSelfService
Type boolean Properties Defaulted on create, Filter, Update Description Indicates whether a task associated with an object can be viewed in the Customer Portal (true) or not (false). If your organization has enabled Communities, tasks marked IsVisibleInSelfService are visible to any external user in the community, as long as the user has access to the record the task was created on. This field is available when Customer Portal or partner portal are enabled OR Communities is enabled and you have Customer Portal or partner portal licenses.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User who owns the record. Label is Assigned To ID.
Priority
Type picklist Properties Defaulted on create, Group, Sort, Create, Filter, Update Description Required. Indicates the importance or urgency of a task, such as high or low.
RecurrenceActivityId
Type reference Properties Filter, Group, Nillable, Sort Description Read-only. Not required on create. ID of the main record of the recurring task. Subsequent occurrences have the same value in this field.
RecurrenceDayOfMonth
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The day of the month in which the task repeats.
1849
Standard Objects
Field
Task
Field Type
RecurrenceDayOfWeekMask Type
int Properties Create, Filter, Group, Nillable, Sort, Update Description The day or days of the week on which the task repeats. This field contains a bitmask. The values are as follows: • Sunday = 1 • Monday = 2 • Tuesday = 4 • Wednesday = 8 • Thursday = 16 • Friday = 32 • Saturday = 64 Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 4 + 16 = 20. RecurrenceEndDateOnly
Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The last date on which the task repeats. This field has a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant; do not attempt to alter it in order to accommodate time zone differences.
RecurrenceInstance
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The frequency of the recurring task. For example, “2nd” or “3rd.”
RecurrenceInterval
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The interval between recurring tasks.
1850
Standard Objects
Task
Field
Field Type
RecurrenceMonthOfYear
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The month of the year in which the task repeats.
RecurrenceRegeneratedType Type
picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Represents what triggers a repeating task to repeat. Add this field to a page layout together with the RecurrenceInterval field, which determines the number of days between the triggering date (due date or close date) and the due date of the next repeating task in the series. Label is Repeat This Task. This field has the following picklist values: • None: The task doesn’t repeat. • After due date: The next repeating task will be due the specified number of days after the current task’s due date. • After the task is closed: The next repeating task will be due the specified number of days after the current task is closed. • (Task closed): This task, now closed, was opened as part of a repeating series. RecurrenceStartDateOnly Type
date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the recurring task begins. Must be a date and time before RecurrenceEndDateOnly. RecurrenceTimeZoneSidKey Type
picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time zone associated with the recurring task. For example, “UTC-8:00” for Pacific Standard Time. RecurrenceType
Type picklist
1851
Standard Objects
Field
Task
Field Type Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates how often the task repeats. For example, daily, weekly, or every nth month (where “nth” is defined in RecurrenceInstance).
ReminderDateTime
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Represents the time when the reminder is scheduled to fire, if IsReminderSet is set to true. If IsReminderSet is set to false, then the user may have deselected the reminder checkbox in the Salesforce user interface, or the reminder has already fired at the time indicated by the value.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. The current status of the task, such as In Progress or Completed. Each predefined Status field implies a value for the IsClosed flag. To obtain picklist values, query the TaskStatus object. Note: This field can’t be updated for recurring tasks (IsRecurrence is true).
Subject
Type combobox Properties Create, Filter, Nillable, Sort, Update Description The subject line of the task, such as “Call” or “Send Quote.” Limit: 255 characters.
TaskSubtype
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Provides standard subtypes to facilitate creating and searching for specific task subtypes. This field isn’t updateable. TaskSubtype values:
1852
Standard Objects
Field
Task
Field Type • Task • Email • Call
TaskWhoIds
Type JunctionIdList Properties Create, Update Description A string array of contact or lead IDs related to this task. This JunctionIdList field is linked to the TaskWhoRelations child relationship. TaskWhoIds is only available when the shared activities setting is enabled. The first contact or lead ID in the list becomes the primary WhoId if you don’t specify a primary WhoId. If you set the EventWhoIds field to null, all entries in the list are deleted and the value of WhoId is added as the first entry. Warning: Adding a JunctionIdList field name to the fieldsToNull property deletes all related junction records. This action can’t be undone.
Type
Type picklist Properties Create, Filter, Nillable, Update Description The type of task, such as Call or Meeting.
WhatCount
Type int Properties Filter, Group, Nillable, Sort Description Available to organizations that have Shared Activities enabled. Count of related TaskRelations pertaining to WhatId. Count of the WhatId must be 1 or less.
WhatId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The WhatId represents nonhuman objects such as accounts, opportunities, campaigns, cases, or custom objects. WhatIds are polymorphic. Polymorphic means a WhatId is equivalent to the ID of a related object. The label is Related To ID.
1853
Standard Objects
Task
Field
Field Type
WhoCount
Type int Properties Filter, Group, Nillable, Sort Description Available to organizations that have Shared Activities enabled. Count of related TaskRelations pertaining to WhoId.
WhoId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The WhoId represents a human such as a lead or a contact. WhoIds are polymorphic. Polymorphic means a WhoId is equivalent to a contact’s ID or a lead’s ID. The label is Name ID. If Shared Activities is enabled, the value of this field is the ID of the related lead or primary contact. If you add, update, or remove the WhoId field, you might encounter problems with triggers, workflows, and data validation rules that are associated with the record. The label is Name ID. Beginning in API version 37.0, if the contact or lead ID in the WhoId field is not in the TaskWhoIds list, no error occurs and the ID is added to the TaskWhoIds as the primary WhoId. If WhoId is set to null, an arbitrary ID from the existing TaskWhoIds list is promoted to the primary position.
Usage Recurring Tasks • Recurring tasks are available in API version 16.0 and later. • After a task is created, it can’t be changed from recurring to nonrecurring or vice versa. • When you delete a recurring task series through the API, all open and closed task occurrences in the series are removed. However, when you delete a recurring task series through the user interface, only open tasks occurrences (IsClosed is false) in the series are removed. • If IsRecurrence is true, then RecurrenceStartDateOnly, RecurrenceEndDateOnly, RecurrenceType, and any properties associated with the given recurrence type (see the following table) must be populated. • When you change the RecurrenceStartDateOnly field or the recurrence pattern, all open tasks occurrences in the series are deleted and new open task occurrences are created based on the new recurrence pattern. The recurrence pattern is determined by the following fields: RecurrenceType, RecurrenceTimeZoneSidKey, RecurrenceInterval, RecurrenceDayOfWeekMask, RecurrenceDayOfMonth, RecurrenceInstance, and RecurrenceMonthOfYear.
1854
Standard Objects
Task
• When you change the value of RecurrenceEndDateOnly to an earlier date (for example, from January 20th to January 10th), all open task occurrences in the series with the ActivityDate value greater than the new end date value are deleted. Other open and closed task occurrences in the series are not affected. • When you change the value of RecurrenceEndDateOnly to a later date (for example, from January 10th to January 20th), new task occurrences are created up to the new end date. Existing open and closed tasks in the series are not affected. The following table describes the usage of recurrence fields. Each recurrence type must have all of its properties set. All unused properties must be set to null. RecurrenceType Value
Properties
Example Pattern
RecursDaily
RecurrenceInterval
Every second day
RecursEveryWeekday
RecurrenceDayOfWeekMask
Every weekday - can’t be Saturday or Sunday
RecursMonthly
RecurrenceDayOfMonth RecurrenceInterval
Every second month, on the third day of the month
RecursMonthlyNth
RecurrenceInterval RecurrenceInstance Every second month, on the last Friday of the month RecurrenceDayOfWeekMask
RecursWeekly
RecurrenceInterval RecurrenceDayOfWeekMask
Every three weeks on Wednesday and Friday
RecursYearly
RecurrenceDayOfMonth RecurrenceMonthOfYear
Every March on the twenty-sixth day of the month
RecursYearlyNth
RecurrenceDayOfWeekMask The first Saturday in every October RecurrenceInstanceRecurrenceMonthOfYear
JunctionIdList The JunctionIdList field is now implemented in the Event and Task objects. With a single API call, it’s easy to create many-to-many relationships between the Event or Task object with contacts, leads, or users. To create a Task with related Contacts without JunctionIdList, you first have to create the task, then use the returned task ID to create the TaskRelation records. If the TaskRelation save call fails, error handling is your responsibility because the task has already been committed to the database. public void createTasksOld(Contact[] contacts) { Task task = new Task(); task.setSubject("New Task"); SaveResult[] results = null; try { results = connection.create(new Task[] { task }); if (results[0].isSuccess()) { TaskRelation[] relations = new TaskRelation[contacts.size()]; for (int i = 0; i < contacts.length; i++) { relations[i] = new TaskRelation(); relations[i].setTaskId(results[0].getID()); relations[i].setRelationId(contacts[i].getID()); } results = connection.create(relations);
1855
Standard Objects
TaskFeed
} } catch (ConnectionException ce) { ce.printStackTrace(); } }
To create a task using JuncionIdList, IDs are pulled from the related contacts and both the task and the TaskRelation records are created in one API call. If the TaskRelation fails, the task is rolled back because it’s all done in a single API call. public void createTaskNew(Contact[] contacts) { String[] contactIds = new String[contacts.size()]; for (int i = 0; i < contacts.size(); i++) { contactIds[i] = contacts[i].getID(); } Task task = new Task(); task.setSubject("New Task"); task.setTaskWhoIds(contactIds); SaveResult[] results = null; try { results = connection.create(new Task[] { task }); } catch (ConnectionException ce) { ce.printStackTrace(); } }
SEE ALSO: Object Basics
TaskFeed Represents a single feed item in the feed on a Task. This object is available in API version 20.0 and later.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.
1856
Standard Objects
TaskFeed
Fields Field
Details
Body
Type textarea Properties Nillable, Sort Description The content of TaskFeed. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item. Tip: In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only one. In a moderated feed, your comment isn’t counted until it's approved by an admin or a person with “CanApproveFeedPostAndComment” or “ModifyAllData” permission. This has implications for how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until end of comments is returned.
ConnectionId
Type reference Properties Filter, Group, Nillable, Sort Description When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization.
ContentData
Type base64 Properties Nillable
1857
Standard Objects
Field
TaskFeed
Details Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. This field is required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.
CreatedDate
Type dateTime Properties Defaulted on create, Filter, Sort
1858
Standard Objects
Field
TaskFeed
Details Description Date and time when this record was created. This field is a standard system field. Ordering by CreatedDateDESC sorts the feed by the most recent feed item.
FeedPostId
Type reference Properties Filter, Group, Nillable, Sort Description This field was removed in API version 22.0, and is available in earlier versions for backward compatibility only. ID of the associated FeedPost. A FeedPost represents the following types of changes in an FeedItem: changes to tracked fields, text posts, link posts, and content posts.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
IsDeleted
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Standard system field. Indicates whether the record has been moved to the Recycle Bin (true) or not (false).
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: •
1859
Standard Objects
Field
TaskFeed
Details Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example: Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation.
LastModifiedDate
Type dateTime Properties Defaulted on create, Filter, Sort Description Date and time when a user last modified this record. This field is a standard system field. When a feed item is created, LastModifiedDate is the same as CreatedDate. If a FeedComment is inserted on that feed item, then LastModifiedDate becomes the CreatedDate for that FeedComment. Deleting the FeedComment does not change the LastModifiedDate. Ordering by LastModifiedDate DESC sorts the feed by both the most recent feed item or comment.
LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url
1860
Standard Objects
Field
TaskFeed
Details Properties Nillable, Sort Description The URL of a LinkPost.
NetworkScope
Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. NetworkScope can have the following values:
• NetworkId—The ID of the community in which the FeedItem is available. If left empty, the feed item is only available in the default community. • AllNetworks—The feed item is available in all communities. Note the following exceptions for NetworkScope: • Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks. • You can’t filter a FeedItem on the NetworkScope field. ParentId
Type reference Properties Filter, Group, Sort Description ID of the account record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost.
1861
Standard Objects
TaskFeed
Field
Details
Title
Type string Properties Group, Nillable, Sort Description The title of the task record. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item: • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply.
1862
Standard Objects
Field
TaskFeed
Details • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • CaseCommentPost—generated event when a user adds a case comment for a case object • EmailMessageEvent—generated event when an email related to a case object is sent or received • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • ChangeStatusPost—generated event when a user changes the status of a case • AttachArticleEvent—generated event when a user attaches an article to a case Note: If you set Type to ContentPost, also specify ContentData and ContentFileName.
Visibility
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. Visibility can have the following values:
• AllUsers—The feed item is available to all users who have permission to see the feed item. • InternalUsers—The feed item is available to internal users only. Note the following exceptions for Visibility: • For record posts, Visibility is set to InternalUsers for all internal users by default. • External users can set Visibility only to AllUsers. • On user and group posts, only internal users can set Visibility to InternalUsers.
Usage Use this object to track changes for a task record.
1863
Standard Objects
TaskPriority
TaskPriority Represents the importance or urgency of a Task, such as High, Normal, or Low.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules Customer Portal users can't access this object.
Fields Field
Details
ApiName
Type string Properties Filter, Group, NillableSort Description Uniquely identifies a picklist value so it can be retrieved without using an id or master label.
IsDefault
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this is the default task priority value (true) or not (false) in the picklist. Only one value in the picklist can be the default value.
IsHighPriority
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this task priority value represents a high priority Task (true) or not (false). Multiple task priority values can represent a high-priority Task.
MasterLabel
Type string Properties Filter, Group, Nillable, Sort
1864
Standard Objects
Field
TaskRelation
Details Description Master label for this task priority value. This display value is the internal label that does not get translated. Limit: 255 characters.
SortOrder
Type int Properties Filter, Nillable, Group, Sort Description Number used to sort this value in the task priority picklist. These numbers are not guaranteed to be sequential, as some previous task priority values might have been deleted.
Usage This object represents a value in the task priority picklist. The task priority picklist provides additional information about the importance of a Task, such as whether a given priority value represents a high priority. Your client application can query on this object to retrieve the set of values in the task priority picklist, and then use that information while processing Task objects to determine more information about a given task. For example, the application could test whether a given Task is high priority based on its Priority value and the value of the IsHighPriority in the associated TaskPriority object. SEE ALSO: Object Basics
TaskRelation Represents the relationship between a task and a lead, contacts, and other objects related to the task. If Shared Activities is enabled, this object doesn’t support triggers, workflow, or data validation rules. This object is available in API version 24.0 and later. TaskRelation is only available if you’ve enabled Shared Activities in your organization. TaskRelation allows the following relationships: • A task can be related to one lead or up to 50 contacts. • A task can also be related to one account, asset, campaign, case, contract, opportunity, product, solution, or custom object.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), queryAll(), retrieve()
1865
Standard Objects
TaskRelation
Fields Field Name
Details
AccountId
Type reference Properties Filter, Group, Nillable, Sort Description Indicates the Account ID of the relation. For information on IDs, see ID Field Type.
IsDeleted
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a task has been deleted; label is Deleted. When a TaskRelation record is deleted, it isn’t moved to the Recycle Bin and can’t be undeleted, unless the record was cascade-deleted when the parent object was deleted. Don’t use the IsDeleted field to detect deleted records in SOQL queries or queryAll() calls on directly deleted relation records. Instead, use the call getDeleted().
IsWhat
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the relation is an Account, Opportunity, Campaign, Case, other standard object, or a custom object. Value is false if RelationId is a contact or lead and true otherwise.
RelationId
Type reference Properties Create, Filter, Group, Sort Description Indicates the WhatId or WhoId in the relationship. For more information, see Task. For information on IDs, see ID Field Type.
TaskId
Type reference
1866
Standard Objects
Field Name
TaskStatus
Details Properties Create, Filter, Group, Sort Description Represents the ID of the associated Task. For information on IDs, see ID Field Type.
Usage See contacts associated with a task public void queryWhosOfTaskSample() { String soqlQuery = "SELECT Id, Subject, (SELECT RelationId, Relation.Name, IsWhat from TaskRelations WHERE isWhat = false) FROM Task WHERE Id = '00T x0000005OKEN'"; QueryResult qResult = null; try { qResult = connection.query(soqlQuery); TaskRelation relation1 = (TaskRelation)qResult.getRecords()[0].getTaskRelations().getRecords()[0]; }catch (ConnectionException ce) { ce.printStackTrace(); } }
SEE ALSO: Task TaskWhoRelation
TaskStatus Represents the status of a Task, such as Not Started, Completed, or Closed.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules Customer Portal users can't access this object.
1867
Standard Objects
TaskStatus
Fields Field
Details
ApiName
Type string Properties Filter, Group, NillableSort Description Uniquely identifies a picklist value so it can be retrieved without using an id or master label.
IsClosed
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this task status value represents a closed Task (true) or not (false). Multiple task status values can represent a closed Task.
IsDefault
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this is the default task status value (true) or not (false) in the picklist.
MasterLabel
Type string Properties Filter, Group, Nillable, Sort Description Master label for this task status value. This display value is the internal label that does not get translated. Limit: 255 characters.
SortOrder
Type int Properties Filter, Group, Nillable, Sort Description Number used to sort this value in the task status picklist. These numbers are not guaranteed to be sequential, as some previous task status values might have been deleted.
1868
Standard Objects
TaskTag
Usage This object represents a value in the task status picklist. The task status picklist provides additional information about the status of a Task, such as whether a given status value represents an open or closed task. Your client application can query this object to retrieve the set of values in the task status picklist, and then use that information while processing Task records to determine more information about a given task. For example, the application could test whether a given task is open or closed based on the Task Status value and the value of the IsClosed property in the associated TaskStatus record. SEE ALSO: Object Basics
TaskTag Associates a word or short phrase with a Task.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve()
Fields Field Name
Details
ItemId
Type reference Properties Create, Filter Description ID of the tagged item.
Name
Type string Properties Create, Filter Description Name of the tag. If this value does not already exist, a new TagDefinition is created and becomes the parent of this Tag object. Otherwise, a TagDefinition with the same name becomes the parent of this Tag object. Parent relationships are created automatically.
TagDefinitionId
Type reference Properties Filter
1869
Standard Objects
Field Name
TaskWhoRelation
Details Description ID of the parent TagDefinition object that owns the tag.
Type
Type picklist Properties Create, Filter, Restricted picklist Description Defines the visibility of a tag. Valid values: • Public—The tag can be viewed and manipulated by all users in an organization. • Personal—The tag can be viewed or manipulated only by a user with a matching OwnerId.
Usage TaskTag stores the relationship between its parent TagDefinition and the Task being tagged. Tag objects act as metadata, allowing users to describe and organize their data. When a tag is deleted, its parent TagDefinition will also be deleted if the name is not being used; otherwise, the parent remains. Deleting a TagDefinition sends it to the Recycle Bin, along with any associated tag entries.
TaskWhoRelation Represents the relationship between a task and a lead or contacts. This object is available in API version 29.0 and later. This derived object is a filtered version of the TaskRelation on page 1865 object; that is, IsParent is true and IsWhat is false. It doesn’t represent relationships to accounts, opportunities, or other objects. TaskWhoRelation allows a variable number of relationships: one lead or up to 50 contacts. Available only if you’ve enabled Shared Activities for your organization.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
RelationId
Type reference
1870
Standard Objects
Field Name
TaskWhoRelation
Details Properties Filter, Group, Nillable, Sort Description Indicates the ID of the contacts or lead related to the task.
TaskId
Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the task.
Type
Type string Properties Filter, Group, Nillable, Sort Description Indicates whether the person related to the task is a lead or contact.
Usage Apex example that queries contacts associated with a task public void queryWhosOfTaskSample() { String soqlQuery = "SELECT Id, Subject, (SELECT RelationId, Relation.Name, IsWhat from TaskWhoRelations) FROM Task WHERE Id = '00Tx0000005OKEN'"; QueryResult qResult = null; try { qResult = connection.query(soqlQuery); TaskWhoRelation relation1 = (TaskWhoRelation)qResult.getRecords()[0].getTaskWhoRelations().getRecords()[0]; } catch (ConnectionException ce) { ce.printStackTrace(); } }
SEE ALSO: Task TaskRelation
1871
Standard Objects
TenantSecret
TenantSecret This object stores an encrypted organization-specific key fragment that is used with the master secret to produce organization-specific data encryption keys. This object is available in API version 34.0 and later. You can rotate tenant secrets of the Data type once every four hours in a sandbox org or every 24 hours in production orgs. You can rotate tenant secrets of the SearchIndex type once every seven days. Note: This information is about Shield Platform Encryption and not Classic Encryption.
Supported Calls create(), query(), retrieve(), update()
Fields Field Name
Details
Description
Type string Properties Create, Nillable, Update Description The description of the tenant secret.
SecretValue
Type base64 Properties Nillable, Update Description The encrypted 256-bit secret value encoded in base64.
SecretValueCertificate
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The certificate needed to upload a customer-supplied tenant secret. Each certificate has a unique name.
SecretValueHash
Type base64 Properties Create
1872
Standard Objects
Field Name
TenantSecret
Details Description The matching tenant secret hash for an uploaded customer-supplied tenant secret.
Status
Type Restricted picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The current status of the tenant secret. Values are: ACTIVE Can be used to encrypt and decrypt new or existing data. ARCHIVED Cannot encrypt new data. Can be used to decrypt data previously encrypted with this key when it was active. DESTROYED Cannot encrypt or decrypt data. Data encrypted with this key when it was active can no longer be decrypted. Files and attachments encrypted with this key can no longer be downloaded.
Type
Type Restricted picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of tenant secret. The Type field is available in API version 39.0 and later. The following values appear in the Type picklist: • Data—data stored in the Salesforce database. Includes data in encrypted fields, files, and attachments but not search index files. Tenant secrets created in API version 34.0 and later default to the Data type. • SearchIndex—search index files (available in API version 39.0 and later).
Version
Type int Properties Filter, Group, idLookup, Sort Description The version number of this secret. The version number is unique within your org.
1873
Standard Objects
TenantSecret
Usage Use this object to create or update an org-specific tenant secret. For example, you can build an automated tenant secret creation and activation solution similar to the following. 1. Start by creating an Apex class to create the new tenant secret. Specify the value of the tenant secret to encrypt data of a particular type. global class CreateNewSecret implements Schedulable { global void execute(SchedulableContext SC) { TenantSecret secret = new TenantSecret (); secret.description = 'Created new secret from scheduled job'; secret.type= ‘SearchIndex’; insert secret; } }
Note: Type is available in API version 39.0 and later. Type is optional; all tenant secrets default to the Data type. 2. Schedule the Apex class to run at the specified interval. This Apex code only needs to be run a single time to schedule the job. This code runs the job every 90 days. CreateNewSecret secret = new CreateNewSecret(); String schedule = '0 0 0 1 JAN,APR,JUL,OCT ?'; String jobID = system.schedule('Automated secret creation and activation', schedule, secret);
3. Validate that the job is scheduled. 4. Validate that tenant secrets are created after the job is run. You can also upload a customer-supplied tenant secret. 1. Create a certificate that is compatible with customer-supplied (BYOK) tenant secrets. See “Generate a BYOK-Compatible Certificate” in the Platform Encryption REST API Developer Guide. 2. Then upload your matching tenant secret and tenant secret hash. Include the unique name of the compatible certificate. The tenant secret is uploaded in encrypted form. TenantSecret secret = new TenantSecret (); secret.description = 'New uploaded secret'; secret.type= ‘Data’; secret.SecretValue = ... EncodingUtil.base64Decode('...');; secret.SecretValueCertificate = ...; secret.SecretValueHash = ... EncodingUtil.base64Decode('...'); insert secret;
You can use this script to generate a customer-supplied tenant secret and tenant secret hash. 3. Validate that the tenant secret is uploaded.
1874
Standard Objects
Territory
Here’s an example of how to import a tenant secret of the Data type. TenantSecret secret = [SELECT Id FROM TenantSecret WHERE Type = ‘Data’ AND Version = 2]; secret.SecretValue = “"; update secret;
You can also export a tenant secret by writing the secret.SecretValue to a file. Here’s an example that uses a tenant secret of the SearchIndex type. TenantSecret secret = [SELECT SecretValue FROM TenantSecret WHERE Type = ‘TenantSecret’ AND Version = 2]; secret.SecretValue =...; update secret;
Here’s an example of how to destroy a tenant secret of the Data type. Warning: Your tenant secret is unique to your organization and to the specific data to which it applies. Once you destroy a tenant secret, related data is not accessible unless you previously exported the key and then import the key back into Salesforce. TenantSecret secret = [SELECT Id FROM TenantSecret WHERE Type = ‘Data’ AND Version = 2]; secret.SecretValue = NULL; update secret;
Territory Represents a flexible collection of accounts and users where the users have at least read access to the accounts, regardless of who owns the accounts. Only available if territory management has been enabled for your organization.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Fields Field
Details
AccountAccessLevel
Type picklist Properties Create, Filter, Group, Sort, Update Description Account access level granted to users assigned to this territory.
CaseAccessLevel
Type picklist Properties Create, Filter, Nillable, Group, Sort, Update
1875
Standard Objects
Field
Territory
Details Description Case access level granted to users assigned to this territory.
ContactAccessLevel
Type picklist Properties Filter, Group, Nillable, Sort Description A value that represents the type of access granted to the target Group, UserRole, or User for any associated contacts. The possible values are: • None • Read • Edit Note: When DefaultContactAccess is set to “Controlled by Parent,” you can’t create or update this field.
Description
Type string Properties Create, Filter, Nillable, Sort, Update Description A description of the territory that is 1,000 characters or less.
DeveloperName
Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update 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. Corresponds to Territory Name in the user interface. This field is available in API version 24.0 and later. Note: 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.
1876
Standard Objects
Territory
Field
Details
ForecastUserId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the Forecast Manager, who is the user to whom forecasts from this territory’s child territories roll up.
MayForecastManagerShare
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the forecast manager can manually share their own forecast.
Name
Type string Properties Create, Filter, Group, Sort, Update Description A name for the territory. Limit is 80 characters. Corresponds to Label on the user interface.
OpportunityAccessLevel
Type picklist Properties Create, Filter, Group, Sort, Update Description Opportunity access level granted to users assigned to this territory.
ParentTerritoryID
Type reference Properties Create, Filter, Nillable, Update Description Territory immediately above this territory in the territory hierarchy. Label is Parent Territory ID.
RestrictOppTransfer
Type boolean Properties Create, Defaulted on create, Filter, Update
1877
Standard Objects
Field
Territory2
Details Description Indicates whether the opportunities associated with this territory are kept within the bounds of this territory and this territory’s children when account assignment rules are run (true), or if opportunities associated with this territory can be assigned to other nodes of the territory hierarchy when account assignment rules are run (false). Label is Confine Opportunity Assignment.
Usage Use the Territory object to query your organization’s territory hierarchy. Use it to obtain valid territory IDs when querying or modifying records associated with territories. SEE ALSO: AccountTerritoryAssignmentRule AccountTerritoryAssignmentRuleItem UserTerritory
Territory2 Represents a sales territory. Available only if Enterprise Territory Management has been enabled for your organization.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert()
Special Access Rules If a territory model is in Active state, any user can view that model, including its territories and assignment rules. For territories in an active model, any user can view assigned records and assigned users subject to your organization’s sharing settings. Users cannot view territory models in other states (such as Planning or Archived).
Fields Field Name
Details
AccountAccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update
1878
Standard Objects
Field Name
Territory2
Details Description Represents the default account record access levels for users that are assigned to the territory. Values are: • Read Only • Read/Write • Owner
CaseAccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Represents the default case record access levels for users that are assigned to the territory. Values are: • Private • Read Only • Read/Write
ContactAccessLevel
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Represents the default contact record access levels for users that are assigned to the territory. Values are: • Private • Read Only • Read/Write
Description
Type string Properties Create, Filter, Nillable, Sort, Update Description The description of the territory.
DeveloperName
Type string Properties Create, Filter, Group, Sort, Update
1879
Standard Objects
Field Name
Territory2
Details Description Required. 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. The field label in the user interface is Territory Name. Note: 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.
Name
Type string Properties Create, Filter, Group, Sort, Update Description The name of the territory. The field label in the user interface is Label.
OpportunityAccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Represents the default opportunity record access levels for users that are assigned to the territory. Values are: • Private • Read Only • Read/Write
ParentTerritory2Id
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the territory’s parent territory (if any). If the territory has no parent territory, this value is null.
Territory2ModelId
Type reference Properties Create, Filter, Group, Sort Description The ID of the territory model that the territory belongs to.
1880
Standard Objects
Territory2Model
Field Name
Details
Territory2TypeId
Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the territory type that the territory belongs to.
Territory2Model Represents a territory model. Available only if Enterprise Territory Management has been enabled for your organization.
Supported Calls create(),delete(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),update(),upsert()
Special Access Rules If a territory model is in Active state, any user can view that model, including its territories and assignment rules. For territories in an active model, any user can view assigned records and assigned users subject to your organization’s sharing settings. Users cannot view territory models in other states (such as Planning or Archived).
Fields Field Name
Details
ActivatedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the territory model was activated.
DeactivatedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the territory model was archived.
Description
Type textarea
1881
Standard Objects
Field Name
Territory2Model
Details Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the territory model.
DeveloperName
Type string Properties Create, Filter, Group, Sort, Update Description Required. 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. The field label in the user interface is Territory Model Name. Note: 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.
LastOppTerrAssignEndDate
Type dateTime Properties Filter, Nillable, Sort Description Read-only. The date when the opportunity territory assignment filter was last run. Used for Filter-Based Opportunity Territory Assignment (Pilot in Spring ’15 / API version 33).
LastRunRulesEndDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the last rules run was completed.
Name
Type string Properties Create, Filter, Group, Sort, Update Description The territory model name. The field label in the user interface is Label.
1882
Standard Objects
Territory2ModelHistory
Field Name
Details
State
Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The state of the territory model. Values are: Planning, Activating, Activation Failed, Active, Archiving, Archiving Failed, Archived, Deleting, and Deletion Failed.
Territory2ModelHistory Represents the history of changes to the values in the fields on a territory model. Available only if Enterprise Territory Management has been enabled for your organization.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field whose value was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the changed field.
OldValue
Type anyType Properties Nillable, Sort
1883
Standard Objects
Field Name
Territory2Type
Details Description The previous value of the changed field.
Territory2ModelId
Type reference Properties Filter, Group, Sort Description The ID of the territory model whose history is tracked.
Usage This object is automatically generated whenever any field value changes on a territory model record. Use this object it to identify those changes.
Territory2Type Represents a category for territories (Territory2). Every Territory2 must have a Territory2Type. Available only if Enterprise Territory Management has been enabled for your organization.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Special Access Rules All users (including standard users) have access to this object in the user interface
Fields Field Name
Details
Description
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the territory type.
DeveloperName
Type string
1884
Standard Objects
Field Name
Territory2Type
Details Properties Create, Filter, Group, Sort, Update Description Required. 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. The field label in the user interface is Territory Type Name. Note: 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.
Language
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the master label in the user interface.
MasterLabel
Type string Properties Create, Filter, Group, Sort, Update Description Required The user interface label for the territory type.
Priority
Type int Properties Create, Filter, Group, SortUpdate Description Required. Used for Filter-Based Opportunity Territory Assignment (Pilot in Spring ’15 / API version 33). Lets you specify a priority for a territory type. For opportunity assignments, the filter examines all territories assigned to the account that the opportunity is assigned to. The account-assigned territory whose territory type priority is highest is then assigned to the opportunity. The priority field value on each territory type must be unique. Further, if there are multiple territories with the same territory type (and therefore the same priority) assigned to the account, no territory is assigned to the opportunity.
1885
Standard Objects
TestSuiteMembership
TestSuiteMembership Associates an Apex class with an ApexTestSuite. This object is available in API version 36.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Description
ApexClassId
Type reference Properties Create, Filter, Group, Sort Description The Apex class whose tests are to be executed.
ApexTestSuiteId
Type reference Properties Create, Filter, Group, Sort Description The test suite to which the Apex class is assigned.
Usage Insert a TestSuiteMembership object using an API call to associate an Apex class with an ApexTestSuite object. (ApexTestSuite and TestSuiteMembership aren’t editable through Apex DML.) To remove the class from the test suite, delete the TestSuiteMembership object. If you delete an Apex test class or test suite, all TestSuiteMembership objects that contain that class or suite are deleted. The following SOQL query returns the membership object that relates this Apex class to this test suite. SELECT Id FROM TestSuiteMembership WHERE ApexClassId = '01pD0000000Fhy9IAC' AND ApexTestSuiteId = '05FD00000004CDBMA2'
SEE ALSO: ApexTestSuite
ThirdPartyAccountLink Represents the list of external users who authenticated using an Auth. Provider. This object is available in API version 32.0 and later.
1886
Standard Objects
ThirdPartyAccountLink
A list of third-party account links is generated when users of an organization authenticate using an external Auth. Provider. Use this object to list and revoke a given user's social sign-on connections (such as Facebook©).
Supported Calls describeSObjects(), query()
Fields Field Name
Details
Handle
Type string Properties Filter, Nillable, Sort Description The username in the third-party system.
IsNotSsoUsable
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Support for single sign-on. If true, the link cannot be used for a single sign-on flow. It is only available OAuth access and refresh tokens.
Provider
Type string Properties Filter, Group, Nillable, Sort Description The third-party account provider name.
RemoteIdentifier
Type string Properties Filter, Group, Nillable, Sort Description The unique ID for the user in the third-party system.
SsoProvider
Type AuthProvider on page 259
1887
Standard Objects
Field Name
ThirdPartyAccountLink
Details Properties Filter, Group, Nillable, Sort Description The foreign key to the AuthProvider of the third-party system.
SsoProviderId
Type reference Properties Filter, Group, Nillable, Sort Description The ID associated with the SsoProvider value.
SsoProviderName
Type string Properties Filter, Group, Nillable, Sort Description The name associated with the AuthProvider of the third-party system, in case the user has no access to the provider foreign key (the SsoProvider value).
ThirdPartyAccountLinkKey
Type string Properties Filter, Group, Nillable, Sort Description A concatenated string including the organization ID, the SsoProviderId value, the SsoProvider value, and the RemoteIdentifier value.
UserId
Type reference Properties Filter, Group, Nillable, Sort Description The Salesforceuser associated with this third-party account link.
Usage Use this object makes to build custom screens to manage a user’s third-party account links. Administrators (with the “Manage Users” permission) querying this object can see all the links for all users in the organization. Without the “Manage Users” permission, users can only retrieve thier own links. A user may not have access to the SsoProvider value (the foreign key). In this case, use the SsoProviderName to render the name of the provider for the associated link.
1888
Standard Objects
TimeSheet
Use the Apex method Auth.AuthToken.revokeAccess() to revoke a link. In API version 34.0 and later, this object was enhanced to help manage high instance counts. A query() call returns up to 500 rows. A queryMore() call returns 500 more, up to 2500 total. No more records are returned after 2500. To make sure you don’t miss any records, issue a COUNT() query in a SELECT clause for ThirdPartyAccountLink. This gives you the total number of records. If there are more than 2500 records, divide your query by filtering on fields, like UserId, to return subsets of less than 2500 records.
TimeSheet Represents a schedule of a service resource’s time in field service. Time sheets are composed of time sheet entries, which typically track individual tasks like travel or asset repair.
Supported Calls create()delete() , describeLayout() , describeSObjects() , getDeleted() , getUpdated() , query() , retrieve() , search() , undelete() , update() , upsert() ,
Special Access Rules Field Service Lightning must be enabled in your org.
Fields Field Name
Details
EndDate
Type date Properties Create, Filter, Group, Sort, Update Description The last day the time sheet covers.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort
1889
Standard Objects
Field Name
TimeSheet
Details Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the time sheet.
ServiceResourceId
Type reference Properties Create, Filter, Group, Sort, Update Description The service resource whose time is being tracked with the time sheet.
StartDate
Type date Properties Create, Filter, Group, Sort, Update Description The first day the time sheet covers.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the time sheet. The picklist includes the following values, which can be customized: • New • Submitted • Approved
TimeSheetEntryCount
Type int Properties Filter, Group, Nillable, Sort
1890
Standard Objects
Field Name
TimeSheetEntry
Details Description (Read Only) The number of related time sheet entries.
TimeSheetNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-generated number identifying the time sheet.
TimeSheetEntry Represents a span of time that a service resource spends on a field service task. Time sheets are composed of time sheet entries. Time sheet entries typically track individual tasks like travel or asset repair.
Supported Calls create()delete() , describeLayout() , describeSObjects() , getDeleted() , getUpdated() , query() , retrieve() , search() , undelete() , update() , upsert() ,
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Description
Type textarea Properties Create, Nillable, Update Description Notes on how the time was spent. For example, “This service took longer than normal because the machine was jammed.”
EndTime
Type dateTime Properties Create, Filter, Nillable, Sort, Update
1891
Standard Objects
Field Name
TimeSheetEntry
Details Description The date and time the activity finished.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
StartTime
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time the activity began.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the time sheet entry. The picklist includes the following values, which can be customized: • New • Submitted • Approved
Subject
Type string Properties Create, Filter, Group, Nillable, Sort, Update
1892
Standard Objects
Field Name
TimeSheetEntry
Details Description Activity performed; for example, repair, lunch, or travel.
TimeSheetEntryNumber
Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-generated number identifying the time sheet entry.
TimeSheetId
Type reference Properties Create, Filter, Group, Sort Description The time sheet associated with the time sheet entry.
Type
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The type of work performed. The picklist includes the following values, which can be customized: • Direct • Indirect
WorkOrderId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order related to the time sheet entry. Work orders are searchable by their content.
WorkOrderLineItemId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order line item related to the time sheet entry. Work order line items are searchable by their content.
1893
Standard Objects
TimeSheetEntryFeed
TimeSheetEntryFeed Represents a single feed item on a time sheet entry record detail page.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the TimeSheetEntry object • “Moderate Chatter”
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
1894
Standard Objects
TimeSheetEntryFeed
Field Name
Details
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a link post.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the time sheet entry record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort
1895
Standard Objects
Field Name
TimeSheetEntryHistory
Details Description The title of the feed item. When the Type is LinkPost, the LinkURL field is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
TimeSheetEntryHistory Represents the history of changes made to tracked fields on a time sheet entry in field service.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
1896
Standard Objects
TimeSheetFeed
Field Name
Details
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
TimeSheetEntryId
Type reference Properties Filter, Group, Sort Description ID of the time sheet entry being tracked. The history is displayed on the detail page for this record.
TimeSheetFeed Represents a single feed item on a time sheet record detail page.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the TimeSheet object • “Moderate Chatter”
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort
1897
Standard Objects
Field Name
TimeSheetFeed
Details Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a link post.
1898
Standard Objects
TimeSheetHistory
Field Name
Details
ParentId
Type reference Properties Filter, Group, Sort Description ID of the time sheet record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the LinkURL field is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
TimeSheetHistory Represents the history of changes made to tracked fields on a time sheet in field service.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
1899
Standard Objects
TimeSheetOwnerSharingRule
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
TimeSheetId
Type reference Properties Filter, Group, Sort Description ID of the time sheet being tracked. The history is displayed on the detail page for this record.
TimeSheetOwnerSharingRule Represents the rules for sharing a time sheet with user records other than the owner or anyone above the owner in the role hierarchy.
1900
Standard Objects
TimeSheetOwnerSharingRule
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled. Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer support to enable access to this object for your org.
Fields Field
Details
Description
Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters.
DeveloperName
Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update 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. Corresponds to Rule Name in the user interface. Note: 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.
GroupId
Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group. A time sheet owned by a User in the source Group triggers the rule to give access.
1901
Standard Objects
TimeSheetShare
Field
Details
Name
Type string Properties Create, Filter, Group, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to Label on the user interface.
ServiceResourceAccessLevel Type
picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of access granted to the target Group, or UserRole. The possible values are: • Read • Edit • All UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description The ID representing the User or Group being granted access.
TimeSheetShare Represents a sharing entry on a field service time sheet.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Special Access Rules Field Service Lightning must be enabled.
1902
Standard Objects
TimeSheetShare
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the time sheet. The possible values are: • Read • Edit • All (This value isn’t valid for create or update calls.) Set to an access level that is at least equal to the organization’s default time sheet access level.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The time sheet associated with the sharing entry.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The reason why this sharing entry exists. You can write to this field only when its value is omitted or set to Manual (default). Valid values include: • Manual—The user or group has access because a user with “All” access manually shared the time sheet. • Owner—The user is the owner of the time sheet. • Team—The user or group has team access. • Rule—The user or group has access via a time sheet sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description (Read only) ID of the user or group that has access to the time sheet.
1903
Standard Objects
TimeSlot
TimeSlot Represents a period of time on a specified day of the week during which field service work can be performed. Operating hours consist of one or more time slots. This object is available in API version 38.0 and later.
Supported Calls create(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
DayOfWeek
Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The day of the week when the time slot takes place.
EndTime
Type time Properties Create, Filter, Sort, Update Description The time when the time slot ends.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
1904
Standard Objects
TimeSlot
Field Name
Details
OperatingHoursId
Type reference Properties Create, Filter, Group, Sort Description The operating hours that the time slot belongs to. An operating hours’ time slots appear in the Operating Hours related list.
StartTime
Type time Properties Create, Filter, Sort, Update Description The time when the time slot starts.
TimeSlotNumber
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the time slot. The name is auto-populated to a day and time format—for example, Monday 9:00 AM - 10:00 PM—but you can manually update it if you wish.
Type
Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The type of time slot. Possible values are Normal and Extended. You may choose to use Extended to represent overtime shifts.
Usage Operating hours are comprised of time slots, which indicate the hours of operation for a particular day. After you create operating hours, create time slots for each day in the Time Slots related list. For example, if the operating hours should be 8 AM to 5 PM Monday through Friday, create five time slots, one per day. To reflect breaks such as lunch hours, create multiple time slots in a day: for example, Monday 8:00 AM – 12:00 PM and Monday 1:00 PM – 5:00 PM. Tip: Time slots don’t come with any built-in rules, but you can create Apex triggers that limit time slot settings in your org. For example, you may want to restrict the start and end times on time slots to half-hour increments, or to prohibit end times later than 8 PM.
1905
Standard Objects
TimeSlotHistory
TimeSlotHistory Represents the history of changes made to tracked fields on a time slot. This object is available in API version 38.0 and later.
Supported Calls getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and field tracking for time slot fields must be configured.
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
TimeSlotId
Type reference Properties Filter, Group, Sort
1906
Standard Objects
Field Name
Topic
Details Description ID of the time slot being tracked. The history is displayed on the detail page for this record.
Topic Represents a topic on a Chatter post or record. This object is available in API version 28.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), search(), update(), upsert()
Fields Field Name
Details
Description
Type string Properties Create, Filter, Nillable, Sort, Update Description Description of the topic.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Note: You can change only the spacing and capitalization of a topic name with the update property. Description Name of the topic.
NetworkId
Type reference Properties Create, Filter, Group, Nillable, Sort Description Identifier of the community to which the Topic belongs. This field is available only if Salesforce Communities is enabled in your organization.
1907
Standard Objects
TopicAssignment
Field Name
Details
TalkingAbout
Type int Properties Filter, Group, Sort Description Number of people talking about the topic over the last two months, based on factors such as topic additions and comments on posts with the topic.
Usage Use this object to query a specific topic or to get a list of all topics, even those used solely in private groups and on records, and the number of people talking about them. Use this object to create, edit, or delete topics. To create a topic, you must have the “Create Topics” permission. To edit a topic, you must have the “Edit Topics” permission. To delete a topic, you must have the ”Delete Topics” or “Modify All Data” permission.
TopicAssignment Represents the assignment of a topic to a specific feed item, record, or file. This object is available in API version 28.0 and later. Administrators must enable topics for objects before users can add topics to records of that object type. Topics for most objects are available in API version 30.0 and later. Topics for ContentDocument are available in API version 37.0 and later.
Supported Calls create(), describeSObjects(), query(), retrieve()
Fields Field Name
Details
EntityId
Type reference Properties Create, Filter, Group, Sort Description Identifier of the feed item, record, or file.
EntityKeyPrefix
Type string Properties Filter, Group, idLookup, Sort
1908
Standard Objects
Field Name
TopicAssignment
Details Description The first three digits of the EntityID field, which identify the object type (account, opportunity, etc). This read-only field is available in API version 32.0 and later. Interface label is “Record Key Prefix,” which appears only in reports.
EntityType
Type string Properties Filter, Group, Nillable, Sort Description The standard name for the object type (account, opportunity, etc). This read-only field is available in API version 33.0 and later. Interface label is “Object Type,” which appears only in reports. Tip: In most cases, you should use this field rather than EntityKeyPrefix, which exists primarily to support older reports.
NetworkId
Type reference Properties Create, Filter, Group, Nillable, Sort Description Identifier of the community to which the TopicAssignment belongs. This field is available only if Salesforce Communities is enabled in your organization.
TopicId
Type reference Properties Create, Filter, Group, Sort Description Identifier of the topic.
Usage Use this object to query the assignments of topics to feed items, records, or files. To assign or remove topics, you must have the “Assign Topics” permission. In SOQL SELECT syntax, this object supports nested semi-joins, allowing queries on Knowledge articles assigned to specific topics. For example: SELECT parentId FROM KnowledgeArticleViewStat WHERE parentId in (SELECT KnowledgeArticleId FROM KnowledgeArticleVersion
1909
Standard Objects
TopicFeed
WHERE publishStatus = 'Online' AND language = 'en_US' AND Id in (select EntityId from TopicAssignment where TopicId ='0T0xx0000000xxx'))
No SOQL limit if logged-in user has “View All Data” permission. If not, do one of the following: • Specify a LIMIT clause of 1,100 records or fewer. • Filter on Id or Entity when using a WHERE clause with "=". SEE ALSO: Topic FeedItem
TopicFeed Represents a single feed item on a topic page. This object is available in API version 29.0 and later.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content of the FeedItem. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int
1910
Standard Objects
Field Name
TopicFeed
Details Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item.
ConnectionId
Type reference Properties Filter, Group, Nillable, Sort Description When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
1911
Standard Objects
TopicFeed
Field Name
Details
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. This field is the size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. This field is the MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. •
1912
Standard Objects
Field Name
TopicFeed
Details • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
NetworkScope
Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. NetworkScope can have the following values:
• NetworkId—The ID of the community in which the FeedItem is available. If left empty, the feed item is only available in the default community.
1913
Standard Objects
Field Name
TopicFeed
Details • AllNetworks—The feed item is available in all communities. Note the following exceptions for NetworkScope: • Only feed items with a CollaborationGroup or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the topic.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. For Work.com thanks posts, it’s the ID of the WorkThanks object associated with a RypplePost. This field is typically null for all posts except ContentPost and RypplePost.
Title
Type string Properties Group, Nillable, Sort Description The title of the FeedItem. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of FeedItem: • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email
1914
Standard Objects
Field Name
TopicFeed
Details tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • AttachArticleEvent—generated event when a user attaches an article to a case. • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event.
1915
Standard Objects
Field Name
TopicLocalization—Beta
Details • CaseCommentPost—generated event when a user adds a case comment for a case object. • ChangeStatusPost—generated event when a user changes the status of a case. • ChatTranscriptPost—generated event when Live Agent transcript is saved to a case. • EmailMessageEvent—generated event when an email related to a case object is sent or received. • FacebookPost—generated when a Facebook post is created from a case. Deprecated. • MilestoneEvent—generated when a case milestone is completed or reaches violation status. • SocialPost—generated when a social post is created from a case. Note: If you set Type to ContentPost, also specify ContentData and ContentFileName.
Visibility
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. Visibility can have the following values:
• AllUsers—The feed item is available to all users who have permission to see the feed item. • InternalUsers—The feed item is available to internal users only. Note the following exceptions for Visibility: • For record posts, Visibility is set to InternalUsers for all internal users by default. • External users can set Visibility only to AllUsers. • On user and group posts, only internal users can set Visibility to InternalUsers.
TopicLocalization—Beta Represents the translated version of a topic name. Topic localization applies only to navigational and featured topics in communities. This object is available in API version 33.0 and later.
1916
Standard Objects
TopicLocalization—Beta
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Special Access Rules Users with the Translation Workbench enabled can view topic translations, but the “Customize Application,” “Manage Translation,” or “Manage Categories” permission is required to create or update them.
Fields Field Name
Details
Language
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The combined language and locale ISO code, which controls the language for labels displayed in an application. (The values in this field are not related to the default locale selection.) This picklist contains the following fully-supported languages: • Chinese (Simplified): zh_CN • Chinese (Traditional): zh_TW • Danish: da • Dutch: nl_NL • English: en_US • Finnish: fi • French: fr • German: de • Italian: it • Japanese: ja • Korean: ko • Norwegian: no • Portuguese (Brazil): pt_BR • Russian: ru • Spanish: es • Spanish (Mexico): es_MX • Swedish: sv • Thai: th The following end-user only languages are available. • Arabic: ar
1917
Standard Objects
Field Name
TopicLocalization—Beta
Details • Bulgarian: bg • Croatian: hr • Czech: cs • English (UK): en_GB • Greek: el • Hebrew: iw • Hungarian: hu • Indonesian: in • Polish: pl • Portuguese (Portugal): pt_PT • Romanian: ro • Slovak: sk • Slovenian: sl • Turkish: tr • Ukrainian: uk • Vietnamese: vi The following platform languages are available for organizations that use Salesforce exclusively as a platform. • Albanian: sq • Arabic (Algeria): ar_DZ • Arabic (Bahrain): ar_BH • Arabic (Egypt): ar_EG • Arabic (Iraq): ar_IQ • Arabic (Jordan): ar_JO • Arabic (Kuwait): ar_KW • Arabic (Lebanon): ar_LB • Arabic (Libya): ar_LY • Arabic (Morocco): ar_MA • Arabic (Oman): ar_OM • Arabic (Qatar): ar_QA • Arabic (Saudi Arabia): ar_SA • Arabic (Sudan): ar_SD • Arabic (Syria): ar_SY • Arabic (Tunisia): ar_TN • Arabic (United Arab Emirates): ar_AE • Arabic (Yemen): ar_YE • Armenian: hy • Basque: eu
1918
Standard Objects
Field Name
TopicLocalization—Beta
Details • Bosnian: bs • Bengali: bn • Chinese (Simplified—Singapore): zh_SG • Chinese (Traditional—Hong Kong): zh_HK • Dutch (Belgium): nl_BE • English (Australia): en_AU • English (Canada): en_CA • English (Hong Kong): en_HK • English (India): en_IN • English (Ireland): en_IE • English (Malaysia): en_MY • English (Philippines): en_PH • English (Singapore): en_SG • English (South Africa): en_ZA • Estonian: et • French (Belgium): fr_BE • French (Canada): fr_CA • French (Luxembourg): fr_LU • French (Switzerland): fr_CH • Georgian: ka • German (Austria): de_AT • German (Belgium): de_BE • German (Luxembourg): de_LU • German (Switzerland): de_CH • Hindi: hi • Icelandic: is • Irish: ga • Italian (Switzerland): it_CH • Latvian: lv • Lithuanian: lt • Luxembourgish: lb • Macedonian: mk • Malay: ms • Maltese: mt • Romanian (Moldova): ro_MD • Montenegrin: sh_ME • Romansh: rm • Serbian (Cyrillic): sr
1919
Standard Objects
Field Name
TopicLocalization—Beta
Details • Serbian (Latin): sh • Spanish (Argentina): es_AR • Spanish (Bolivia): es_BO • Spanish (Chile): es_CL • Spanish (Colombia): es_CO • Spanish (Costa Rica): es_CR • Spanish (Dominican Republic): es_DO • Spanish (Ecuador): es_EC • Spanish (El Salvador): es_SV • Spanish (Guatemala): es_GT • Spanish (Honduras): es_HN • Spanish (Nicaragua): es_NI • Spanish (Panama): es_PA • Spanish (Paraguay): es_PY • Spanish (Peru): es_PE • Spanish (Puerto Rico): es_PR • Spanish (United States): es_US • Spanish (Uruguay): es_UY • Spanish (Venezuela): es_VE • Tagalog: tl • Tamil: ta • Urdu: ur • Welsh: cy
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value is the namespace prefix of the Developer Edition organization of the package developer.
1920
Standard Objects
Field Name
TwoFactorInfo
Details • 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.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID that identifies the topic. After a TopicLocalization record is created, this ID can’t be modified.
Value
Type string Properties Create, Filter, Sort, Update Description The translated text for the topic name. Label is Topic Name Translation.
TwoFactorInfo Stores a user’s secret for two-factor operations. Use this object when customizing two-factor authentication in your organization. This object is available in API version 32.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Special Access Rules You need the “Manage Two-Factor Authentication in API” permission to create or update this object.
Fields Field Name
Details
SharedKey
Type string Properties Create, Group, Sort, Update
1921
Standard Objects
Field Name
TwoFactorMethodsInfo
Details Description This field is never read-enabled, though it is write-enabled. A request for this value always returns null. The value must be a base32-encoded string of a 20-byte secret. You can use the Apex method Auth.SessionManagement.getQrCode() to get a value to write to
this field. Note: If you write a secret to this field, in API version 37.0 and later the user gets an email notification that a new identity verification method was added to the user’s account. Type
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The two-factor method. • TOTP—The time-based one-time password.
UserId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID for the user who’s associated with the authentication secret.
TwoFactorMethodsInfo Stores information about which identity verification methods a user has registered. This object is available in API version 37.0 and later.
Supported Calls describeSObjects(), query()
Special Access Rules You need the “Manage Two-Factor Authentication in API” permission to access this object.
1922
Standard Objects
TwoFactorMethodsInfo
Fields Field Name
Details
ExternalId
Type string Properties Filter, Group, Nillable, Sort Description A unique system-generated numerical identifier for the user.
HasSalesforceAuthenticator
Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the user has connected the Salesforce Authenticator mobile app. The user can verify identity by approving a notification sent to the app. If the user sets a trusted location in the app, Salesforce Authenticator verifies automatically when the user is in the trusted location.
HasTempCode
Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the user has a temporary verification code generated by a Salesforce admin or user with “Manage Two-Factor Authentication in User Interface” permission.
HasTotp
Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the user has connected an authenticator app that generates verification codes, also known as time-based one-time passwords (TOTP). The user can verify identity by entering a code generated by the app.
HasU2F
Type boolean Properties Defaulted on create, Filter, Group, Sort
1923
Standard Objects
Field Name
TwoFactorTempCode
Details Description If true, the user has registered a U2F security key. The user can verify identity by inserting the security key into a USB port to generate credentials.
HasVerifiedMobileNumber
Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the user has verified a mobile phone number. Salesforce can text a verification code to the user at that number.
UserId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the user who’s associated with the identity verification methods.
TwoFactorTempCode Stores information about a user’s temporary identity verification code. This object is available in API version 37.0 and later.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules You need the “Manage Two-Factor Authentication in API” permission to access this object.
Fields Field Name
Details
Expiration
Type dateTime Properties Filter, Sort
1924
Standard Objects
Field Name
UndecidedEventRelation
Details Description The date and time when the temporary verification code expires. The code expires in 1 to 24 hours after it’s generated. Salesforce admins and non-admin users with the “Manage Two-Factor Authentication in User Interface” permission set the expiration time when generating the code.
Identifier
Type string Properties Filter, Group, Sort Description The unique identifier for the temporary code. This is a required field that can take any value.
TempCode
Type encryptedstring Description A request for this value always returns null.
UserId
Type reference Properties Filter, Group, Sort Description The ID for the user who’s associated with the temporary verification code.
UndecidedEventRelation Represents invitees with the status Not Responded for a given event. This object is available in API versions 29.0 and later.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
EventId
Type reference
1925
Standard Objects
Field Name
UndecidedEventRelation
Details Properties Filter, Group, Nillable, Sort Description Indicates the ID of the event.
RelationId
Type reference Properties Filter, Group, Nillable, Sort Description Indicates the ID of the invitee.
RespondedDate
Type dateTime Properties Filter, Nillable, Sort Description This field is always null.
Response
Type string Properties Filter, Group, Nillable, Sort Description Indicates the content of the response field. Label is Comment.
Type
Type string Properties Filter, Group, Nillable, Sort Description Indicates whether the invitee is a user, lead or contact, or resource.
1926
Standard Objects
User
Usage Query invitees who have not responded to an invitation to an event SELECT eventId, type, response FROM UndecidedEventRelation WHERE eventid='00UTD000000ZH5LA'
SEE ALSO: AcceptedEventRelation DeclinedEventRelation
User Represents a user in your organization.
Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert()
Special Access Rules • To create or update a User record, you must have the “Manage Internal Users” permission. Additionally, if the user is a Customer Portal user, you must have the “Edit Self-Service Users” permission, and if the user is a partner portal user, you must have the “Manage External Users” permission. • If Communities is enabled in your organization, to create or update external users for Customer Portal, partner portal, or Communities, you must also have the “Manage External Users” permission. • Information in hidden fields in a user's profile is not searchable by external users (with a portal profile) in a community. For example, if a user in a community has a hidden email address and an external user searches for it, the user record is not returned in the search results. Hidden field values are also not returned when external users perform searches on non-hidden fields. So if an external user searches for a user's name (cannot be hidden), any hidden field values associated with the user record (for example, a hidden email address) are not returned in the search results. Internal users from your organization who belong to the same community, however, can both search for and view hidden field values in search results. • When requested by portal users, queries that look up to the User object, such as owner.name or owner.email might not return values when the portal user making the request doesn’t have Read access to the User record being queried. The behavior depends on the number of domains associated with the lookup field. If the object can look up to more than one domain, owner.name returns a value, but other detail fields don’t. For example, Case owner can look up to the User or Queue objects. In this case, portal users can see only the value of owner.name. Other User detail fields, such as owner.email or owner.phone don’t return a value. If the object can look up to only a single domain, such as Account owner, then no detail fields return values, including owner.name. • Changing ownership of a record by updating its OwnerId field requires the user making the change to have both the “Transfer Record” permission and Read access to the User record of the new record owner.
1927
Standard Objects
User
Fields Field
Details
AboutMe
Type textarea Properties Create, Filter, Nillable, Sort, Update Description Information about the user, such as areas of interest or skills. This field is available even if Chatter is disabled.
AccountId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the Account associated with a Customer Portal user. This field is null for Salesforce users.
Address (beta)
Type address Properties Filter, Nillable Description The compound form of the address. Read-only. See Address Compound Fields for details on compound address fields.
Alias
Type string Properties Create, Filter, Group, Sort, Update Description Required. The user’s alias. For example, jsmith.
BadgeText
Type string Properties Filter, Group, Nillable, Sort Description The text description of a user badge that appears over a user’s photo. Users of the same Chatter user type (internal, external) are badged. Different user types are not badged.
1928
Standard Objects
User
Field
Details
BannerPhotoUrl
Type string Properties Filter, Nillable, Sort Description The URL for the user's banner photo. This field is available in API version 36.0 and later.
CallCenterId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description If Salesforce CRM Call Center is enabled, represents the call center to which this user is assigned.
City
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city associated with the user. Up to 40 characters allowed.
CommunityNickname
Type string Properties Create, Filter, Group, Sort, Update Description Name used to identify this user in the Community application, which includes the ideas and answers features.
CompanyName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the user’s company.
ContactId
Type reference Properties Create, Filter, Group, Nillable, Sort
1929
Standard Objects
Field
User
Details Description ID of the Contact associated with this account. The contact must have a value in the AccountId field or an error occurs.
Country
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country associated with the user. Up to 80 characters allowed.
CountryCode
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO country code associated with the user.
CurrentStatus
Type textarea Properties Create, Filter, Nillable, Sort, Update Description Text that describes what the user is working on. Note: If you update this field, the API automatically adds a post of type UserStatus on the user’s profile in Chatter. This field is deprecated in API version 25.0. To achieve similar behavior, post to the user directly by creating a FeedItem with the user’s ParentId.
DefaultCurrencyIsoCode
Type picklist Properties Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update Description The user's default currency setting for new records. For example, a user in France could have a DefaultCurrencyIsoCode set to Euros, and that would be their default currency in the application. Only applicable for organizations that use multiple currencies.
1930
Standard Objects
User
Field
Details
DefaultDivision
Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description This record’s default division. Only applicable if divisions are enabled for your organization.
DefaultGroupNotificationFrequency
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. The default frequency for sending the user's Chatter group email notifications when the user joins groups. The valid values are: • P—Email on every post • D—Daily digests • W—Weekly digests • N—Never The default value is N. For Professional, Enterprise, Unlimited, and Developer Edition organizations that existed prior to API version 22.0, the default value remains D. This field is available in API version 21.0 and later.
DelegatedApproverId
Type reference Properties Create, Filter, Group, Nillable,Sort, Update Description Id of the user who is a delegated approver for this user.
Department
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The company department associated with the user.
DigestFrequency
Type picklist
1931
Standard Objects
Field
User
Details Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. The frequency at which the system sends the user’s Chatter personal email digest. The valid values are: • D = Daily • W = Weekly • N = Never The default value is D.
Division
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The division associated with this user, similar to Department and unrelated to DefaultDivision.
Email
Type email Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The user’s email address.
EmailEncodingKey
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The email encoding for the user, such as ISO-8859-1 or UTF-8.
EmailPreferencesAutoBcc
Type boolean Properties Create, Filter, Update Description Determines whether the user receives copies of sent emails. This option applies only if compliance BCC emails are not enabled.
1932
Standard Objects
User
Field
Details
EmployeeNumber
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s employee number.
Extension
Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s phone extension number.
Fax
Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s fax number.
FederationIdentifier
Type string Properties Create, Filter, idLookup, Nillable, Sort, Update Description Indicates the value that must be listed in the Subject element of a Security Assertion Markup Language (SAML) IDP certificate to authenticate the user for a client application using single sign-on. This value must be specified if the SAML User ID Type is Assertion contains Federation ID from the User record. Otherwise, this field can’t be edited.
FirstName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s first name.
ForecastEnabled
Type boolean
1933
Standard Objects
Field
User
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the user is enabled as a Forecast Manager (true) or not (false) in customizable forecasting. Forecast managers see forecast rollups from users below them in the forecast hierarchy.
FullPhotoUrl
Type string Properties Filter, Nillable, Sort Description The URL for the user's profile photo. This field is available even if Chatter is disabled. The URL is updated every time a photo is uploaded and reflects the most recent photo. The URL returned for an older photo is not guaranteed to return a photo if a newer photo has been uploaded. You should always query this field for the URL of the most recent photo. This field is available in API version 20.0 and later.
IsActive
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the user has access to log in (true) or not (false). You can modify a User's active status from the user interface or via the API.
IsPartner
Type boolean Properties Defaulted on create, Filter Description Indicates whether the user is a partner who has access to the partner portal (true) or not (false). This field is not available for release 9.0 and later. Instead, use UserType with the value Partner or Power Partner.
IsPortalEnabled
Type boolean
1934
Standard Objects
Field
User
Details Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the user has access to Communities or portals (true) or not (false). This field is only available if one of the following conditions is true: • Communities are enabled in your organization and you have community or portal user licenses • Portals are enabled in your organization
IsPortalSelfRegistered
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the user is a Customer Portal user who self-registered for your organization's Customer Portal (true) or not (false). This field is not available for release 9.0 and earlier.
IsPrmSuperUser
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Available for partner portal users only. Indicates whether the user has super user access in the partner portal (true) or not (false). This field is available in API version 24.0 and later. Note: This field is not automatically enabled. Contact Salesforce to enable this field.
IsProfilePhotoActive
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user has a profile photo (true) or not (false). This field is available in API version 36.0 and later.
JigsawImportLimitOverride
Type int
1935
Standard Objects
Field
User
Details Properties Create, Filter, Group Nillable, Sort, Update Description The Data.com user’s monthly addition limit. The value must be between zero and the organization’s monthly addition limit. Label is Data.com Monthly Addition Limit. This field is available in API version 27.0 and later.
LanguageLocaleKey
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The user’s language, such as “French” or “Chinese (Traditional).” Label is Language.
LastLoginDate
Type dateTime Properties Filter, Sort, Nillable Description The date and time when the user last successfully logged in. This value is updated if 60 seconds have elapsed since the user’s last login.
LastName
Type string Properties Create, Filter, Group, Sort, Update Description Required. The user’s last name.
LastReferencedDate
Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type date
1936
Standard Objects
Field
User
Details Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Latitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of an address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields.
LocaleSidKey
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. This field is a restricted picklist field. The value of the field affects formatting and parsing of values, especially numeric values, in the user interface. It does not affect the API. The field values are named according to the language, and country if necessary, using two-letter ISO codes. The set of names is based on the ISO standard. It can often be more convenient to manually set a user’s locale in the user interface, and then use that value for inserting or updating other users via the API.
Longitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields.
Manager
Type picklist
1937
Standard Objects
Field
User
Details Properties Create, Filter, Restricted picklist, Update Description User lookup field used to select the user's manager. This establishes a hierarchical relationship, preventing you from selecting a user that directly or indirectly reports to itself.
ManagerId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Id of the user who manages this user.
MediumBannerPhotoUrl
Type url Properties Filter, Nillable, Sort Description The URL for the medium sized user profile banner photo.
MiddleName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s middle name. Maximum size is 40 characters. Contact Salesforce Customer Support to enable this field.
MobilePhone
Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s mobile or cellular phone number.
Name
Type string Properties Filter, Group, Sort
1938
Standard Objects
Field
User
Details Description Concatenation of FirstName and LastName. Limited to 121 characters.
OfflineTrialExpirationDate
Type dateTime Properties Filter, Nillable, Sort Description The date and time when the user’s Connect Offline trial expires.
Phone
Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s phone number.
PortalRole
Type picklist Properties Create, Filter, Group, Nillable, Sort Description The role of the user in the Customer Portal (either Executive, Manager, User, or PersonAcount). Prior to API version 16.0, you could set this field to null and the system automatically included a portal role. In API version 16.0 and above, when you set this field to null, a portal role is not automatically created. When this field is null and a ContactId is provided, the user is assigned to the User role. The field is available if Customer Portal is enabled OR Communities is enabled and have available partner portal, Customer Portal, or High-Volume Portal User licenses.
PostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s postal or ZIP code. Label is Zip/Postal Code.
1939
Standard Objects
User
Field
Details
ProfileId
Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the user’s Profile. Use this value to cache metadata based on profile. In earlier releases, this was RoleId.
ReceivesAdminInfoEmails
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the user receives email for administrators from Salesforce (true) or not (false).
ReceivesInfoEmails
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the user receives informational email from Salesforce (true) or not (false).
SenderEmail
Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The email address used as the From address when the user sends emails. This is the same value shown in Setup on the My Email Settings page.
SenderName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name used as the email sender when the user sends emails. This is the same value shown in Setup on the My Email Settings page.
Signature
Type string
1940
Standard Objects
Field
User
Details Properties Create, Filter, Nillable, Sort, Update Description The signature text added to emails. This is the same value shown in Setup on the My Email Settings page.
SmallBannerPhotoUrl
Type url Properties Filter, Nillable, Sort Description The URL for the small user profile banner photo.
SmallPhotoUrl
Type string Properties Filter, Nillable, Sort Description The URL for a thumbnail of the user's profile photo. This field is available even if Chatter is disabled. The URL is updated every time a photo is uploaded and reflects the most recent photo. The URL returned for an older photo is not guaranteed to return a photo if a newer photo has been uploaded. You should always query this field for the URL of the most recent photo. This field is available in API version 20.0 and later.
State
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state associated with the User. Up to 80 characters allowed.
StateCode
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The ISO state code associated with the user.
Street
Type textarea
1941
Standard Objects
Field
User
Details Properties Create, Filter, Group, Nillable, Sort, Update Description The street address associated with the User.
Suffix
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s name suffix. Maximum size is 40 characters. Contact Salesforce Customer Support to enable this field.
TimeZoneSidKey
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. This field is a restricted picklist field. A User time zone affects the offset used when displaying or entering times in the user interface. However, the API does not use a User time zone when querying or setting values. Values for this field are named using region and key city, according to ISO standards. It can often be more convenient to manually set one User time zone in the user interface, and then use that value for creating or updating other User records via the API.
Title
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The user’s business title, such as “Vice President.”
Username
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Contains the name that a user enters to log in to the API or the user interface. The value for this field must be in the form of an email address, and all characters should be lowercase. It must also be unique
1942
Standard Objects
Field
User
Details across all organizations. If you try to create or update a User with a duplicate value for this field, the operation is rejected. Each inserted User also counts as a license. Every organization has a maximum number of licenses. If you attempt to exceed the maximum number of licenses by inserting User records, the create is rejected.
UserPermissionsCallCenterAutoLogin
Type boolean Properties Create, Filter, Update Description Required if Salesforce CRM Call Center is enabled. Indicates whether the user is enabled to use the auto login feature of the call center (true) or not (false).
UserPermissionsChatterAnswersUser
Type boolean Properties Create, Filter, Update Description Indicates whether the portal user is enabled to use the Chatter Answers feature (true) or not (false). This field defaults to false when a Customer Portal user is created from the API.
UserPermissionsInteractionUser
Type boolean Properties Create, Filter, Update Description Indicates whether the user can run flows or not. Label is Force.com Flow User.
UserPermissionsJigsawProspectingUser Type
boolean Properties Create, Filter, Update Description Indicates whether the user is allocated one Data.com user license (true) or not (false). The Data.com user license lets the user add Data.com contact and lead records to Salesforce in supported editions. Label is Data.com User.
1943
Standard Objects
User
Field
Details
UserPermissionsKnowledgeUser
Type boolean Properties Create, Filter, Update Description Indicates whether the user is enabled to use Salesforce Knowledge (true) or not (false). Label is Knowledge User.
UserPermissionsLiveAgentUser
Type boolean Properties Create, Filter, Update Description Indicates whether the user is enabled to use Live Agent (true) or not (false). Label is Live Agent User.
UserPermissionsMarketingUser
Type boolean Properties Create, Filter, Update Description Required. Indicates whether the user is enabled to manage campaigns in the user interface (true) or not (false). Label is Marketing User.
UserPermissionsMobileUser
Type boolean Properties Create, Filter, Update Description Indicates whether the user is allocated one Salesforce Mobile Classic license (true) or not (false). Label is Apex Mobile User. The Salesforce Mobile Classic license grants the user access to the Salesforce Mobile Classic application on supported mobile devices.
UserPermissionsOfflineUser
Type boolean Properties Create, Filter, Update Description Required. Indicates whether the user is enabled to use Offline Edition (true) or not (false). Label is Offline User.
1944
Standard Objects
User
Field
Details
UserPermissionsSFContentUser
Type boolean Properties Create, Filter, Update Description Indicates whether the user is allocated one Salesforce CRM Content User License (true) or not (false). Label is Salesforce CRM Content User. The Salesforce CRM Content User license grants the user access to the Salesforce CRM Content application.
UserPermissionsSiteforceContributorUser Type
boolean Properties Create, Filter, Update Description Indicates whether the user is allocated one Site.com Contributor feature license (true) or not (false). Label is Site.com Contributor User. The Site.com Contributor feature license grants the user access to the Site.com application. Users with a Contributor license can use Site.com Studio to edit site content only. UserPermissionsSiteforcePublisherUser Type
boolean Properties Create, Filter, Update Description Indicates whether the user is allocated one Site.com Publisher feature license (true) or not (false). Label is Site.com Publisher User. The Site.com Publisher feature license grants the user access to the Site.com application. Users with a Publisher license can build and style websites, control the layout and functionality of pages and page elements, and add and edit content. UserPermissionsSupportUser
Type boolean Properties Create, Filter, Update Description When true, the user can use the Salesforce console.
UserPermissionsWirelessUser
Type boolean
1945
Standard Objects
Field
User
Details Properties Create, Update Description Required if the Wireless permission is enabled for your organization. Indicates whether the user is enabled to use Wireless Edition (true) or not (false). Label is Wireless User. Note: As of November 2005, Salesforce Wireless Edition is no longer available for purchase. If you are a Professional Edition customer and purchased Wireless Edition prior to November 7, 2005 or are an Enterprise Edition customer who has signed or renewed your Salesforce contract prior to November 7, 2005, you may continue using Wireless Edition through the end of your existing contract term.
UserPermissionsWorkDotComUserFeature Type
boolean Properties Create, Filter, Update Description Indicates whether the Work.com feature is enabled for the user (true) or not (false). UserPreferencesActivityRemindersPopup Type
boolean Properties Create, Filter, Update Description When true, a reminder popup window automatically opens when an activity reminder is due. Corresponds to the Trigger alert when reminder comes due checkbox at the Reminders page in the personal settings in the user interface. UserPreferencesApexPagesDeveloperMode Type
boolean Properties Create, Filter, Update Description When true, indicates the user has enabled developer mode for editing Visualforce pages and controllers. UserPreferencesContentEmailAsAndWhen Type
boolean
1946
Standard Objects
Field
User
Details Properties Create, Filter, Update Description When false, a user with Salesforce CRM Content subscriptions receives a once daily email summary if activity occurs on his or her subscribed content, libraries, tags, or authors. To receive email, the UserPreferencesContentNoEmail field must also be false. The default value is false. Note: This field is only visible when Salesforce CRM Content is enabled for your organization.
UserPreferencesContentNoEmail
Type boolean Properties Create, Filter, Update Description When false, a user with Salesforce CRM Content subscriptions receives email notifications if activity occurs on his or her subscribed content, libraries, tags, or authors. To receive real-time email alerts, set this field to false and set the UserPreferencesContentEmailAsAndWhen field to true. The default value is false. Note: This field is only visible when Salesforce CRM Content is enabled for your organization.
UserPreferencesEnableAutoSubForFeeds Type
boolean Properties Create, Filter, Update Description When true, the user automatically subscribes to feeds for any objects that the user creates. This field is available in API version 25.0 and later. UserPreferencesDisableAllFeedsEmail
Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email for all updates to Chatter feeds, based on the types of feed emails and digests the user has enabled. This field is available in API version 24.0 and later.
1947
Standard Objects
Field
User
Details
UserPreferencesDisableAutoSubForFeeds Type
boolean Properties Create, Filter, Update Description When false, the user automatically subscribes to feeds for any objects that the user creates. This field is deprecated in API version 25.0 and later. Starting with API version 25.0, use UserPreferencesEnableAutoSubForFeeds to enable or disable auto-follow for objects a user creates. UserPreferencesDisableBookmarkEmail
Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone comments on a Chatter feed item after the user has bookmarked it. This field is available in API version 24.0 and later.
UserPreferencesDisableChangeCommentEmail Type
boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone comments on a change the user has made, such as an update to their profile. This field is available in API version 24.0 and later. UserPreferencesDisableEndorsementEmail Type
boolean Properties Create, Filter, Update Description When false, the member automatically receives email every time someone endorses them for a topic. UserPreferencesDisableFileShareNotificationsForApi Type
boolean Properties Create, Filter, Update
1948
Standard Objects
Field
User
Details Description When false, email notifications are sent from the person who has shared a file to the users with whom the file has been shared. This field is available in API version 25.0 and later.
UserPreferencesDisableFollowersEmail Type
boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone starts following the user in Chatter.This field is available in API version 24.0 and later. UserPreferencesDisableLaterCommentEmail Type
boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone comments on a feed item after the user has commented on the feed item. This field is available in API version 24.0 and later. UserPreferencesDisableLikeEmail
Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone likes a post or comment the user has made. This field is available in API version 24.0 and later.
UserPreferencesDisableMentionsPostEmail Type
boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time the user is mentioned in posts. This field is available in API version 24.0 and later. UserPreferencesDisableProfilePostEmail Type
boolean
1949
Standard Objects
Field
User
Details Properties Create, Filter, Update Description When false, the user automatically receives email every time someone posts to the user’s profile. This field is available in API version 24.0 and later.
UserPreferencesDisableSharePostEmail Type
boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time the user’s post is shared. This field is available in API version 24.0 and later. UserPreferencesDisableFeedbackEmail
Type boolean Properties Filter Description When false, the user automatically receives emails related to Work.com feedback. This includes when someone requests or offers feedback, shares feedback with the user, or reminds the user to answer a feedback request.
UserPreferencesDisCommentAfterLikeEmail Type
boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone comments on a post the user has liked. This field is available in API version 24.0 and later. UserPreferencesDisMentionsCommentEmail Type
boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time the user is mentioned in comments. This field is available in API version 24.0 and later.
1950
Standard Objects
User
Field
Details
UserPreferencesDisableMessageEmail
Type boolean Properties Create, Filter, Update Description When false, the user automatically receives email for Chatter messages sent to the user. This field is available in API version 24.0 and later.
UserPreferencesDisableRewardEmail
Type boolean Properties Filter Description When false, the user automatically receives emails related to Work.com rewards. This includes when someone gives a reward to the user.
UserPreferencesDisableWorkEmail
Type boolean Properties Filter Description When false, the user receives emails related to Work.com feedback, goals, and coaching. The user must also sign up for individual emails listed on the Work.com email settings page. When true, the user doesn’t receive any emails related to Work.com feedback, goals, or coaching even if they are signed up for individual emails.
UserPreferencesDisProfPostCommentEmail Type
boolean Properties Create, Filter, Update Description When false, the user automatically receives email every time someone comments on posts on the user’s profile. This field is available in API version 24.0 and later. UserPreferencesEventRemindersCheckboxDefault Type
boolean Properties Create, Filter, Update
1951
Standard Objects
Field
User
Details Description When true, a reminder popup is automatically set on the user's events. Corresponds to the By default, set reminder on Events to... checkbox on the Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders.
UserPreferencesHideBiggerPhotoCallout Type
boolean Properties Create, Filter, Update Description When true, users can choose to hide the callout text below the large profile photo. UserPreferencesHideChatterOnboardingSplash Type
boolean Properties Filter Description When true, the initial Chatter onboarding prompts do not appear. UserPreferencesHideCSNDesktopTask
Type boolean Properties Create, Filter, Update Description When true, the Chatter recommendations panel never displays the recommendation to install Chatter Desktop. This field is available in API version 26.0 and later.
UserPreferencesHideCSNGetChatterMobileTask Type
boolean Properties Create, Filter, Update Description When true, the Chatter recommendations panel never displays the recommendation to install Chatter Mobile. This field is available in API version 26.0 and later. UserPreferencesHideEndUserOnboardingAssistantModal Type
boolean
1952
Standard Objects
Field
User
Details Properties CreateFilterUpdate Description Reserved for future use.
UserPreferencesHideLightningMigrationModal Type
boolean Properties CreateFilterUpdate Description Reserved for future use. UserPreferencesHideSecondChatterOnboardingSplash Type
boolean Properties Filter Description When true, the secondary Chatter onboarding prompts do not appear. UserPreferencesHideS1BrowserUI
Type boolean Properties Create, Filter, Update Description Controls the interface that the user sees when logging in to Salesforce from a supported mobile browser. If false, the user is automatically redirected to the Salesforce1 mobile browser app. If true, the user sees the full Salesforce site. The default value is false. Label is Salesforce1 User. This field is available in API version 29.0 or later.
UserPreferencesHideSfxWelcomeMat
Type boolean Properties CreateFilterUpdate Description Controls whether a user sees the Lightning Experience new user message. That message welcomes users to the new interface and provides step-by-step instructions that describe how to return to Salesforce Classic.
1953
Standard Objects
User
Field
Details
UserPreferencesJigsawListUser
Type boolean Properties Create, Filter, Update Description When true, the user is a Data.com List user and, therefore, shares record additions from a pool. UserPermissionsJigsawProspectingUser must also be set to true. Label is Data.com List User. This field is available in API version 27.0 and later.
UserPreferencesLightningExperiencePreferred Type
boolean Properties Create, Filter, Update Description When true, redirects the user to the Lightning Experience interface. Label is Switch to Lightning Experience. This field is available in API version 35.0 and later. UserPreferencesOptOutOfTouch
Type boolean Properties Create, Filter, Update Description This field is deprecated in API version 29.0. When false, the user automatically accesses the Salesforce Touch app when logging in to Salesforce from an iPad. If true, automatic access to the Salesforce Touch app is turned off and the user’s iPad is directed to the full Salesforce site instead. The default value is false. Note: Salesforce Touch must be enabled before this field is visible.
UserPreferencesPathAssistantCollapsed Type
boolean Properties Create, Filter, Update Description When true, Sales Path appears collapsed or hidden to the user. This field is available in API version 35.0 and later. UserPreferencesProcessAssistantCollapsed Type
boolean
1954
Standard Objects
Field
User
Details Properties Create, Filter, Update Description When true, Sales Path appears collapsed or hidden to the user. This field is available in API versions 33.0 and 34.0 only. In API versions 35.0 and later, use UserPreferencesPathAssistantCollapsed.
UserPreferencesReminderSoundOff
Type boolean Properties Create, Filter, Update Description When true, a sound automatically plays when an activity reminder is due. Corresponds to the Play a reminder sound checkbox on the Reminders page in the user interface.
UserPreferencesShowCityToExternalUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the city field in the user’s contact information. City is visible only to internal members of the user’s organization when: • This field is false. When false, this field returns the value #N/A. City is visible to external members in a community when: • This field is true, or • This field is false but UserPreferencesShowCityToGuestUsers is true,
which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowCityToGuestUsers
Type boolean Properties Create, Filter, Update Description Indicates the visibility of the city field in the user’s contact information. When true, city is visible to guest users. Guest users can access public
1955
Standard Objects
Field
User
Details Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowCityToExternalUsers, making
the user’s city visible to external members. The default value is false. This field is available in API version 28.0 and later. UserPreferencesShowCountryToExternalUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the country field in the user’s contact information. Country is visible only to internal members of the user’s organization when: • This field is false. When false, this field returns the value #N/A. Country is visible to external members in a community when: • This field is true, or • This field is false but UserPreferencesShowCountryToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal licenses. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowCountryToGuestUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the country field in the user’s contact information. When true, country is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowCountryToExternalUsers,
making the user’s country visible to external members.
1956
Standard Objects
Field
User
Details The default value is false. This field is available in API version 28.0 and later.
UserPreferencesShowEmailToExternalUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the email address field in the user’s contact information. Email address is visible only to internal members of the user’s organization when this field is false. Email address is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowEmailToGuestUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the email address field in the user’s contact information. When true, the email address is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When true, this field overrides the value false in UserPreferencesShowEmailToExternalUsers, making
the user’s email address visible to guests. When false, this field returns the value #N/A. The default value is false. This field is available in API version 34.0 and later. UserPreferencesShowFaxToExternalUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the fax number field in the user’s contact information. Fax number is visible only to internal members of the user’s organization when this field is false. Fax number is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses.
1957
Standard Objects
Field
User
Details When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later.
UserPreferencesShowFaxToGuestUsers
Type boolean Properties Create, Filter, Update Description Indicates the visibility of the fax number field in the user’s contact information. When true, the fax number field is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When true, this field overrides the value false in UserPreferencesShowFaxToExternalUsers, making the
user’s fax number visible to guests. When false, this field returns the value #N/A. The default value is false. This field is available in API version 34.0 and later. UserPreferencesShowManagerToExternalUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the manager field in the user’s contact information. Manager is visible only to internal members of the user’s organization when this field is false. Manager is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowManagerToGuestUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the manager field in the user’s contact information. When true, the manager field is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community.
1958
Standard Objects
Field
User
Details When true, this field overrides the value false in UserPreferencesShowManagerToExternalUsers,
making the user’s manager visible to guests. When false, this field returns the value #N/A. The default value is false. This field is available in API version 34.0 and later. UserPreferencesShowMobilePhoneToExternalUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the mobile or cellular phone number field in the user’s contact information. The number is visible only to internal members of the user’s organization when this field is false. The number is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowMobilePhoneToGuestUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the mobile phone field in the user’s contact information. When true, the mobile phone field is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When true, this field overrides the value false in UserPreferencesShowMobilePhoneToExternalUsers,
making the user’s mobile phone visible to guests. When false, this field returns the value #N/A. The default value is false. This field is available in API version 34.0 and later. UserPreferencesShowPostalCodeToExternalUsers Type
boolean Properties Create, Filter, Update
1959
Standard Objects
Field
User
Details Description Indicates the visibility of the postal or ZIP code field in the user’s contact information. Postal code is visible only to internal members of the user’s organization when: • This field is false. When false, this field returns the value #N/A. Postal code is visible to external members in a community when: • This field is true, or • This field is false but UserPreferencesShowPostalCodeToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal licenses. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowPostalCodeToGuestUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the postal or ZIP code field in the user’s contact information. When true, postal code is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowPostalCodeToExternalUsers,
making the user’s postal code visible to external members. The default value is false. This field is available in API version 28.0 and later. UserPreferencesShowProfilePicToGuestUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the user’s profile photo. When true, the photo is visible to guest users in a community. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community.
1960
Standard Objects
Field
User
Details When false, this field returns the stock photo. The default value is false. This field is available in API version 28.0 and later.
UserPreferencesShowStateToExternalUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the state field in the user’s contact information. State is visible only to internal members of the user’s organization when: • This field is false. When false, this field returns the value #N/A. State is visible to external members in a community when: • This field is true, or • This field is false but UserPreferencesShowStateToGuestUsers is true,
which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowStateToGuestUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the state field in the user’s contact information. When true, state is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowStateToExternalUsers, making
the user’s state visible to external members. The default value is false. This field is available in API version 28.0 and later. UserPreferencesShowStreetAddressToExternalUsers Type
boolean Properties Create, Filter, Update
1961
Standard Objects
Field
User
Details Description Indicates the visibility of the street address field in the user’s contact information. The address is visible only to internal members of the user’s organization when this field is false. The address is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later.
UserPreferencesShowStreetAddressToGuestUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the street address field in the user’s contact information. When true, the street address field is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When true, this field overrides the value false in UserPreferencesShowStreetAddressToExternalUsers,
making the user’s street address visible to guests. When false, this field returns the value #N/A. The default value is false. This field is available in API version 34.0 and later. UserPreferencesShowTitleToExternalUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the business title field in the user’s contact information. Title is visible only to internal members of the user’s organization when: • This field is false. When false, this field returns the value #N/A. Title is visible to external members in a community when: • This field is true, or • This field is false but UserPreferencesShowTitleToGuestUsers is true,
which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses.
1962
Standard Objects
Field
User
Details The default value is true. This field is available in API version 26.0 and later.
UserPreferencesShowTitleToGuestUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the business title field in the user’s contact information. When true, title is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowTitleToExternalUsers, making
the user’s title visible to external members. The default value is false. This field is available in API version 28.0 and later. UserPreferencesShowWorkPhoneToExternalUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the work phone number field in the user’s contact information. The number is visible only to internal members of the user’s organization when this field is false. The number is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowWorkPhoneToGuestUsers Type
boolean Properties Create, Filter, Update Description Indicates the visibility of the work phone field in the user’s contact information. When true, the work phone field is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community.
1963
Standard Objects
Field
User
Details When true, this field overrides the value false in UserPreferencesShowWorkPhoneToExternalUsers,
making the user’s work phone visible to guests. When false, this field returns the value #N/A. The default value is false. This field is available in API version 34.0 and later. UserPreferencesSortFeedByComment
Type boolean Properties Create, Filter, Update Description Specifies the data value used in sorting a user’s feed. When true, the feed is sorted by most recent comment activity. When false, the feed is sorted by post date.
UserPreferencesTaskRemindersCheckboxDefault Type
boolean Properties Create, Filter, Update Description When true, a reminder popup is automatically set on the user's tasks. Corresponds to the By default, set reminder on Tasks to... checkbox on the Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders. UserRoleId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the user’s UserRole. Label is Role ID.
UserType
Type picklist Properties Filter, Group, Nillable, Sort, Restricted picklist Description The category of user license. Each UserType is associated with one or more UserLicense records. Each UserLicense is associated with one or more profiles. In API version 10.0 and later, valid values include:
1964
Standard Objects
Field
User
Details • Standard: user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses. Label is Standard. • PowerPartner: User whose access is limited because he or she is a partner and typically accesses the application through a partner portal or community. Label is Partner. • CSPLitePortal: user whose access is limited because he or she is an organization's customer and accesses the application through aCustomer Portal or community. Label is High Volume Portal. • CustomerSuccess: user whose access is limited because he or she is an organization's customer and accesses the application through a Customer Portal. Label is Customer Portal User. • PowerCustomerSuccess: user whose access is limited because he or she is an organization's customer and accesses the application through a Customer Portal. Label is Customer Portal Manager. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the Customer Portal role hierarchy. • CsnOnly: user whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. Label is Chatter Free.
WirelessEmail
Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Wireless email address associated with this user. For use with Salesforce Wireless Edition. This field is available only if the Wireless and Email permissions are enabled for your organization. Note: As of November 2005, Salesforce Wireless Edition is no longer available for purchase. If you are a Professional Edition customer and purchased Wireless Edition prior to November 7, 2005 or are an Enterprise Edition customer who has signed or renewed your Salesforce contract prior to November 7, 2005, you may continue using Wireless Edition through the end of your existing contract term.
Usage Use this object to query information about users and to provision and modify users in your organization. Unlike other objects, the records in the User table represent actual users—not data owned by users. Any user can query or describe User records.
1965
Standard Objects
UserAccountTeamMember
For example, the following SOQL code finds users with a particular user role. SELECT Id, Username FROM User WHERE UserRoleId='00ED0000000xicT'
Each portal user is associated with a portal account. A portal account can have a maximum of three portal roles (Executive, Manager, and User). You can select the default number of roles to be created from the user interface. The role hierarchy is maintained when you insert and delete portal roles, and roles are created bottom-up. Deleting the User role causes the Manager role to be renamed to User role. Deleting both the Executive and User roles causes the Manager role to be renamed to User role. Before deleting a role, you must assign users under that role to another role.
Deactivate Users You can’t delete a user in the user interface or the API. You can deactivate a user in the user interface; and you can deactivate or disable a Customer Portal or partner portal user in the user interface or the API. Because users can never be deleted, we recommend that you exercise caution when creating them. If you deactivate a user, any EntitySubscription where the user is associated with the ParentId or SubscriberId field, meaning all subscriptions both to and from the user, are soft deleted. If the user is reactivated, the subscriptions are restored. However, if you deactivate multiple users at once and these users follow each other, their subscriptions are hard deleted. In this case, the user-to-user EntitySubscription is deleted twice (double deleted). Such subscriptions can’t be restored upon user reactivation.
Passwords For security reasons, you can’t query User passwords via the API or the user interface. However, the API allows you to set and “reset” User passwords using the setPassword() and resetPassword() calls. The password lockout status and the ability to reset the User locked-out status is not available via the API. You must check and reset the User password lockout status using the user interface. SEE ALSO: UserRole UserLicense
UserAccountTeamMember Represents a User on the default account team of another User. See also OpportunityTeamMember, which represents a User on the opportunity team of an Opportunity
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Special Access Rules Customer Portal users can't access this object.
1966
Standard Objects
UserAccountTeamMember
Fields Field
Details
AccountAccessLevel
Type picklist Properties Create, Filter, Restricted picklist, Update Description Required. For Account records that the user has added to his or her default account team, the level of access the account team member has. . The possible values are: • Read • Edit This field must be set to an access level that is higher than the organization’s default access level for accounts.
CaseAccessLevel
Type picklist Properties Create, Filter, Restricted picklist, Update Description Required. Level of access that the account team member has to Case records related to the account. The possible values are: • None • Read • Edit This field must be set to an access level that is higher than the organization's default access level for cases.
ContactAccessLevel
Type picklist Properties Create, Filter, Restricted picklist, Update Description Required. ForContact records related to the account, the level of access that the account team member has. The possible values are: • None • Read • Edit This field must be set to an access level that is higher than the organization's default access level for contacts.
1967
Standard Objects
Field
UserAccountTeamMember
Details Note: When DefaultContactAccess is set to Controlled by Parent, you can’t create or update this field.
OpportunityAccessLevel
Type picklist Properties Create, Filter, Restricted picklist, Update Description Required. Level of access that the team member has to Opportunity records related to the account. The possible values are: • None • Read • Edit This field must be set to an access level that is higher than the organization’s default access level for opportunities.
OwnerId
Type reference Properties Create, Filter Description Required. ID of the User who owns the default account team.
TeamMemberRole
Type picklist Properties Create, Filter, Nillable, Update Description Role that the team member has on opportunities for which the user has added his or her default account team. The valid values are set by the organization’s administrator in the Account Team Roles picklist. Label is Team Role.
UserId
Type reference Properties Create, Filter Description Required. ID of the User who is a member of the default account team. This field cannot be updated.
1968
Standard Objects
UserAppInfo
Usage This object is available only in organizations that have enabled the account teams functionality, which can be done using the user interface. If you attempt to create a record that matches an existing record, the create call updates any modified fields and returns the existing record. You can set up a User record so the default account team includes the others who typically work with them on accounts.
UserAppInfo Stores the last Lightning app logged in to. This object is available in API version 38.0 and later.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
Fields Field Name
Details
FormFactor
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The relative size of the app as displayed. Values are: • Small—suitable for a small device like a mobile phone • Medium—suitable for a tablet • Large—suitable for a large display device, like a monitor It’s possible to have three versions of the app as the one last logged in to, where each version has a different form factor.
UserId
Type reference Properties Create, Filter, Group, Sort Description The ID of the user that used this app.
1969
Standard Objects
UserAppMenuCustomization
UserAppMenuCustomization Represents an individual user’s settings for items in the Force.com app menu or App Launcher. This object is available in API version 35.0 and later.
Supported Calls create(),delete(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),undelete(),update(),upsert()
Fields Field Name
Details
ApplicationId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The 15-character ID for the application associated with the menu item.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user for these specific settings.
SortOrder
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The index value that controls where this item appears in the menu. For example, a menu item with a sort order value of 5 will appear between items with sort order values of 3 and 9.
Usage See the AppMenuItem object for the organization-wide default settings This object contains the fields representing any changes the user made to the menu.
1970
Standard Objects
UserAppMenuCustomizationShare
UserAppMenuCustomizationShare Represents a sharing entry on a UserAppMenuCustomization record. This object is available in API version 35.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing allowed. The possible values are: • Read • Edit
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the parent record, if any.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. Values may include: • Manual—The User or Group has access because a user with “All” access manually shared the UserAppMenuCustomization record with them. • Owner—The User is the owner of the UserAppMenuCustomization record or is in a role above the UserAppMenuCustomization record owner in the role hierarchy.
1971
Standard Objects
UserAppMenuItem
Field Name
Details
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the UserAppMenuCustomization record.
UserAppMenuItem Represents the organization-wide settings for items in the Force.com app menu or App Launcher that the requesting user has access to in Setup. This object is available in API version 35.0 and later.
Supported Calls describeLayout(), describeSObjects(), query(), search()
Fields Field Name
Details
AppMenuItemId
Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID for the menu item.
ApplicationId
Type reference Properties Filter, Group, Nillable, Sort Description The 15-character ID for the application associated with the menu item.
Description
Type string Properties Filter, Group, Nillable, Sort
1972
Standard Objects
Field Name
UserAppMenuItem
Details Description A description of this menu item.
IconUrl
Type url Properties Filter, Group, Nillable, Sort Description The icon for the menu item’s application.
InfoUrl
Type url Properties Filter, Group, Nillable, Sort Description The URL for more information about the application.
IsUsingAdminAuthorization
Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the app is pre-authorized for certain users by the administrator.
IsVisible
Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the app is visible to the user.
Label
Type string Properties Group, Nillable Description The app’s name.
LogoUrl
Type url
1973
Standard Objects
Field Name
UserAppMenuItem
Details Properties Filter, Group, Nillable, Sort Description The logo for the menu item’s application. The default is the initials of the Label value.
MobileStartUrl
Type url Properties Filter, Group, Nillable, Sort Description The location mobile users are directed to after they’ve authenticated. This is only used with connected apps.
Name
Type string Properties Filter, Group, Nillable, Sort Description The API name of the item.
SortOrder
Type int Properties Filter, Group, Nillable, Sort Description The index value that controls where this item appears in the menu. For example, a menu item with a sort order value of 5 will appear between items with sort order values of 3 and 9.
StartUrl
Type url Properties Filter, Group, Nillable, Sort Description The location users are directed to after they’ve authenticated. For a connected app, this is the location specified by the StartUrl. Otherwise it’s the application’s default start page.
Type
Type picklist
1974
Standard Objects
Field Name
UserConfigTransferButton
Details Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of application represented by this item. The types are: • ConnectedApplication • ServiceProvider • TabSet
UserSortOrder
Type int Properties Filter, Group, Nillable, Sort Description The index value that represents where the user set this item in the menu (or App Launcher). For example, an item with a sort order value of 5 will appear between items with sort order values of 3 and 9. This value is separate from SortOrder so you can create logic incorporating both values. For example, if you want the user-sorted items to appear first, followed by the organization order for the rest, use: SELECT ApplicationId,SortOrder,UserSortOrder FROM AppMenuItem order by userSortOrder NULLS LAST, sortOrder NULLS LAST
Usage See the AppMenuItem object for the organization-wide default settings This object contains the fields the requesting user has permission to see.
UserConfigTransferButton Represents the association between a Live Agent configuration and a live chat button. This association allows users associated with a specific configuration to transfer chats to a button queue.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
1975
Standard Objects
UserConfigTransferSkill
Fields Field Name
Details
LiveChatButtonId
Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the live chat button that agents can transfer chats to.
LiveChatUserConfigId
Type reference Properties Create, Filter, Group, Sort Description The ID of the Live Agent configuration; agents associated with this configuration can transfer chats to the chat button indicated by the LiveChatButtonId.
UserConfigTransferSkill Represents the association between a Live Agent configuration and a skill. This association allows users associated with a specific configuration to transfer chats to agents who have that skill.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
LiveChatUserConfigId
Type reference Properties Create, Filter, Group, Sort Description The ID of the Live Agent configuration; agents associated with this configuration can transfer chats to the chat button indicated by the LiveChatButtonId.
SkillId
Type reference
1976
Standard Objects
Field Name
UserCustomBadge
Details Properties Create, Filter, Group, Nillable, Sort Description The ID of the skill group that agents can transfer chats to.
UserCustomBadge Represents a custom badge for a user. This object is available in API version 38.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
BadgeType
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of badge. Valid values are: • Customer • Partner • Employee
CustomText
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Custom text for the badge.
ParentId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update
1977
Standard Objects
Field Name
UserCustomBadgeLocalization
Details Description The ID of the community or org that the badge is in.
UserCustomBadgeLocalization Represents the translated version of a custom badge for a user. This object is available in API version 38.0 and later.
Supported Calls create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update()
Special Access Rules • Translation Workbench must be enabled for your org. • Users with the “Customize Application” or “Manage Translation” permission can create or update UserCustomBadge translations.
Fields Field Name
Details
Language
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The language the UserCustomBadge is translated into. This picklist contains these fully supported languages. • Chinese (Simplified): zh_CN • Chinese (Traditional): zh_TW • Danish: da • Dutch: nl_NL • English: en_US • Finnish: fi • French: fr • German: de • Italian: it • Japanese: ja • Korean: ko • Norwegian: no
1978
Standard Objects
Field Name
UserCustomBadgeLocalization
Details • Portuguese (Brazil): pt_BR • Russian: ru • Spanish: es • Spanish (Mexico): es_MX • Swedish: sv • Thai: th
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value 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.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the UserCustomBadge.
Value
Type string Properties Create, Filter, Sort, Update Description The translated text for the UserCustomBadge. Label is Translation Text.
1979
Standard Objects
UserFeed
UserFeed Represents a single feed item in the feed displayed on a Chatter user profile feed. A user profile feed shows changes to a user record for fields that are tracked in feeds, and posts and comments about the record. This object is available in API version 18.0 and later. A user feed shows recent changes to a user record for any fields that are tracked in feeds, and posts and comments about the record. It is a useful way to stay up-to-date with changes made to users in the organization.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules If you use the FeedComment object to comment on a user record, the user can delete the comment. For example, if John Smith makes a comment about Sasha Jones, Sasha can delete the comment. You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the User object • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.
Fields Field
Details
Body
Type textarea Properties Nillable, Sort Description The content of UserFeed. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item. Tip: In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say you comment on a post that already has one published comment and your comment triggers moderation. Now there are two
1980
Standard Objects
Field
UserFeed
Details comments on the post, but the count says there's only one. In a moderated feed, your comment isn’t counted until it's approved by an admin or a person with “CanApproveFeedPostAndComment” or “ModifyAllData” permission. This has implications for how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until end of comments is returned.
ConnectionId
Type reference Properties Filter, Group, Nillable, Sort Description When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. This field is required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
1981
Standard Objects
UserFeed
Field
Details
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.
CreatedDate
Type dateTime Properties Defaulted on create, Filter, Sort Description Date and time when this record was created. This field is a standard system field. Ordering by CreatedDateDESC sorts the feed by the most recent feed item.
FeedPostId
Type reference Properties Filter, Group, Nillable, Sort Description This field was removed in API version 22.0, and is available in earlier versions for backward compatibility only. ID of the associated FeedPost. A FeedPost represents the following types of changes in an FeedItem: changes to tracked fields, text posts, link posts, and content posts.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
1982
Standard Objects
UserFeed
Field
Details
IsDeleted
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Standard system field. Indicates whether the record has been moved to the Recycle Bin (true) or not (false).
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example: Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation.
LastModifiedDate
Type dateTime Properties Defaulted on create, Filter, Sort
1983
Standard Objects
Field
UserFeed
Details Description Date and time when a user last modified this record. This field is a standard system field. When a feed item is created, LastModifiedDate is the same as CreatedDate. If a FeedComment is inserted on that feed item, then LastModifiedDate becomes the CreatedDate for that FeedComment. Deleting the FeedComment does not change the LastModifiedDate. Ordering by LastModifiedDate DESC sorts the feed by both the most recent feed item or comment.
LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
NetworkScope
Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. NetworkScope can have the following values:
• NetworkId—The ID of the community in which the FeedItem is available. If left empty, the feed item is only available in the default community. • AllNetworks—The feed item is available in all communities. Note the following exceptions for NetworkScope: • Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks. • You can’t filter a FeedItem on the NetworkScope field.
1984
Standard Objects
UserFeed
Field
Details
ParentId
Type reference Properties Filter, Group, Sort Description ID of the account record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the user record. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item: • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval.
1985
Standard Objects
Field
UserFeed
Details • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • CaseCommentPost—generated event when a user adds a case comment for a case object • EmailMessageEvent—generated event when an email related to a case object is sent or received • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • ChangeStatusPost—generated event when a user changes the status of a case • AttachArticleEvent—generated event when a user attaches an article to a case Note: If you set Type to ContentPost, also specify ContentData and ContentFileName.
Visibility
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization.
1986
Standard Objects
Field
UserLicense
Details Visibility can have the following values:
• AllUsers—The feed item is available to all users who have permission to see the feed item. • InternalUsers—The feed item is available to internal users only. Note the following exceptions for Visibility: • For record posts, Visibility is set to InternalUsers for all internal users by default. • External users can set Visibility only to AllUsers. • On user and group posts, only internal users can set Visibility to InternalUsers.
Usage Use this object to track changes for a user record. SEE ALSO: User EntitySubscription NewsFeed UserProfileFeed
UserLicense Represents a user license in your organization. A user license entitles a user to specific functionality and determines the profiles and permission sets available to the user.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field
Details
LicenseDefinitionKey
Type string Properties Filter, Nillable
1987
Standard Objects
Field
UserLicense
Details Description A string that uniquely identifies a particular user license. Label is License Def. ID. Values are: AUL: corresponds to the Salesforce Platform user license AUL1: corresponds to the Salesforce Platform One user license AUL_LIGHT corresponds to the Salesforce Platform Light user license FDC_ONE corresponds to the Force.com - One App user license FDC_SUB corresponds to the Force.com App Subscription user license High Volume Customer Portal_User: corresponds to the High Volume Customer Portal user license Overage_Platform_Portal_User corresponds to the Overage Authenticated Website user license PID_STRATEGIC_PRM: corresponds to the Gold Partner user license PID_CHATTER corresponds to the Chatter Only user license PID_CONTENT corresponds to the Content Only user license PID_Customer_Portal_Basic: corresponds to the Customer Portal Manager Standard user license and the Customer Portal User license PID_Customer_Portal_Standard: corresponds to the Customer Portal Manager Custom user license PID_FDC_FREE corresponds to the Force.com Free user license PID_IDEAS corresponds to the Ideas Only user license PID_Ideas_Only_Portal corresponds to the Ideas Only Portal user license PID_Ideas_Only_Site corresponds to the Ideas Only Site user license PID_KNOWLEDGE corresponds to the Knowledge Only user license PID_Customer_Community corresponds to the Customer Community license. PID_Customer_Community_Login corresponds to the Customer Community Login license. PID_Partner_Community corresponds to the Partner Community license. PID_Partner_Community_Login corresponds to the Partner Community Login license. PID_Limited_Customer_Portal_Basic: corresponds to the Limited Customer Portal Manager Standard user license PID_Limited_Customer_Portal_Standard: corresponds to the Limited Customer Portal Manager Custom user license PID_Overage_Customer_Portal_Basic: corresponds to the Overage Customer Portal Manager Standard user license PID_Overage_High Volume Customer Portal corresponds to the Overage High Volume Customer Portal user license Platform_Portal_User: corresponds to the Authenticated Website user license
1988
Standard Objects
Field
UserLicense
Details POWER_PRM: corresponds to the Partner user license POWER_SSP: corresponds to the Customer Portal Manager user license SFDC: corresponds to the Full CRM user license
MasterLabel
Type string Properties Filter, Group, Sort Description The user license label. This field is available in API version 32.0 and later. This field is available through the API Access to User Licenses pilot program. For information on enabling this pilot program for your organization, contact Salesforce.
MonthlyLoginsEntitlement Type
int Properties Filter, Nillable Description The maximum number of customer or partner portal logins allowed per month. A null value in this field means the user license is charged according to the number of users rather than the number of logins. This field is available in API version 20.0 and later. MonthlyLoginsUsed
Type int Properties Nillable Description The number of successful logins for all users associated with a customer or partner portal user license. This field has a non-null value if MonthlyLoginsEntitlement has a non-null value. This field is available in API version 20.0 and later.
Name
Type string Properties Filter, Group, Sort Description The internal name of the user license.
1989
Standard Objects
Field
UserLicense
Details Note: Your organization may also include custom user licenses.
Status
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The current status of the user license. Valid values for this field are Active and Disabled. This field is available in API version 32.0 and later. This field is available through the API Access to User Licenses pilot program. For information on enabling this pilot program for your organization, contact Salesforce.
TotalLicenses
Type int Properties Filter, Group, Sort Description The number of user licenses in the organization. This field is available in API version 32.0 and later. This field is available through the API Access to User Licenses pilot program. For information on enabling this pilot program for your organization, contact Salesforce.
UsedLicenses
Type int Properties Filter, Group, Sort Description The number of user licenses that are assigned to active users in the organization. This field is available in API version 32.0 and later. This field is available through the API Access to User Licenses pilot program. For information on enabling this pilot program for your organization, contact Salesforce.
Usage Users with the “View Setup and Configuration” permission can use the UserLicense object to view the set of currently defined user licenses in your organization.
1990
Standard Objects
UserLogin
The UserLicense object is currently used by bulk user creation to determine the user license to which each profile and permission set belongs. For example, if you use the API to create portal users and you want to know which profile belongs to each portal user license, you can query this object for each profile and check the LicenseDefinitionKey to identify the associated user license. SEE ALSO: Profile
UserLogin Represents the settings that affect a user’s ability to log into an organization. To access this object, you need the UserPermissions.ManageUsers permission. This object is available in API version 29.0 and later.
Supported Calls describeSObjects(), query(), retrieve(), update()
Fields Field Name
Details
IsFrozen
Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description If true, the user account associated with this object is frozen.
IsPasswordLocked
Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description If true, the user account associated with this object is locked because of too many login failures. From the API, you can set this field to false, but not true
UserId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the associated user account. This field can’t be updated.
1991
Standard Objects
UserMembershipSharingRule
Usage To query for all frozen users in your organization: SELECT Id, UserId FROM UserLogin WHERE IsFrozen = true
UserMembershipSharingRule Represents the rules for sharing user records from a source group to a target group. A user record contains details about a user. Users who are members of the source group can be shared with members of the target group. The source and target groups can be based on roles, portal roles, public groups, or territories. This object is available in API version 26.0 and later.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update()
Fields Field
Details
Description
Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later.
DeveloperName
Type string Properties Create, Filter, Group, Nillable, Sort, Update 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. Corresponds to Rule Name in the user interface. Note: 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.
1992
Standard Objects
UserPackageLicense
Field
Details
GroupId
Type reference Properties Create, Filter, Group, Sort Description The ID representing the source group.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to Label on the user interface.
UserAccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing being allowed. The possible values are: • Read • Edit
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description The ID representing the target group being given access.
Usage Use this object to manage sharing rules for user records. Source and target groups can include internal users, portal users, Chatter or Chatter External users.
UserPackageLicense Represents a license for an installed managed package, assigned to a specific user. This object is available in API version 31.0 and later.
1993
Standard Objects
UserPreference
Supported Calls create(), delete(), query(), retrieve(), update()
Fields Field Name
Details
PackageLicenseId
Type reference Properties Filter, Group, Sort Description The 18-character Globally Unique ID (GUID) that identifies the package license
UserId
Type reference Properties Filter, Group, Sort Description The User ID of the user licensed to use this package
Usage Use this object, in conjunction with PackageLicense, to provide users access to a managed package installed in your organization.
UserPreference Represents a functional preference for a specific user in your organization.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules Customer Portal users can't access this object.
1994
Standard Objects
UserPreference
Fields Field
Details
Preference
Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The name of the user preference. Supported values are Event Reminder Default Lead Time, Task Reminder Default Time, Prevent Logs on Load, Autocomplete Apex After Key Press, Visualforce Viewstate Inspector, Forecasting Displayed Type, Editor Theme, Editor Font Size, Pinned Folders, Enable Query Plan, and Email Transport Type. These values are related to UserPreferencesEventRemindersCheckboxDefault and UserPreferencesTaskRemindersCheckboxDefault on the User object. Enable New Open Dialog is reserved for future use. When creating SOQL queries, tolabel is required to return accurate results. For example, select Id, tolabel(Preference), Value, UserId from UserPreference.
UserId
Type reference Properties Filter, Group, Sort Description The ID of the user associated with this role. Label is User ID.
Value
Type string Properties Filter, Nillable, Sort Description The value of the user preference. For Event Reminder Default Lead Time, the values are increasing intervals of time from 0 minutes to 2 days. For Task Reminder Default Time, the values are half-hours from 12:00 AM to 11:30 PM. To view the respective sets of values, access the Reminders in your personal settings in the online application.
Usage Use this object to query the set of currently configured user preferences in your organization. In your client application, you can query the User object to obtain valid User IDs to access the UserPreference object.
1995
Standard Objects
UserProfile
All users can invoke query() or describeSObjects() with this object.
UserProfile Represents a Chatter user profile. Note: This object has been deprecated as of API version 32.0. Use the User object to query information about a user in API version 32.0 and later.
Supported Calls describeLayout(), query(), retrieve()
Special Access Rules • Information in hidden fields in a user's profile is not searchable by external users (with a portal profile) in a community. For example, if a user in a community has a hidden email address and an external user searches for it, the user record is not returned in the search results. Hidden field values are also not returned when external users perform searches on non-hidden fields. So if an external user searches for a user's name (cannot be hidden), any hidden field values associated with the user record (for example, a hidden email address) are not returned in the search results. Internal users from your organization who belong to the same community, however, can both search for and view hidden field values in search results. • Any fields that have been restricted in visibility will be returned empty, whether or not they are, and will not be removed from the field listing.
Fields Field
Details
AboutMe
Type textarea Properties Filter, Nillable, Sort Description Information about the user, such as areas of interest or skills.
Address (beta)
Type address Properties Filter, Nillable Description The compound form of the address. Read-only. See Address Compound Fields for details on compound address fields.
1996
Standard Objects
UserProfile
Field
Details
City
Type string Properties Filter, Group, Nillable, Sort Description The city associated with the user profile.
CompanyName
Type string Properties Filter, Group, Nillable, Sort Description The company associated with the user profile.
Country
Type string Properties Filter, Group, Nillable, Sort Description The country associated with the user profile.
Email
Type email Properties Filter, Group, idLookup, Sort Description The email address associated with the user profile.
Fax
Type phone Properties Filter, Group, Nillable, Sort Description The fax number associated with the user profile.
FirstName
Type string Properties Filter, Group, Nillable, Sort Description The user’s first name.
1997
Standard Objects
UserProfile
Field
Details
FullPhotoUrl
Type url Properties Filter, Nillable, Sort Description The URL for the user's profile photo if Chatter is enabled. The URL is updated every time a photo is uploaded and reflects the most recent photo. The URL returned for an older photo is not guaranteed to return a photo if a newer photo has been uploaded. You should always query this field for the URL of the most recent photo.
IsActive
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user has access to log in (true) or not (false). You can modify a User's active status from the user interface or via the API.
IsBadged
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user is visually badged (true) or not (false). Users of the same Chatter user type (internal, external) are badged. Different user types are not badged.
LastName
Type string Properties Filter, Group, Sort Description The user’s last name.
Latitude (beta)
Type double Properties Filter, Nillable, Sort
1998
Standard Objects
Field
UserProfile
Details Description Used with Longitude to specify the precise geolocation of an address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields.
Longitude (beta)
Type double Properties Filter, Nillable, Sort Description Used with Latitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields.
ManagerId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user who manages this user.
MobilePhone
Type phone Properties Filter, Group, Nillable, Sort Description The user’s mobile or cellular phone number.
Name
Type string Properties Filter, Group, Sort Description Concatenation of FirstName and LastName.
Phone
Type phone Properties Filter, Group, Nillable, Sort
1999
Standard Objects
Field
UserProfile
Details Description The user’s phone number.
PostalCode
Type string Properties Filter, Group, Nillable, Sort Description The user’s postal or ZIP code. Label is Zip/Postal Code.
SmallPhotoUrl
Type url Properties Filter, Nillable, Sort Description The URL for a thumbnail of the user's profile photo if Chatter is enabled. The URL is updated every time a photo is uploaded and reflects the most recent photo. The URL returned for an older photo is not guaranteed to return a photo if a newer photo has been uploaded. You should always query this field for the URL of the most recent photo.
State
Type string Properties Filter, Group, Nillable, Sort Description The state associated with the user profile.
Street
Type textarea Properties Filter, Group, Nillable, Sort Description The street address associated with the user profile.
Title
Type string Properties Filter, Group, Nillable, Sort
2000
Standard Objects
Field
UserProfile
Details Description The user’s business title, such as “Vice President.”
UserPreferencesActivityRemindersPopup
Type boolean Properties Filter Description When true, a reminder popup window automatically opens when an activity reminder is due. Corresponds to the Trigger alert when reminder comes due checkbox at the Reminders page in the personal settings in the user interface.
UserPreferencesApexPagesDeveloperMode
Type boolean Properties Filter Description When true, indicates the user has enabled developer mode for editing Visualforce pages and controllers.
UserPreferencesDisableAllFeedsEmail
Type boolean Properties Filter Description When false, the user automatically receives email for all updates to Chatter feeds, based on the types of feed emails and digests the user has enabled.
UserPreferencesDisableBookmarkEmail
Type boolean Properties Filter Description When false, the user automatically receives email every time someone comments on a Chatter feed item after the user has bookmarked it.
UserPreferencesDisableChangeCommentEmail Type
boolean
2001
Standard Objects
Field
UserProfile
Details Properties Filter Description When false, the user automatically receives email every time someone comments on a change the user has made, such as an update to their profile.
UserPreferencesDisableEndorsementEmail Type
boolean Properties Filter Description When false, the member automatically receives email every time someone endorses them for a topic. UserPreferencesDisableFeedbackEmail
Type boolean Properties Filter Description When false, the user automatically receives emails related to Work.com feedback. This includes when someone requests or offers feedback, shares feedback with the user, or reminds the user to answer a feedback request.
UserPreferencesDisableFileShareNotificationsForApi Type
boolean Properties Filter Description When false, email notifications are sent from the person who has shared a file to the users with whom the file has been shared. UserPreferencesDisableFollowersEmail
Type boolean Properties Filter Description When false, the user automatically receives email every time someone starts following the user in Chatter.
2002
Standard Objects
Field
UserProfile
Details
UserPreferencesDisableLaterCommentEmail Type
boolean Properties Filter Description When false, the user automatically receives email every time someone comments on a feed item after the user has commented on the feed item. UserPreferencesDisableLikeEmail
Type boolean Properties Filter Description When false, the user automatically receives email every time someone likes a post or comment the user has made.
UserPreferencesDisableMentionsPostEmail Type
boolean Properties Filter Description When false, the user automatically receives email every time the user is mentioned in posts. UserPreferencesDisableMessageEmail
Type boolean Properties Filter Description When false, the user automatically receives email for Chatter messages sent to the user.
UserPreferencesDisableProfilePostEmail Type
boolean Properties Filter Description When false, the user automatically receives email every time someone posts to the user’s profile.
2003
Standard Objects
UserProfile
Field
Details
UserPreferencesDisableRewardEmail
Type boolean Properties Filter Description When false, the user automatically receives emails related to Work.com rewards. This includes when someone someone gives a reward to the user.
UserPreferencesDisableSharePostEmail
Type boolean Properties Filter Description When false, the user automatically receives email every time the user’s post is shared.
UserPreferencesDisableWorkEmail
Type boolean Properties Filter Description When false, the user receives emails related to Work.com feedback, goals, and coaching. The user must also sign up for individual emails listed on the Work.com email settings page. When true, the user will not receive any emails related to Work.com feedback, goals, or coaching even if they are signed up for individual emails.
UserPreferencesDisCommentAfterLikeEmail Type
boolean Properties Filter Description When false, the user automatically receives email every time someone comments on a post the user has liked. UserPreferencesDisMentionsCommentEmail Type
boolean Properties Filter
2004
Standard Objects
Field
UserProfile
Details Description When false, the user automatically receives email every time the user is mentioned in comments.
UserPreferencesDisProfPostCommentEmail Type
boolean Properties Filter Description When false, the user automatically receives email every time someone comments on posts on the user’s profile. UserPreferencesEnableAutoSubForFeeds
Type boolean Properties Filter Description When true, the user automatically subscribes to feeds for any objects that the user creates.
UserPreferencesEventRemindersCheckboxDefault Type
boolean Properties Filter Description When true, a reminder popup is automatically set on the user's events. Corresponds to the By default, set reminder on Events to... checkbox on the Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders. UserPreferencesHideChatterOnboardingSplash Type
boolean Properties Filter Description When true, the initial Chatter onboarding prompts do not appear. UserPreferencesHideCSNDesktopTask
Type boolean Properties Filter
2005
Standard Objects
Field
UserProfile
Details Description When true, the Chatter recommendations panel never displays the recommendation to install Chatter Desktop.
UserPreferencesHideCSNGetChatterMobileTask Type
boolean Properties Filter Description When true, the Chatter recommendations panel never displays the recommendation to install Chatter Mobile. UserPreferencesHideS1BrowserUI
Type boolean Properties Filter Description Controls the interface that the user sees when logging in to Salesforce from a supported mobile browser. If false, the user is automatically redirected to the Salesforce1 mobile browser app. If true, the user sees the full Salesforce site. The default value is false. Label is Salesforce1 User. This field is available in API version 29.0 or later.
UserPreferencesHideSecondChatterOnboardingSplash Type
boolean Properties Filter Description When true, the secondary Chatter onboarding prompts do not appear. UserPreferencesReminderSoundOff
Type boolean Properties Filter Description When true, a sound automatically plays when an activity reminder is due. Corresponds to the Play a reminder sound checkbox on the Reminders page in the user interface.
2006
Standard Objects
Field
UserProfile
Details
UserPreferencesShowCityToExternalUsers Type
boolean Properties Filter Description Indicates the visibility of the city field in the user’s contact information. City is visible only to internal members of the user’s organization when: • This field is false. When false, this field returns the value #N/A. City is visible to external members in a community when: • This field is true, or • This field is false but UserPreferencesShowCityToGuestUsers is true,
which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowCityToGuestUsers
Type boolean Properties Filter Description Indicates the visibility of the city field in the user’s contact information. When true, city is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowCityToExternalUsers, making
the user’s city visible to external members. The default value is false. This field is available in API version 28.0 and later. UserPreferencesShowCountryToExternalUsers Type
boolean Properties Filter
2007
Standard Objects
Field
UserProfile
Details Description Indicates the visibility of the country field in the user’s contact information. Country is visible only to internal members of the user’s organization when: • This field is false. When false, this field returns the value #N/A. Country is visible to external members in a community when: • This field is true, or • This field is false but UserPreferencesShowCountryToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal licenses. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowCountryToGuestUsers Type
boolean Properties Filter Description Indicates the visibility of the country field in the user’s contact information. When true, country is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowCountryToExternalUsers,
making the user’s country visible to external members. The default value is false. This field is available in API version 28.0 and later. UserPreferencesShowEmailToExternalUsers Type
boolean Properties Filter Description Indicates the visibility of the email address field in the user’s contact information. Email address is visible only to internal members of the user’s organization when this field is false. Email address is visible to external members in a community when this field is true.
2008
Standard Objects
Field
UserProfile
Details External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later.
UserPreferencesShowFaxToExternalUsers
Type boolean Properties Filter Description Indicates the visibility of the fax number field in the user’s contact information. Fax number is visible only to internal members of the user’s organization when this field is false. Fax number is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later.
UserPreferencesShowManagerToExternalUsers Type
boolean Properties Filter Description Indicates the visibility of the manager field in the user’s contact information. Manager is visible only to internal members of the user’s organization when this field is false. Manager is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowMobilePhoneToExternalUsers Type
boolean Properties Filter Description Indicates the visibility of the mobile or cellular phone number field in the user’s contact information. The number is visible only to internal members of the user’s organization when this field is false. The number is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses.
2009
Standard Objects
Field
UserProfile
Details When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later.
UserPreferencesShowPostalCodeToExternalUsers Type
boolean Properties Filter Description Indicates the visibility of the postal or ZIP code field in the user’s contact information. Postal code is visible only to internal members of the user’s organization when: • This field is false. When false, this field returns the value #N/A. Postal code is visible to external members in a community when: • This field is true, or • This field is false but UserPreferencesShowPostalCodeToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal licenses. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowPostalCodeToGuestUsers Type
boolean Properties Filter Description Indicates the visibility of the postal or ZIP code field in the user’s contact information. When true, postal code is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowPostalCodeToExternalUsers,
making the user’s postal code visible to external members. The default value is false. This field is available in API version 28.0 and later. UserPreferencesShowProfilePicToGuestUsers Type
boolean
2010
Standard Objects
Field
UserProfile
Details Properties Filter Description Indicates the visibility of the user’s profile photo. When true, the photo is visible to guest users in a community. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the stock photo. The default value is false. This field is available in API version 28.0 and later.
UserPreferencesShowStateToExternalUsers Type
boolean Properties Filter Description Indicates the visibility of the state field in the user’s contact information. State is visible only to internal members of the user’s organization when: • This field is false. When false, this field returns the value #N/A. State is visible to external members in a community when: • This field is true, or • This field is false but UserPreferencesShowStateToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowStateToGuestUsers
Type boolean Properties Filter Description Indicates the visibility of the state field in the user’s contact information. When true, state is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A.
2011
Standard Objects
Field
UserProfile
Details When true, this field overrides the value false in UserPreferencesShowStateToExternalUsers, making
the user’s state visible to external members. The default value is false. This field is available in API version 28.0 and later. UserPreferencesShowStreetAddressToExternalUsers Type
boolean Properties Filter Description Indicates the visibility of the street address field in the user’s contact information. The address is visible only to internal members of the user’s organization when this field is false. The address is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. UserPreferencesShowTitleToExternalUsers Type
boolean Properties Filter Description Indicates the visibility of the business title field in the user’s contact information. Title is visible only to internal members of the user’s organization when: • This field is false. When false, this field returns the value #N/A. Title is visible to external members in a community when: • This field is true, or • This field is false but UserPreferencesShowTitleToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal licenses. The default value is true. This field is available in API version 26.0 and later. UserPreferencesShowTitleToGuestUsers
Type boolean
2012
Standard Objects
Field
UserProfile
Details Properties Filter Description Indicates the visibility of the business title field in the user’s contact information. When true, title is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A. When true, this field overrides the value false in UserPreferencesShowTitleToExternalUsers, making
the user’s title visible to external members. The default value is false. This field is available in API version 28.0 and later. UserPreferencesShowWorkPhoneToExternalUsers Type
boolean Properties Filter Description Indicates the visibility of the work phone number field in the user’s contact information. The number is visible only to internal members of the user’s organization when this field is false. The number is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses. When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later. UserPreferencesTaskRemindersCheckboxDefault Type
boolean Properties Filter Description When true, a reminder popup is automatically set on the user's tasks. Corresponds to the By default, set reminder on Tasks to... checkbox on the Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders.
2013
Standard Objects
UserProfileFeed
Usage Use this object to query Chatter—related information about the user. While the User object contains all the information about a user and is historically tied to user management, UserProfile is a read-only entity that contains the information that is relevant in a Chatter context.
UserProfileFeed Represents a user profile feed, which tracks all actions by a user on records that can be tracked in a feed. This feed is displayed on the user profile page. UserProfileFeed is available in API version 18.0 through API 26.0. In API version 27.0 and later, UserProfileFeed is no longer available in the SOAP API. Use the Chatter REST API to access UserProfileFeed.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules You can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see. • “Manage Unlisted Groups” Only users with this permission can delete items in unlisted groups.
Fields Field
Details
Body
Type textarea Properties Nillable, Sort Description The content of UserProfileFeed. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort
2014
Standard Objects
Field
UserProfileFeed
Details Description The number of FeedComments associated with this feed item. Tip: In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only one. In a moderated feed, your comment isn’t counted until it's approved by an admin or a person with “CanApproveFeedPostAndComment” or “ModifyAllData” permission. This has implications for how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until end of comments is returned.
ContentData
Type base64 Properties Nillable Description Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort Description This field is required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.
2015
Standard Objects
UserProfileFeed
Field
Details
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.
CreatedDate
Type dateTime Properties Defaulted on create, Filter, Sort Description Date and time when this record was created. This field is a standard system field. Ordering by CreatedDateDESC sorts the feed by the most recent feed item.
FeedPostId
Type reference Properties Filter, Group, Nillable, Sort Description This field was removed in API version 22.0, and is available in earlier versions for backward compatibility only. ID of the associated FeedPost. A FeedPost represents the following types of changes in an FeedItem: changes to tracked fields, text posts, link posts, and content posts.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the logged-in user.
IsDeleted
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Standard system field. Indicates whether the record has been moved to the Recycle Bin (true) or not (false).
2016
Standard Objects
UserProfileFeed
Field
Details
LastModifiedDate
Type dateTime Properties Defaulted on create, Filter, Sort Description Date and time when a user last modified this record. This field is a standard system field. When a feed item is created, LastModifiedDate is the same as CreatedDate. If a FeedComment is inserted on that feed item, then LastModifiedDate becomes the CreatedDate for that FeedComment. Deleting the FeedComment does not change the LastModifiedDate. Ordering by LastModifiedDate DESC sorts the feed by both the most recent feed item or comment.
LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
NetworkScope
Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. NetworkScope can have the following values:
• NetworkId—The ID of the community in which the FeedItem is available. If left empty, the feed item is only available in the default community. • AllNetworks—The feed item is available in all communities. Note the following exceptions for NetworkScope:
2017
Standard Objects
Field
UserProfileFeed
Details • Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks. • You can’t filter a FeedItem on the NetworkScope field.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the account record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the user profile record. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item: • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging).
2018
Standard Objects
Field
UserProfileFeed
Details For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • CaseCommentPost—generated event when a user adds a case comment for a case object • EmailMessageEvent—generated event when an email related to a case object is sent or received • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • ChangeStatusPost—generated event when a user changes the status of a case • AttachArticleEvent—generated event when a user attaches an article to a case Note: If you set Type to ContentPost, also specify ContentData and ContentFileName.
2019
Standard Objects
UserProfileFeed
Field
Details
Visibility
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if Salesforce Communities is enabled for your organization. Visibility can have the following values:
• AllUsers—The feed item is available to all users who have permission to see the feed item. • InternalUsers—The feed item is available to internal users only. Note the following exceptions for Visibility: • For record posts, Visibility is set to InternalUsers for all internal users by default. • External users can set Visibility only to AllUsers. • On user and group posts, only internal users can set Visibility to InternalUsers.
Usage Use this object to query and retrieve record changes tracked in a user profile feed. Note the following when working with user profile feeds: • This object is read only in the API. • Queries retrieve feed items that include mentions from other users. • Use this object to query and retrieve lead feed items that were associated with a converted lead record. • Include a WITH clause and specify the UserId of the user whose profile you want to query. The WITH clause must come after a WHERE clause. Users that do not have the “View All Data” permission have the following limitations when querying records: • Must specify a LIMIT clause and the limit must be less than or equal to 1000. • Can include a WHERE clause that references UserProfileFeed fields, but cannot include references to fields in related objects. For example, you can filter by CreatedDate or ParentId, but not by Parent.Name. • Can include an ORDER BY clause that references UserProfileFeed fields, but cannot include references to fields in related objects. For example, you can ORDER BY CreatedDate or ParentId, but not by Parent.Name. Tip: To query for the most recent feed items, you should ORDER BY CreatedDate DESC, Id DESC. Note the following SOQL restrictions. • No SOQL limit if logged-in user has “View All Data” permission. If not, specify a LIMIT clause of 1,000 records or fewer.
2020
Standard Objects
UserProvAccount
• SOQL ORDER BY on fields using relationships is not available. Use ORDER BY on fields on the root object in the SOQL query. SEE ALSO: EntitySubscription FeedComment FeedTrackedChange
UserProvAccount Represents information that links a Salesforce user account with an account in a third-party (target) system, such as Google, for users of connected apps with Salesforce user provisioning enabled. This object is available in API version 33.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field
Details
ConnectedAppId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The 15 character application ID.
DeletedDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the associated user account in the target system was deleted. This value is automatically updated during the provisioning and reconciling processes.
ExternalEmail
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The email address as stored in the target system for the associated user account.
2021
Standard Objects
UserProvAccount
Field
Details
ExternalFirstName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The first name as stored in the target system for the associated user account.
ExternalLastName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The last name as stored in the target system for the associated user account.
ExternalUserId
Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique identifier for the user as stored in the target system.
ExternalUsername
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The username as stored in the target system for the associated user account.
IsKnownLink
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Setting the IsKnownLink value to true implies the administrator or another user is managing the relationship between the Salesforce user account and the third-party user account, manually. This field helps Salesforce coordinate updates between the UserProvAccountStaging object and the UserProvAccount object while committing staged accounts. Typically, for a matching user account (the same ExternalUserId for both objects), Salesforce copies the values from the UserProvAccountStaging object to the UserProvAccount object. However, if Salesforce encounters a UserProvAccountStaging object with a matching ExternalUserId but different LinkState and SalesforceUserId values
2022
Standard Objects
Field
UserProvAccount
Details during this process, Salesforce checks the UserProvAccount IsKnownLink value. If the IsKnownLinkvalue is true, Salesforce doesn’t copy the LinkState and SalesforceUserId values from the UserProvAccountStaging object to the UserProvAccount object (all other values are copied). The default is false, meaning Salesforce manages the account relationship.
LinkState
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The state of the current connection between the user account in the Salesforce organization and the associated user account in the target system. The valid values are: • linked— changes to the account in the Salesforce organization are queued to be updated for the associated user account in the target system. • duplicate— an associated account in the target system exists. • orphaned—no associated account exists in the target system. • ignored— changes to the account in the Salesforce organization have no effect on the associated user account in the target system.
Name
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique name for this object.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Namepointing, Sort, Update Description The user ID of the owner of this object—typically a Salesforce administrator.
SalesforceUserId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The user ID for the user account in the Salesforce organization that is associated with the user account in the target system.
2023
Standard Objects
UserProvAccountStaging
Field
Details
Status
Type picklist Properties Create, Filter, Group, Sort, Update Description The status of the account in the target system. The valid values are: • Active • Deactivated • Deleted
UserProvAccountStaging Temporarily stores user account information while a user completes the User Provisioning Wizard. This information that is stored in the UserProvAccount object when you click the button to collect and analyze accounts on the target system. User provisioning links a Salesforce user account with an account in a third-party (target) system. To configure user provisioning, you use a User Provisioning Wizard that guides you through the setup process. As you enter values about account details in the wizard, these values are stored in this object until you click the button to collect and analyze accounts on the target system. The general user provisioning configuration details are stored in the UserProvisioningConfig object.
Supported Calls create(),delete(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),undelete(),update(),upsert()
Fields Field Name
Details
ConnectedAppId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The 15 character connected app ID.
ExternalEmail
Type string Properties Create, Filter, Group, Nillable, Sort, Update
2024
Standard Objects
Field Name
UserProvAccountStaging
Details Description The email address as stored in the target system for the associated user account.
ExternalFirstName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The first name as stored in the target system for the associated user account.
ExternalLastName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The last name as stored in the target system for the associated user account.
ExternalUserId
Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique identifier for the user as stored in the target system.
ExternalUsername
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The username as stored in the target system for the associated user account.
LinkState
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The state of the current connection between the user account in the Salesforce organization and the associated user account in the target system. The valid values are: • linked— a user account matches one in the target system.
2025
Standard Objects
Field Name
UserProvAccountStaging
Details • duplicate— an associated account in the target system exists. • orphaned—no associated account exists in the target system. • ignored— changes to the account in the Salesforce organization have no effect on the associated user account in the target system.
Name
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique name for this object.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user ID of the owner of this object—typically a Salesforce administrator.
SalesforceUserId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The user ID for the user account in the Salesforce organization that is associated with the user account in the target system.
Status
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the account in the target system. The valid values are: • Active • Deactivated • Deleted
2026
Standard Objects
UserProvMockTarget
Usage When committing fields from a UserProvAccountStaging to a UserProvAccount object, Salesforce looks up the UserProvAccount record where UserProvAccountStaging.ExternalUserId = UserProvAccount.ExternalUserId. • If an ExternalUserId doesn't match an existing account, Salesforce creates a UserProvAccount record based on the UserProvAccountStaging record. • If an ExternalUserId matches, then Salesforce checks the UserProvAccount.isKnownLink value, and does the following. – If UserProvAccount.IsKnownLink = true, Salesforce copies the UserProvAccountStaging values to the UserProvAccount object, except for the ExternalUserId and LinkState values. – If UserProvAccount.IsKnownLink = false, Salesforce copies all of the UserProvAccountStaging values to the UserProvAccount object.
UserProvMockTarget Represents an entity for testing user data before committing the data to a third-party system for user provisioning. During the user provisioning process, user account information is sent to a third-party system to create, update or delete a user account on that system. While configuring user provisioning for your organization using a flow or Apex plugin, you can use this object to confirm the associated flow or plugin is sending the desired data. After confirming the correct fields and values, you can update the flow or Apex plugin to send the data to the target system.
Supported Calls create(),delete(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),undelete(),update(),upsert()
Fields Field Name
Details
ExternalEmail
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The email address as stored in the target system for the associated user account.
ExternalFirstName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The first name as stored in the target system for the associated user account.
2027
Standard Objects
UserProvisioningConfig
Field Name
Details
ExternalLastName
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The last name as stored in the target system for the associated user account.
ExternalUserId
Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique identifier for the user as stored in the target system.
ExternalUsername
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The username as stored in the target system for the associated user account.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique name for this object.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user ID of the owner of this object—typically a Salesforce administrator.
UserProvisioningConfig Represents information for a flow to use during a user provisioning request process, such as the attributes for an update. This object is available in API version 34.0 and later.
2028
Standard Objects
UserProvisioningConfig
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
ApprovalRequired
Type textarea Properties Create, Nillable, Update Description Denotes whether approvals are required for provisioning users for the associated connected app. If the value is null, no approval is required.
ConnectedAppId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The 18-digit application ID for the connected app.
DeveloperName
Type string Properties Create, Filter, Group, Sort, Update 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.
Enabled
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether user provisioning is enabled for the associated connected app (true) or not (false).
2029
Standard Objects
UserProvisioningConfig
Field Name
Details
EnabledOperations
Type textarea Properties Create, Nillable, Update Description Lists the operations, as comma-separated values, that create a UserProvisioningRequest object for the associated connected app. Allowed values are: • Create • Update • EnableAndDisable (activation and deactivation) • SuspendAndRestore (freeze and unfreeze)
Language
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The two- to five-character code that represents the language and locale ISO. This code controls the language for labels displayed in an application.
LastReconDateTime
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when user accounts were last reconciled between Salesforce and the target system.
MasterLabel
Type string Properties Create, Filter, Group, Sort, Update Description The master label for this object. This value is the internal label that doesn’t get translated.
NamedCredentialId
Type reference
2030
Standard Objects
Field Name
UserProvisioningConfig
Details Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce ID of the named credential that’s used for a request. The named credential identifies the third-party system and the third-party authentication settings.
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value 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.
Notes
Type textarea Properties Create, Nillable, Update Description A utility field for administrators to add any additional information about the configuration. This field is for internal reference only, and is not used by any process.
OnUpdateAttributes
Type textarea Properties Create, Nillable, Update
2031
Standard Objects
Field Name
UserProvisioningLog
Details Description Lists the user attributes, as comma-separated values, that generate a UserProvisioningRequest object during an update.
ReconFilter
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description When collecting and analyzing users on a third-party system, the plug-in uses this filter to limit the scope of the collection.
UserAccountMapping
Type textarea Properties Create, Nillable, Update Description Stores the attributes used to link the Salesforce user to the account on the third-party system, in JSON format. For example: {"linkingSalesforceUserAttribute":"Username", "linkingTargetUserAttribute":"Email"}
UserProvisioningLog Represents messages generated during the process of provisioning users for third-party applications. This object is available in API version 33.0 and later. Some messages for this object are generated automatically by Salesforce, and others are created by the developers of the user provisioning plugin. Developers can use this object to log messages from the flow associated with the user provisioning process or the Apex plugin that calls the target system. Administrators can use this object as a log of all user provisioning activity and as a troubleshooting tool if desired behavior is missing. This object is available as a custom report type.
Supported Calls create(),delete(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),undelete(),update(),upsert()
2032
Standard Objects
UserProvisioningLog
Fields Field
Details
Details
Type textarea Properties Create, Nillable, Update Description The value of this field depends on the log entry. For example, if the target system returns an error, the error message may be recorded in this field.
ExternalUserId
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier for the user in the target system.
ExternalUsername
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The username set in the target system for the associated user account.
Name
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique name for this object.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Salesforce ID of the Group or User who owns this object.
Status
Type string
2033
Standard Objects
Field
UserProvisioningRequest
Details Properties Create, Filter, Group, Nillable, Sort, Update Description The status of the user provisioning request. Based on the context of the log, it can contain different values, such as an HttpStatusCode.
UserId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce ID of the user making the request.
UserProvisioningRequestId Type
reference Properties Create, Filter, Group, Nillable, Sort, Update Description A unique identifier for the user provisioning request.
UserProvisioningRequest Represents an individual provisioning request to create, update, or delete a single user account in a third-party service system (or another Salesforce organization). This object is available in API version 33.0 and later. A UserProvisioningRequest (UPR) record is created for each provisioning action for each user, and for each connected app available to the user. For example, if a user has two connected apps, and a provisioning request is sent to two different services to create an account for the user, Salesforce creates two UPR objects. Provisioning actions include creating, updating, or deleting a user account.
Supported Calls create(),delete(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),undelete(),update(),upsert()
Fields Field
Details
AppName
Type string Properties Create, Filter, Group, Nillable, Sort, Update
2034
Standard Objects
Field
UserProvisioningRequest
Details Description The unique name of the connected app associated with the service provider.
ApprovalStatus
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the approval for the current request. If the user provisioning setup for the connected app does not have an approval process enabled, the status is Not Required. If an approval process is enabled, supported values are: • Required— An approval process is enabled in the user provisioning setup for the associated connected app, but there is no response to the request yet. • Not Required— An approval process is not enabled in the user provisioning setup for the associated connected app. • Approved • Denied
ConnectedAppId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The 18-digit application ID for the connected app.
ExternalUserId
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier for the user in the target system.
ManagerId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce ID of the user who manages the user specified in the SalesforceUserId field. If an approval process is configured for the user provisioning request. this value allows the manager to approve the request. Available in API version 34.0 and later.
2035
Standard Objects
UserProvisioningRequest
Field
Details
Name
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The unique name for this object.
Operation
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The Apex method called by the trigger associated with the provisioning request (typically a change to the User object). Supported values are: • Create • Read • Update • Deactivate • Activate • Freeze • Unfreeze • Reconcile • Linking For example, when the User object field isActive is set to false, the UPR object Operation field value is set to Deactivate.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Salesforce ID of the Group or User who owns this object.
ParentID
Type reference Properties Create, Filter, Group, Sort, Update Description When a retry event is created, the failed UPR is cloned and resubmitted. This field contains a lookup to the failed UPR that was cloned to create the current record.
2036
Standard Objects
UserProvisioningRequest
Field
Details
Retry Count
Type int Properties Create, Filter, Group, Sort, Update Description Number of retry attempts performed on a UPR. Retry Count enables custom business logic such as “Retry 5 times then stop and notify your admin.”
SalesforceUserId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce ID of the user making the request.
ScheduleDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description When to send this request to the service provider. Note: Scheduling is not implemented yet. Currently, provisioning changes are queued immediately to be sent to the service provider.
State
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Status of this request. Supported values are: •
New
•
Requested
•
Completed
•
Failed
•
Collecting
•
Collected
•
Analyzing
•
Analyzed
•
Committing
• Retried
2037
Standard Objects
Field
UserProvisioningRequest
Details • Manually Completed The State goes from New to Requested to Completed or Failed, unless a reconciliation process is occurring. For details about the reconciliation process State value changes, see Usage. The State goes from Failed to Retried or Manually Completed when troubleshooting UPR failures. For details about handling failures, see State Values for Managing Provisioning Failures.
UserProvAccountId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID value of the associated UserProvAccount object.
UserProvConfigId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID value of the associated UserProvisioningConfig object. Available in API version 34.0 and later.
Usage The State value changes during a reconciliation process (Operation = Reconcile) to gather and compare users on the third-party system to Salesforce users. Typically, when a UPR entry is first created, it has a State value of New. When a collection process is triggered, the State transitions to Collecting until that process is finished and the State is Collected. When an analyze process is triggered, the State transitions to Analyzing until that process is finished and the State is Analyzed. If a process commits the request, the State then transitions to Committing, and the properties move from the UserProvAccountStaging object to the UserProvAccount object. When those properties are saved in the UserProvAccount object, the State transitions to Completed. However, the State does not necessarily start at New. For example, UserProvAccountStaging entries can be inserted programmatically. If a process is initiated that triggers linking these rows to accounts on the third-party service, a UPR entry could start with the Analyzing State. Also, the State cannot go backwards from an active task. For example, a successful Analyzing State must progress to Analyzed; unless the active process fails, and then the State must change to Failed. Certain State transitions cannot be made programmatically and must be triggered by Salesforce. The following table shows the State transitions that can occur for each State value. Each row corresponds to a current State value and each column corresponds to a new State after a potential transition. •
— the transition to this value is not allowed.
2038
Standard Objects
•
UserProvisioningRequestOwnerSharingRule
— the transition to this value is allowed.
•
— only Salesforce can transition the State to this value. New
Requested Collecting Collected Analyzing Analyzed Committing Completed Failed Retried Manually Completed
New Requested Collecting Collected Analyzing Analyzed Committing Completed Failed Retried Manually Completed
State Values for Managing Provisioning Failures The state value changes to Failed for several reasons, such as network outages, session timeouts, permissions issues, and record locks. The Failed state can transition to either Retried or Manually Completed to indicate what action was taken to address the failure. Actions can include correcting the root cause of the failure and requesting that the provisioning engine retry the UPR. Or, it can be completing the action against the target manually. Each UPR is an independent transaction and it’s possible the retry causes a failure with a different root cause. So it’s hard to distinguish failed events that you addressed from the ones that require more action. If you tried to correct the cause of the failure and requested the provisioning engine to retry the UPR, you can mark the failed UPR Retried. Or, if the action against the target was completed manually, you can mark it Manually Completed. When a retry event is created, the failed UPR is cloned, and resubmitted. The ParentID field contains a lookup to the failed UPR to use to clone the new UPR. The Retry Count field contains the number of retry attempts that were performed on a UPR. With the Retry Count field, you can add custom business logic like "Retry 5 times then stop and notify your admin."
UserProvisioningRequestOwnerSharingRule Represents a rule for sharing a UserProvisioningRequest object with users other than the owner. This object is available in API version 34.0 and later. Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer support to enable access to this object for your org.
2039
Standard Objects
UserProvisioningRequestOwnerSharingRule
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description A value that represents the type of sharing allowed. The possible values are: • Read • Edit
Description
Type textarea Properties Create, Filter, Nillable, Sort, Update Description A description of the sharing rule. Maximum size is 1000 characters.
DeveloperName
Type string Properties Create, Filter, Group, Nillable, Sort, Update 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. Note: 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.
GroupId
Type reference Properties Create, Filter, Group, Sort
2040
Standard Objects
Field Name
UserProvisioningRequestShare
Details Description The ID representing the source group. UserProvisioningRequest objects owned by users in the source group trigger the rule to give access.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to Label in the user interface.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description The ID representing the target user or group. Target users or groups have access to the UserProvisioningRequest object.
SEE ALSO: Metadata API Developer Guide: SharingRules
UserProvisioningRequestShare Represents a sharing entry on a UserProvisioningRequest record. This object is available in API version 34.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update
2041
Standard Objects
Field Name
UserRecordAccess
Details Description A value that represents the type of sharing allowed. The possible values are: • Read • Edit
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the parent record, if any.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Values may include: • Manual—The User or Group has access because a user with “All” access manually shared the UserProvisioningRequest record with them. • Owner—The User is the owner of the UserProvisioningRequest record or is in a role above the UserProvisioningRequest record owner in the role hierarchy.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the UserProvisioningRequest record.
UserRecordAccess Represents a user’s access to a set of records. This object is read only and is available in API version 24.0 and later.
2042
Standard Objects
UserRecordAccess
Supported Calls describeSObjects(), query()
Fields Field
Details
HasAllAccess
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user can share the record.
HasDeleteAccess
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user has delete access to the record (true) or not (false).
HasEditAccess
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user has edit access to the record (true) or not (false).
HasTransferAccess
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user has transfer access to the record (true) or not (false).
HasReadAccess
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a user has read access to the record (true) or not (false).
2043
Standard Objects
UserRecordAccess
Field
Details
MaxAccessLevel
Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Indicates a user’s maximum level of access to a record. Valid values are: • None • Read • Edit • Delete • Transfer • All
RecordId
Type picklist Properties Filter, Group, Restricted picklist, Sort Description ID of the record.
UserId
Type reference Properties Filter, Group Description ID of the user.
Usage Use this object to query a user’s access to records. You can’t create, delete, or update any records using this object. Up to 200 record IDs can be queried. You can include an ORDER BY clause for any field that is being selected in the query. The following sample query returns the records, whether the queried user has read and transfer access to each record, and the user’s maximum access level to each record. SELECT RecordId, HasReadAccess, HasTransferAccess, MaxAccessLevel FROM UserRecordAccess WHERE UserId = [single ID] AND RecordId = [single ID] //or Record IN [list of IDs]
2044
Standard Objects
UserRole
The following query returns the records to which a queried user has read access. SELECT RecordId FROM UserRecordAccess WHERE UserId = [single ID] AND RecordId = [single ID] AND HasReadAccess = true
//or Record IN [list of IDs]
Using API version 30.0 and later, UserRecordAccess is a foreign key on the records. You can’t filter by or provide the UserId or RecordId fields when using this object as a lookup or foreign key. The previous sample queries can be run as: SELECT Id, Name, UserRecordAccess.HasReadAccess, UserRecordAccess.HasTransferAccess, UserRecordAccess.MaxAccessLevel FROM Account SELECT Id, Name, UserRecordAccess.HasReadAccess FROM Account
SOQL restrictions: • When the running user is querying a user's access to a set of records, records that the running user does not have read access to are filtered out of the results. • When filtering by UserId and RecordId only, you must use SELECT RecordId and optionally one or more of the access level fields:HasReadAccess, HasEditAccess, HasDeleteAccess, HasTransferAccess, and HasAllAccess. You may include MaxAccessLevel. • When filtering by UserId, RecordId, and an access level field, you must use SELECT RecordId only.
UserRole Represents a user role in your organization. Note: This object was called “Role” in previous versions of the API documentation.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert()
Special Access Rules Customer Portal users can't access this object.
Fields Field
Details
CaseAccessForAccountOwner
Type picklist
2045
Standard Objects
Field
UserRole
Details Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The case access level for the account owner.
ContactAccessForAccountOwner
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The contact access level for the account owner. Note: When DefaultContactAccess is set to Controlled by Parent, you can’t create or update this field.
DeveloperName
Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update 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. Corresponds to Role Name in the user interface. This field is available in API version 24.0 and later. Note: 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.
ForecastUserId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the forecast manager associated with this role. Label is User ID.
IsPartner
Type boolean
2046
Standard Objects
Field
UserRole
Details Properties Defaulted on create, Filter Description Indicates whether the user role is a partner who has access to the partner portal (true) or not (false). This field is not available for release 9.0 and later. Instead, use PortalType with the value Partner.
MayForecastManagerShare
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the forecast manager can manually share their own forecast.
Name
Type string Properties Create, Filter, Group, Sort, Update Description Required. Name of the role. Corresponds to Label on the user interface.
OpportunityAccessForAccountOwner
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The opportunity access level for the account owner. Note that you can’t set a user role with an opportunity access less than that specified in organization-wide defaults.
ParentRoleId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the parent role.
PortalRole
Type picklist Properties Filter, Nillable
2047
Standard Objects
Field
UserRole
Details Description The portal role: Executive, Manager, User, or PersonAccount.
PortalType
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description This value indicates the type of portal for the role: • None: Salesforce application role. • CustomerPortal: Customer portal role. • Partner: partner portal role. The field IsPartner used in release 8.0 will map to this value. This field replaces IsPartner beginning with release 9.0.
RollupDescription
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the forecast rollup. Label is Description.
Usage Use this object to query the set of currently configured user roles in your organization. Use it in your client application to obtain valid UserRole IDs to use when querying or modifying a User record. All users have access to invoke query or describe this object. If your client application logs in with the “Manage Users” permission, it can query, create, update, or delete UserRole records. Note: You can’t update any field for a portal role. For example, the following code finds all roles that are not assigned to any users. SELECT Id, Name, DeveloperName, FROM UserRole WHERE Id NOT IN (SELECT UserRoleId FROM User WHERE UserRoleId !='000000000000000')
SEE ALSO: Object Basics
2048
Standard Objects
UserServicePresence
UserServicePresence Represents a presence user’s real-time presence status. This object is available in API version 32.0 and later.
Supported Calls query(), getDeleted(), getUpdated(), retrieve()
Fields Field
Details
ConfiguredCapacity
Type int Properties Filter, Group, Nillable, Sort Description The user’s total configured capacity.
IsAway
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user’s status is Away.
Name
Type string Properties Create, Filter, Nillable, Sort, Update Description An automatically generated ID number that identifies the record.
ServicePresenceStatusId Type
reference Properties Create, Filter, Nillable, Sort, Update Description The ID of the presence status that’s associated with the presence user that’s specified by the UserId. UserId
Type string
2049
Standard Objects
Field
UserShare
Details Properties Create, Filter, Group, Sort, Update Description The ID of the Omni-Channel user.
UserShare Represents a sharing entry on a user record. This object is available in API version 26.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Special Access Rules Customer Portal users can't access this object.
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field
Details
IsActive
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Read-only. Indicates whether the User has access to log in (true) or not (false). You can modify a User's active status from the user interface or via the API.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. You can only write to this field when its value is either omitted or set to Manual (default). You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings.
2050
Standard Objects
Field
UserShare
Details Possible values include: • Manual—The User or Group has access to the user record because a User with “All” access manually shared the User with them. • Rule—The User or Group has access to the user record via a User sharing rule.
UserAccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the User or Group has to the specified user. The specified user is denoted by the UserId. The possible values are: • Read • Edit This field must be set to an access level that is at least equal to the organization’s default UserAccessLevel. UserAccessLevel can be updated only if RowCause is set to Manual Sharing.
UserId
Type reference Properties Create, Filter, Group, Sort Description ID of the User being shared.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the User or Group that has been given access to the User. This field can’t be updated.
Usage This object allows you to determine which users and groups can view or edit User records owned by other users.
2051
Standard Objects
UserTeamMember
UserTeamMember Represents a single User on the default opportunity team of another User.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Special Access Rules • This object is available only in organizations that have enabled the team selling functionality. • Customer Portal users can’t access this object.
Fields Field
Details
OpportunityAccessLevel Type
picklist Properties Create, Filter, Restricted picklist, Update Description Required. Level of access that the team member has to opportunities for which the user has added his or her default opportunity team. The possible values are: • Read • Edit This field must be set to an access level that is higher than the organization’s default access level for opportunities. OwnerId
Type reference Properties Create, Filter Description Required. ID of the User who owns the default opportunity team. This field can’t be updated.
TeamMemberRole
Type picklist Properties Create, Filter, Nillable, Update
2052
Standard Objects
Field
UserTerritory
Details Description Role that the team member has on opportunities for which the User has added his or her default opportunity team. The valid values are set by the organization’s administrator in the Opportunity Team Roles picklist. Label is Team Role.
UserId
Type reference Properties Create, Filter Description Required. ID of the User who is a member of the default opportunity team. This field can’t be updated.
Usage If you attempt to create a record that matches an existing record, the create request updates any modified fields and returns the existing record. Users can set up their default opportunity team to include other users that typically work with them on opportunities. SEE ALSO: OpportunityTeamMember
UserTerritory Represents a User who has been assigned to a Territory.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules • Only available if territory management has been enabled for your organization. • Customer Portal users can’t access this object.
Fields Field
Details
IsActive
Type boolean
2053
Standard Objects
Field
UserTerritory
Details Properties Defaulted on create, Filter Description Indicates whether the user is active in the given territory (true), or inactive in the given territory (false): • Users who are active in a territory are explicitly assigned to the territory and can have open opportunities, closed opportunities, or no opportunities associated with that territory. • Users who are inactive in a territory are not explicitly assigned to the territory, but own an open or closed opportunity that is associated with the territory. For example, a user may have been transferred out of a territory, but still own opportunities in his or her old territory. Until a user is deleted from a territory (not simply removed from the territory), the record is not returned in a getDeleted() call.
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
TerritoryId
Type reference Properties Create, Filter Description ID of the Territory to which the user has been assigned. This field is required when creating a record in API version 20.0 and later.
UserId
Type reference Properties Create, Filter Description ID of the user. This field is required when creating a record.
2054
Standard Objects
UserTerritory2Association
Usage If a user is inactive in a territory, and the opportunities they own that are associated with the territory are all closed, then the user is not returned. SEE ALSO: Territory AccountTerritoryAssignmentRule AccountTerritoryAssignmentRuleItem
UserTerritory2Association Represents an association (by assignment) between a territory and a user record. Available only if Enterprise Territory Management has been enabled for your organization.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve()
Special Access Rules If a territory model is in Active state, any user can view that model, including its territories and assignment rules. For territories in an active model, any user can view assigned records and assigned users subject to your organization’s sharing settings. Users cannot view territory models in other states (such as Planning or Archived).
Fields Field Name
Details
IsActive
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user is active (true) or inactive (false) in the given territory.
RoleInTerritory2
Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The role of the user in a territory. Possible values are: Owner, Administrator, Sales Rep. Label is Role in Territory.
2055
Standard Objects
VerificationHistory
Field Name
Details
Territory2Id
Type reference Properties Create, Filter, Group, Sort Description The ID of the territory that the user is assigned to.
UserId
Type reference Properties Create, Filter, Group, Sort Description The ID of the user who is assigned to the territory.
VerificationHistory Represents the past six months of your org users’ attempts to verify their identity. This object is available in API version 36.0 and later.
Supported Calls describeSObjects(), query(), retrieve()
Special Access Rules Only users with “Manage Users” permission can access this object.
Fields Field Name
Details
Activity
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The action the user attempted that requires identity verification. The label is User Activity. Available values are: • AccessReports—The user attempted to access reports or dashboards. • Apex—The user attempted to access a Salesforce resource with a verification Apex method.
2056
Standard Objects
Field Name
VerificationHistory
Details • ChangeEmail—The user attempted to change an email address. • ConnectToopher—The user attempted to connect Salesforce Authenticator. • ConnectTotp—The user attempted to connect a one-time password generator. • ConnectU2F—The user attempted to register a U2F security key. • ConnectedApp—The user attempted to access a connected app. • EnableLL—The user attempted to enroll in Lightning Login. • ExportPrintReports—The user attempted to export or print reports or dashboards. • ExtraVerification—Reserved for future use. • Login—The user attempted to log in. • Registration—Reserved for future use. • TempCode—The user attempted to generate a temporary verification code.
EventGroup
Type int Properties Filter, Group, Sort Description ID of the verification attempt. Verification can involve several attempts and use different verification methods. For example, in a user’s session, a user enters an invalid verification code (first attempt). The user then enters the correct code and successfully verifies identity (second attempt). Both attempts are part of a single verification and, therefore, have the same ID. The label is Verification Attempt.
LoginGeoId
Type reference Properties Filter, Group, Nillable, Sort Description The 18-character ID for the record of the geographic location of the user for a successful or unsuccessful identity verification attempt. Due to the nature of geolocation technology, the accuracy of geolocation fields (for example, country, city, postal code) may vary.
LoginHistoryId
Type reference Properties Filter, Group, Sort Description The ID for the record of the user’s successful or unsuccessful login attempt.
2057
Standard Objects
VerificationHistory
Field Name
Details
Policy
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The identity verification security policy or setting. The label is Triggered By. Available values are: • CustomApex—Identity verification made by a verification Apex method. • DeviceActivation—Identity verification required for users logging in from an unrecognized device or new IP address. This verification is part of Salesforce’s risk-based authentication. • EnableLightningLogin—Identity verification required for users enrolling in Lightning Login. This verification is triggered when the user attempts to enroll. Users are eligible to enroll if they have the “Lightning Login User” user permission and the org has enabled “Allow Lightning Login” in Session Settings. • ExtraVerification—Reserved for future use. • HighAssurance—High assurance session required for resource access. This verification is triggered when the user tries to access a resource, such as a connected app, report, or dashboard that requires a high-assurance session level. • LightningLogin—Identity verification required for users logging in via Lightning Login. This verification is triggered when the enrolled user attempts to log in. Users are eligible to log in if they have the “Lightning Login User” user permission, have successfully enrolled in Lightning Login, and the org has enabled “Allow Lightning Login” in Session Settings. • PageAccess—Identity verification required for users attempting to perform an action, such as changing an email address or adding a two-factor authentication method. • ProfilePolicy—Session security level required at login. This verification is triggered by the “Session security level required at login” setting on the user’s profile. • TwoFactorAuthentication—Two-factor authentication required at login. This verification is triggered by the “Two-Factor Authentication for User Interface Logins” user permission assigned to a custom profile. Or, the user permission is included in a permission set that is assigned to a user.
Remarks
Type string Properties Filter, Group, Nillable, Sort
2058
Standard Objects
Field Name
VerificationHistory
Details Description The text the user sees on the screen or in Salesforce Authenticator when prompted to verify identity. For example, if identity verification is required for a user’s login, the user sees “You’re trying to Log In to Salesforce”. In this instance, the Remarks value is “Log In to Salesforce”. The exception is when the Activity value is Apex. In this instance, the Remarks value is a custom description passed by the Apex method. If the user is verifying identity using the Salesforce Authenticator app, the custom description displays in the app as well. If the custom description isn’t specified, the default value is the name of the Apex method. The label is Activity Message.
ResourceId
Type reference Properties Filter, Group, Nillable, Sort Description If the Activity value is ConnectedApp, the ResourceId value is the ID of the connected app. The label is Connected App ID.
SourceIp
Type string Properties Filter, Group, Sort Description The IP address of the machine from which the user attempted the action that requires identity verification. For example, the IP address of the machine from where the user tried to log in or access reports. If it’s a non-login action that required verification, the IP address can be different from the address from where the user logged in. This address can be an IPv4 or IPv6 address.
Status
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the identity verification attempt. Available values are: • AutomatedSuccess—Salesforce Authenticator approved the request for access because the request came from a trusted location. After users enable location services in Salesforce Authenticator, they can designate trusted locations. When a user trusts a location for a particular activity, such as logging in from a recognized device, that activity is approved from the trusted location for as long as the location is trusted.
2059
Standard Objects
Field Name
VerificationHistory
Details • Denied—The user denied the approval request in the authenticator app, such as Salesforce Authenticator. • FailedGeneralError—An error caused by something other than an invalid verification code, too many verification attempts, or authenticator app connectivity. • FailedInvalidCode—The user provided an invalid verification code. • FailedTooManyAttempts—The user attempted to verify identity too many times. For example, the user entered an invalid verification code repeatedly. • Initiated—Salesforce initiated identity verification but hasn’t yet challenged the user. • InProgress—Salesforce challenged the user to verify identity and is waiting for the user to respond or for Salesforce Authenticator to send an automated response. • RecoverableError—Salesforce can’t reach the authenticator app to verify identity, but will retry. • ReportedDenied—The user denied the approval request in the authenticator app, such as Salesforce Authenticator, and also flagged the approval request to report to an administrator. • Succeeded—The user’s identity was verified.
UserId
Type reference Properties Filter, Group, Sort Description ID of the user verifying identity.
VerificationMethod
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The method by which the user attempted to verify identity in the verification event. The label is Method. Available values are: • Email—Salesforce sent an email with a verification code to the address associated with the user’s account. • EnableLL—Salesforce Authenticator sent a notification to the user’s mobile device to enroll in Lightning Login. This value is available in API version 38.0 and later. • LL—Salesforce Authenticator sent a notification to the user’s mobile device to approve login via Lightning Login. This value is available in API version 38.0 and later.
2060
Standard Objects
Field Name
VisualforceAccessMetrics
Details • SalesforceAuthenticator—Salesforce Authenticator sent a notification to the user’s mobile device to verify account activity. • Sms—Salesforce sent a text message with a verification code to the user’s mobile device. • TempCode—A Salesforce admin or a user with the “Manage Two-Factor Authentication in User Interface” permission generated a temporary verification code for the user. This value is available in API version 37.0 and later. • Totp—An authenticator app generated a time-based, one-time password (TOTP) on the user’s mobile device. • U2F—A U2F security key generated required credentials for the user. This value is available in API version 38.0 and later.
VerificationTime
Type dateTime Properties Filter, Sort Description The time of the identity verification attempt. The time zone is based on GMT. The label is Time.
Usage Here are two examples of the types of API queries you can perform. Query
String
Show verification history for a user’s login record
SELECT Activity, EventGroup, Policy, Remarks, Status, UserId,VerificationMethod, VerificationTime FROM VerificationHistory WHERE LoginHistoryId = '0YaD000#########'
Get detailed geographic location information for a user’s verification SELECT City, CountryIso, Latitude, attempt Longitude, PostalCode FROM LoginGeo WHERE LoginGeoId = '0LE###############'
VisualforceAccessMetrics Represents summary statistics for Visualforce pages.
Supported Calls count(), query(), retrieve()
2061
Standard Objects
VoiceCall
Fields Field
Details
ApexPageId
Type reference Properties Aggregate, Filter, Group, Sort Description The ID of the Visualforce page.
DailyPageViewCount
Type integer Properties Aggregate, Filter, Group, Nillable, Sort Description The number of views received by the specified Visualforce page.
MetricsDate
Type date Properties Aggregate, Filter, Group, Sort Description The date the metrics are queried.
Usage Use this object to query information on the Visualforce pages in your org. SELECT ApexPageId,DailyPageViewCount,Id,MetricsDate FROM VisualforceAccessMetrics
VoiceCall Represents a Lightning Dialer phone call.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
2062
Standard Objects
VoiceCall
Fields Field Name
Details
CallDisposition
Type string Properties Filter, Group, Nillable, Sort Description The status of a phone call, such as whether a phone call is in progress, busy,or failed.
CallDurationInSeconds
Type int Properties Filter, Group, Nillable, Sort Description The total call duration in seconds.
CallEndDateTime
Type dateTime Properties Filter, Sort Description The time when a call ends.
CallStartDateTime
Type dateTime Properties Filter, Sort Description The time when a call starts.
CallType
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Whether a call is internal, inbound, or outbound.
CurrencyCode
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort
2063
Standard Objects
Field Name
VoiceCall
Details Description The currency used to bill the call.
FromPhoneNumber
Type phone Properties Filter, Group, Sort Description The phone number of the user who initiated the call.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this VoiceCall.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this VoiceCall. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.
OwnerId
Type reference Properties Filter, Group, Sort Description The ID of the user who owns the phone number.
Price
Type double Properties Filter, Nillable, Sort Description The cost of the phone call.
2064
Standard Objects
VoiceCall
Field Name
Details
RelatedRecordId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related record.
ToPhoneNumber
Type phone Properties Filter, Group, Sort Description The recipient of the phone call.
UserId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the Dialer user.
VendorCallKey
Type string Properties Filter, Group, Nillable, Sort Description The ID of the child leg of the call that’s provided by the Dialer vendor.
VendorParentCallKey
Type string Properties Filter, Group, Nillable, Sort Description The ID of the parent leg of the call that’s provided by the Dialer vendor.
VoiceVendorLineId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the associated Dialer vendor line.
2065
Standard Objects
VoiceCallList
VoiceCallList Represents a prioritized list of numbers to call.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
Fields Field Name
Details
IsActive
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the call list is active or not.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the call list.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the call list owner.
VoiceCallListItem Represents a single phone number in a prioritized call list.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
2066
Standard Objects
VoiceCallListShare
Fields Field Name
Details
CallListId
Type reference Properties Create, Filter, Group, Sort Description The ID of the related call list.
Ordinal
Type int Properties Create, Filter, Group, Sort, Update Description The order of the item in the overall call list.
RelatedRecordId
Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the related record.
State
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Whether the call list item is not called, called, or skipped.
VoiceCallListShare Represents a sharing entry on a VoiceCallList.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
2067
Standard Objects
VoiceCallListShare
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the VoiceCallList. The possible values are: • Read • Edit • All This field must be set to an access level higher than the organization’s default access level for call lists.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The ID of the VoiceCallList that is associated with this sharing entry.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. Read-only. Valid values include: • Owner • Manual • Rule
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description The ID of the user or group that was given access to the call list. This field can’t be updated.
2068
Standard Objects
VoiceCallShare
VoiceCallShare Represents a sharing entry on a VoiceCall object.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the VoiceCall. The possible values are: • Read • Edit • All This field must be set to an access level higher than the organization’s default access level for Dialer calls.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The ID of the VoiceCall that is associated with this sharing entry.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. Read-only. Valid values include: • Owner • Manual • Rule
2069
Standard Objects
VoiceMailContent
Field Name
Details
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description The ID of the user or group that was given access to the Dialer call. This field can’t be updated.
VoiceMailContent Represents a voicemail message left by a caller to the context user.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
Fields Field Name
Details
DurationInSeconds
Type int Properties Create, Filter, Group, Sort, Update Description The duration of the voicemail message in seconds.
FirstHeardDateTime
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time and date when the user first listened to the voicemail message.
MediaContentId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update
2070
Standard Objects
Field Name
VoiceMailContentShare
Details Description The ID of the related media content, a ContentDocument. The record counts toward your org’s file storage quota.
Name
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the voicemail message.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of the voicemail message.
VoiceCallId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related Dialer call.
VoiceMailContentShare Represents a sharing entry on a VoiceMailContent.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
AccessLevel
Type picklist
2071
Standard Objects
Field Name
VoiceMailMessage
Details Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the VoiceMailContent. The possible values are: • Read • Edit • All This field must be set to an access level higher than the organization’s default access level for voicemail messages.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The ID of the VoiceMailContent that is associated with this sharing entry.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. Read-only. Valid values include: • Owner • Manual • Rule
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description The ID of the user or group that was given access to the voicemail message. This field can’t be updated.
VoiceMailMessage Represents a prerecorded voicemail message.
2072
Standard Objects
VoiceMailMessage
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
Fields Field Name
Details
DurationInSeconds
Type int Properties Create, Filter, Group, Sort, Update Description The duration of a prerecorded voicemail message in seconds.
IsDefault
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether the message is the context user’s default voicemail drop message.
MediaContentId
Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the file.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the prerecorded voicemail message.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the prerecorded voicemail message.
2073
Standard Objects
VoiceMailMessageShare
VoiceMailMessageShare Represents a sharing entry on a VoiceMailMessage.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the VoiceMailMessage. The possible values are: • Read • Edit • All This field must be set to an access level higher than the organization’s default access level for voicemail messages.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The ID of the VoiceMailMessage that is associated with this sharing entry.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. Read-only. Valid values include: • Owner • Manual • Rule
2074
Standard Objects
VoiceUserLine
Field Name
Details
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description The ID of the user or group that was given access to the prerecorded voicemail message. This field can’t be updated.
VoiceUserLine Represents a user’s forwarding phone number.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
Fields Field Name
Details
IsVerified
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Reserved for future use.
Name
Type string Properties Create, Filter, Group, idLookup, Sort Description The name of the phone number.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update
2075
Standard Objects
Field Name
VoiceUserLineShare
Details Description The ID of the user who owns the phone number.
PhoneNumber
Type phone Properties Create, Filter, Group, Sort, Update Description The user’s phone number.
UserId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user using the phone number.
VoiceUserLineShare Represents a sharing entry on a user’s phone number.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the VoiceUserLine. The possible values are: • Read • Edit • All
2076
Standard Objects
Field Name
VoiceVendorInfo
Details This field must be set to an access level higher than the organization’s default access level for phone numbers.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The ID of the parent object, if any.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that has been given access to the VoiceUserLine.
VoiceVendorInfo Represents information about the Dialer provider’s vendor.
Supported Calls describeSObjects(), query(), retrieve()
Fields Field Name
Details
IsActive
Type boolean Properties Defaulted on create, Filter, Group, Sort
2077
Standard Objects
Field Name
VoiceVendorLine
Details Description Specifies whether the vendor is active or not.
VendorAccountKey
Type string Properties Filter, Group, idLookup, Sort Description The account key of the vendor.
VendorProviderName
Type string Properties Filter, Group, Sort Description The name of the vendor.
VendorType
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of vendor.
VoiceVendorLine Represents a user’s phone number reserved with the vendor.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
CallUsageInSecondsLastMonth
Type int Properties Filter, Group, Nillable, Sort
2078
Standard Objects
Field Name
VoiceVendorLine
Details Description An org’s total call usage last month in seconds.
OwnerId
Type reference Properties Filter, Group, Sort Description The ID of the user who owns the phone number.
PhoneNumber
Type phone Properties Filter, Group, idLookup, Sort, Update Description The unique vendor phone number.
ShouldRecord
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Reserved for future use.
Status
Type boolean Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies whether the number is currently active or released.
UserId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user using the phone number.
VoiceVendorInfoId
Type reference Properties Filter, Group, Sort
2079
Standard Objects
Field Name
VoiceVendorLineShare
Details Description The ID of the Dialer vendor.
VoiceVendorLineShare Represents a sharing entry on a vendor’s phone number.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the VoiceVendorLine. The possible values are: • Read • Edit • All This field must be set to an access level higher than the organization’s default access level for phone numbers.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the parent object, if any.
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort
2080
Standard Objects
Vote
Field Name
Details Description Reason that this sharing entry exists. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that has been given access to the VoiceVendorLine.
Vote Represents a vote that a user has made on an Idea or a Reply. Note: In API version 16.0 and earlier, SOQL queries on the Vote object only return votes for the Idea object. Starting in API version 17.0, SOQL queries return votes for both Idea and Reply.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field
Details
IsDeleted
Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
LastModifiedById
Type reference Properties Defaulted on create, Filter, Group, Sort Description ID of the user most recently associated with this vote.
2081
Standard Objects
Vote
Field
Details
LastModifiedDate
Type dateTime Properties Defaulted on create, Filter, Sort Description The datetime when this vote was last modified.
ParentId
Type reference Properties Group, Sort, Create, Filter Description ID of the Idea or Reply associated with this vote.
Type
Type picklist Properties Group, Sort, Create, Filter, Restricted picklist, Update Description Picklist that indicates the type of vote. The value Up indicates that the vote is a user's positive endorsement of the associated idea or reply. The value Down indicates that the vote is a user's negative endorsement of the associated idea or reply.
Note: If you are importing Vote data into Salesforce and need to set the value for an audit field, such as CreatedDate, contact Salesforce. Audit fields are automatically updated during API operations unless you request to set these fields yourself..
Usage In version 12.0 and later, use this object to track the votes that users made on ideas. For more information on ideas, see “Ideas Overview” in the Salesforce online help. In version 17.0 and later, use this object to track the votes users made on replies. For more information, see “Answers Overview” in the Salesforce online help. In version 17.0 and later, you must filter using the following syntax when querying this object in a SOQL query: ParentId = single ID, Parent.Type = single Type, Id = single ID, or Id IN (list of IDs). See Comparison Operators in the Salesforce SOQL and SOSL Reference Guide for a sample query. A SOQL query must filter using one of the following Parent or Id clauses. • ParentId = [single ID] • Parent.Type = [single type] • Id = [single ID]
2082
Standard Objects
WebLink
• Id IN = [list of IDs] SEE ALSO: Idea IdeaComment
WebLink Represents a custom link to a URL or Scontrol.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert()
Special Access Rules • To create a custom link, the client application must be logged in with the “Customize Application” permission. • Customer Portal users can’t access this object.
Fields Field Name
Details
Availability
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description
Description
Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the custom link. Limit is 1,000 characters.
DisplayType
Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Type of display: button, link, or mass-action button.
2083
Standard Objects
WebLink
Field Name
Details
EncodingKey
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Encoding of parameters on the URL link.
HasMenubar
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the popup window shows a menu bar (true) or not (false).
HasScrollbars
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the popup window shows scroll bars (true) or not (false).
HasToolbar
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the popup window shows browser toolbars (true) or not (false). Toolbars normally contain navigation buttons like Back, Forward, and Print.
Height
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Height of the popup in pixels.
IsProtected
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update
2084
Standard Objects
Field Name
WebLink
Details Description Indicates whether the object is protected (true) or not (false). Protected components that have been installed in other organizations can’t be linked to or referenced by components created in the subscriber organization. A developer can easily delete a protected component contained in a managed package in a future release of the package without worrying about failing installations. However, once a component is marked as unprotected and is released globally, the developer can’t delete it.
IsResizable
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether users are allowed to resize the popup window (true) or not (false).
LinkType
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Type of link (S-control or URL).
MasterLabel
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Master label for the link. Limit is 240 characters. This display value is the internal label that is not translated.
Name
Type string Properties Create, Filter, Group, Sort, Update Description Required. Name to display on page.
NamespacePrefix
Type string
2085
Standard Objects
Field Name
WebLink
Details Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value 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. This field can’t be accessed unless the logged-in user has the “Customize Application” permission.
OpenType
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. How the custom link opens when clicked in a browser—NewWindow, Sidebar, or NoSidebar.
PageOrSobjectType
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Required. For standard objects, the name of the page on which to display the custom link. For custom objects, the name of the object.
Position
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
2086
Standard Objects
Field Name
WebLink
Details Description Location on the screen where the popup should open—TopLeft, FullScreen, or None.
RequireRowSelection
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the custom link requires a row selection (true) or not (false).
ScontrolId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the custom s-control object (Scontrol) to link to. Can include fields as tokens within the custom s-control object. Label is Custom S-Control ID.
ShowsLocation
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the popup window shows the browser’s address bar containing the URL (true) or not (false).
ShowsStatus
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Show the status bar at the bottom of the browser.
Url
Type textarea Properties Create, Nillable, Update Description Required. URL of the page to link to. Can include fields as tokens within the URL. Limit: 1,024 KB.
2087
Standard Objects
WebLinkLocalization
Field Name
Details
Width
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Width of the popup in pixels.
Usage Use this object to programmatically manage custom links, which allow client applications to integrate data with external URLs, an organization’s intranet, or other back-end office systems. A custom link can point to: • An external URL, such as www.google.com or your company's intranet. • A custom s-control, such as a Java applet or Active-X control. Custom links can include fields as tokens within the URL or custom s-control. SEE ALSO: Scontrol
WebLinkLocalization Represents the translated value of the field label for a custom link to a URL or s-control when the Translation Workbench is enabled for your organization.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
Special Access Rules • Your organization must be using Professional, Enterprise, Developer, Unlimited, or Performance Edition and be enabled for the Translation Workbench. • To view this object, you must have the “View Setup and Configuration” permission.
Fields Field
Details
LanguageLocaleKey
Type picklist
2088
Standard Objects
Field
WebLinkLocalization
Details Properties Create, Filter, Nillable, Restricted picklist Description This field is available in API version 16.0 and earlier. It is the same as the Language field.
Language
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description This field is available in API version 17.0 and later. The combined language and locale ISO code, which controls the language for labels displayed in an application. This picklist contains the following fully-supported languages: • Chinese (Simplified): zh_CN • Chinese (Traditional): zh_TW • Danish: da • Dutch: nl_NL • English: en_US • Finnish: fi • French: fr • German: de • Italian: it • Japanese: ja • Korean: ko • Norwegian: no • Portuguese (Brazil): pt_BR • Russian: ru • Spanish: es • Spanish (Mexico): es_MX • Swedish: sv • Thai: th The following end-user only languages are available. • Arabic: ar • Bulgarian: bg • Croatian: hr • Czech: cs • English (UK): en_GB
2089
Standard Objects
Field
WebLinkLocalization
Details • Greek: el • Hebrew: iw • Hungarian: hu • Indonesian: in • Polish: pl • Portuguese (Portugal): pt_PT • Romanian: ro • Slovak: sk • Slovenian: sl • Turkish: tr • Ukrainian: uk • Vietnamese: vi The following platform languages are available for organizations that use Salesforce exclusively as a platform. • Albanian: sq • Arabic (Algeria): ar_DZ • Arabic (Bahrain): ar_BH • Arabic (Egypt): ar_EG • Arabic (Iraq): ar_IQ • Arabic (Jordan): ar_JO • Arabic (Kuwait): ar_KW • Arabic (Lebanon): ar_LB • Arabic (Libya): ar_LY • Arabic (Morocco): ar_MA • Arabic (Oman): ar_OM • Arabic (Qatar): ar_QA • Arabic (Saudi Arabia): ar_SA • Arabic (Sudan): ar_SD • Arabic (Syria): ar_SY • Arabic (Tunisia): ar_TN • Arabic (United Arab Emirates): ar_AE • Arabic (Yemen): ar_YE • Armenian: hy • Basque: eu • Bosnian: bs • Bengali: bn • Chinese (Simplified—Singapore): zh_SG • Chinese (Traditional—Hong Kong): zh_HK
2090
Standard Objects
Field
WebLinkLocalization
Details • Dutch (Belgium): nl_BE • English (Australia): en_AU • English (Canada): en_CA • English (Hong Kong): en_HK • English (India): en_IN • English (Ireland): en_IE • English (Malaysia): en_MY • English (Philippines): en_PH • English (Singapore): en_SG • English (South Africa): en_ZA • Estonian: et • French (Belgium): fr_BE • French (Canada): fr_CA • French (Luxembourg): fr_LU • French (Switzerland): fr_CH • Georgian: ka • German (Austria): de_AT • German (Belgium): de_BE • German (Luxembourg): de_LU • German (Switzerland): de_CH • Hindi: hi • Icelandic: is • Irish: ga • Italian (Switzerland): it_CH • Latvian: lv • Lithuanian: lt • Luxembourgish: lb • Macedonian: mk • Malay: ms • Maltese: mt • Romanian (Moldova): ro_MD • Montenegrin: sh_ME • Romansh: rm • Serbian (Cyrillic): sr • Serbian (Latin): sh • Spanish (Argentina): es_AR • Spanish (Bolivia): es_BO • Spanish (Chile): es_CL
2091
Standard Objects
Field
WebLinkLocalization
Details • Spanish (Colombia): es_CO • Spanish (Costa Rica): es_CR • Spanish (Dominican Republic): es_DO • Spanish (Ecuador): es_EC • Spanish (El Salvador): es_SV • Spanish (Guatemala): es_GT • Spanish (Honduras): es_HN • Spanish (Nicaragua): es_NI • Spanish (Panama): es_PA • Spanish (Paraguay): es_PY • Spanish (Peru): es_PE • Spanish (Puerto Rico): es_PR • Spanish (United States): es_US • Spanish (Uruguay): es_UY • Spanish (Venezuela): es_VE • Tagalog: tl • Tamil: ta • Urdu: ur • Welsh: cy The values in this field are not related to the default locale selection.
NamespacePrefix
Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 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 field’s value 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.
2092
Standard Objects
WorkAccess
Field
Details
Value
Type string Properties Create, Filter, Nillable, Sort, Update Description The actual translated label of the custom link. Label is Translation.
WebLinkId
Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the WebLink that is being translated.
Usage Use this object to translate your custom links to URLs or s-controls into the different languages supported by Salesforce. Users with the Translation Workbench enabled can view custom link translations, but either the “Customize Application” or “Manage Translation” permission is required to create or update custom link translations. SEE ALSO: CategoryNodeLocalization ScontrolLocalization
WorkAccess Used to grant or restrict user access to give badge definitions. Each badge definition record must have one WorkAccess record.
Supported Calls create(),delete(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),undelete(),update(),upsert()
Additional Considerations and Related Objects WorkAccess is not available through Schema Builder and is not customizable. A WorkAccess record is required for users to Give BadgeDefinitions. If a WorkAccess record is not created, BadgeDefinitions will not be available to users. The sharing of WorkAccess records is through WorkAccessShare on page 2094 For each WorkBadgeDefinition record, you must create both a WorkAccess record (per WorkBadgeDefinition) and WorkAccessShare records for sharing to users or groups.
2093
Standard Objects
WorkAccessShare
Fields Field Name
Details
AccessType
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Define the type of Access given to user (“Give”).
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Salesforce unique ID for owner of Access record.
ParentId
Type reference Properties Create, Filter, Group, Sort, Update Description Salesforce unique ID for BadgeDefinition record associated with this Access record.
WorkAccessShare Used to control Givers of WorkBadgeDefinition records.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Additional Considerations and Related Objects Related to WorkAccess Object. WorkAccess is the parent of WorkAccessShare.
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields.
2094
Standard Objects
WorkBadge
Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description CRUD Access Level (picklist values: Read Only, Read/Write, Owner).
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID for WorkAccess record.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Owner or Manual sharing. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description User or Group ID for WorkAccess.
WorkBadge Represents information about who the badge was given to and which badge was given. A WorkBadge record is created for each recipient of a WorkBadgeDefinition.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
2095
Standard Objects
WorkBadge
Additional Considerations and Related Objects WorkBadge is a lookup to WorkThanks. Each WorkBadge record must derive a SourceId from WorkThanks. There can be multiple WorkBadge records tied to a single WorkThanks record.
Fields Field Name
Details
DefinitionId
Type reference Properties Create, Filter, Group, Sort Description Required. Salesforce unique ID for the given WorkBadgeDefinition record given.
Description
Type textarea Properties Nillable Description The description of the WorkBadgeDefinition.
GiverId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the badge giver.
ImageUrl
Type url Properties Filter, Group, Nillable, Sort Description The URL of the badge image.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this WorkBadge.
2096
Standard Objects
WorkBadge
Field Name
Details
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this WorkBadge. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.
Message
Type textarea Properties Nillable Description The message accompanying the thanks badge.
NetworkId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the community that this WorkBadge is associated with. This field is available only if Salesforce Communities is enabled in your organization.
RecipientId
Type reference Properties Create, Filter, Group, Sort Description Required. Salesforce unique ID for User who is the Recipient of Badge.
RewardId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce unique ID for Reward given with badge (if Reward Badge)
SourceId
Type reference Properties Create, Filter, Group, Sort
2097
Standard Objects
Field Name
WorkBadgeDefinition
Details Description Salesforce unique ID for Thanks record referenced to this badge.
WorkBadgeDefinition Represents the attributes of a badge including the badge name, description, and image. Each WorkBadge record must have a lookup to a WorkBadgeDefinition since badge attributes (like badge name) are derived from the WorkBadgeDefinition object.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Additional Considerations and Related Objects WorkBadgeDefinition has a field called ImageUrl that references a DocumentID. This is a required field for creating a Badge. To grant “giver” access to a WorkBadgeDefinition, you must also create the WorkAccess (and the related WorkAccessShare) records. Each WorkBadgeDefinition has an ImageUrl field that must be populated with a DocumentID of the Document record containing the badge image.
Fields Field Name
Details
Description
Type textarea Properties Create, Update Description Required. Limit: 4000 characters. The description of the badge and what it means to receive this badge.
GivenBadgeCount
Type int Properties Filter, Group, Nillable, Sort Description The number of badges given per user or across all users. Note: This field can’t be added in a list view or referenced in a formula field.
2098
Standard Objects
WorkBadgeDefinition
Field Name
Details
ImageUrl
Type url Properties Create, Filter, Group, Sort, Update Description Required. This is the badge image that will be displayed in the UI. Use DocumentID or ImageURL.
IsActive
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Represents whether a WorkBadgeDefinition is active and available in the UI.
IsCompanyWide
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Represents a special class of badges known as Company Badges. Company badges are visible to the entire company and visible in specific list view filters. Note: If this field is selected, everyone within the user’s network will be able to give the badge automatically. If this field is not selected, people with sharing must be added to the badge’s access list in order to give the badge.
IsLimitPerUser
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the badge limit is per user (true) or across all users (false). The default value is false.
IsRewardBadge
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the badge is a reward badge (true) or not (false).
2099
Standard Objects
WorkBadgeDefinition
Field Name
Details
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this WorkBadgeDefinition.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this WorkBadgeDefinition. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.
LimitNumber
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The badge limit per user or across all users.
LimitStartDate
Type dateTime Properties Create, Filter, Group, Nillable, Sort, Update Description The start date of the badge limit. The date can be reset to the current date.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the Badge. Label: Badge Title.
NetworkId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update
2100
Standard Objects
Field Name
WorkBadgeDefinitionHistory
Details Description The ID of the community that this WorkBadgeDefinition is associated with. This field is available only if Salesforce Communities is enabled in your organization.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Salesforce User ID for User who is the Owner of the WorkBadgeDefinition record (usually the creator of the record)
RewardFundId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce unique ID for the WorkRewardFund that is associated with this WorkBadgeDefinition. WorkBadgeDefinition records with a RewardFundID indicate a Reward Badge.
WorkBadgeDefinitionHistory Represents the history of changes to the values in the fields of a WorkBadgeDefinition object.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Type of change (e.g., created).
2101
Standard Objects
WorkBadgeDefinitionShare
Field Name
Details
NewValue
Type Any Type Properties Nillable, Sort Description Updated value of record.
OldValue
Type Any Type Properties Nillable, Sort Description Previous value of record.
WorkBadgeDefinitionId
Type reference Properties Filter, Group, Sort Description ID of WorkBadgeDefinition record.
WorkBadgeDefinitionShare Represents a sharing entry on a WorkBadgeDefinition object.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update
2102
Standard Objects
Field Name
WorkBadgeDefinitionShare
Details Description The user’s or group’s level of access to the work badge definition. The possible values are: • Read • Edit • All: This value is not valid when you create, update, or delete records This field must be set to an access level that is higher than the organization’s default access level for work badge definitions.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the WorkBadgeDefinition object that is associated with this sharing entry.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. Read-only. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Valid values include: • Owner: User is the owner of the WorkBadgeDefinition or is in a user role above the WorkBadgeDefinition owner in the role hierarchy. • Manual: User or group has access, because a user with “All” access manually shared the WorkBadgeDefinition with the user or group. • Rule: User or group has access via a WorkBadgeDefinition sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that was given access to the work badge definition. This field can’t be updated.
2103
Standard Objects
WorkCoaching
WorkCoaching Represents a single coaching relationship between two users. One of the users is defined as the coach and the other is defined as a coachee. WorkCoaching is feed-enabled so there is a private feed available to the coach and coachee.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field Name
Details
CoachId
Type reference Properties Create, Filter, Group, Sort, Update Description [Required] The coach in this 1:1 coaching relationship.
CoachedId
Type reference Properties Create, Filter, Group, Sort, Update Description [Required] The user being coached in this 1:1 coaching relationship.
IsInactive
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the coaching relationship is Inactive (true) or not (false).
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this coaching relationship.
2104
Standard Objects
WorkCoachingFeed
Field Name
Details
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this coaching relationship. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.
Name
Type string Properties Create, Filter, Group, Sort, Update Description [Required] The record’s name. Max length is 255 characters.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the contact who owns the WorkCoaching record.
WorkCoachingFeed Represents a single feed item in the feed on the detail page for a coaching record. A coaching feed shows recent changes to a lead record for any fields that are tracked in feeds, and posts and comments about the record. It’s a useful way to stay up-to-date with changes made to coaching in Salesforce.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules You can delete all feed items that you created. To delete feed items that you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the WorkCoachingFeed object • “Moderate Chatter”
2105
Standard Objects
WorkCoachingFeed
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content of the FeedItem. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort
2106
Standard Objects
Field Name
WorkCoachingFeed
Details Description Available in API version 36.0 and earlier only. The file that is uploaded to the feed. Required if Type is ContentPost. The name of the file that is uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. Automatically determined during insert. The size of the file (in bytes) that is uploaded to the feed.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. Automatically determined during insert. The MIME type of the file that is uploaded to the feed.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if a client application migrates posts and comments from another application into a feed, InsertedById is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines.
2107
Standard Objects
Field Name
WorkCoachingFeed
Details • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes that are associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
NetworkScope
Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. If Salesforce Communities is enabled for your organization, this field is available in API version 28.0 and later. NetworkScope can have the following values.
2108
Standard Objects
Field Name
WorkCoachingFeed
Details • NetworkId: The ID of the community in which the FeedItem is available. If left empty, the feed item is available only in the default community. • AllNetworks: The feed item is available in all communities. Note the following exceptions for NetworkScope. • Only feed items with a CollaborationGroup or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the WorkCoaching record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost. For example, set this field to an existing ContentVersion and post it to a feed as a FeedItem object of type ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the FeedItem. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item. Except for ContentPost, LinkPost, and TextPost, don’t create feed item types directly from the API
2109
Standard Objects
Field Name
WorkCoachingFeed
Details • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • AttachArticleEvent—generated event when a user attaches an article to a case.
2110
Standard Objects
Field Name
WorkCoachingHistory
Details • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • CaseCommentPost—generated event when a user adds a case comment for a case object. • ChangeStatusPost—generated event when a user changes the status of a case. • ChatTranscriptPost—generated event when Live Agent transcript is saved to a case. • EmailMessageEvent—generated event when an email related to a case object is sent or received. • FacebookPost—generated when a Facebook post is created from a case. Deprecated. • MilestoneEvent—generated when a case milestone is completed or reaches violation status. • SocialPost—generated when a social post is created from a case. Note: If you set Type to ContentPost, also specify ContentData and ContentFileName.
Visibility
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The visibility of a FeedItem: • AllUsers: visible to all users • InternalUsers: visible to internal users
WorkCoachingHistory Represents the history of changes to the values in the fields of a WorkCoaching object.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
2111
Standard Objects
WorkCoachingShare
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed.
WorkCoachingId
Type reference Properties Filter, Group, Sort Description The ID of the WorkCoaching object.
WorkCoachingShare Represents a sharing entry on a WorkCoaching object.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
2112
Standard Objects
WorkCoachingShare
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The user’s or group’s level of access to the coaching relationship. The possible values are: • Read • Edit • All: This value is not valid when you create, update, or delete records. This field must be set to an access level that is higher than the organization’s default access level for coaching relationships.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the WorkCoaching object that is associated with this sharing entry.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. Read-only. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Valid values include: • Owner: User is the owner of the coaching relationship or is in a user role above the coaching relationship owner in the role hierarchy. • Manual: User or group has access, because a user with “All” access manually shared the coaching relationship with the user or group. • Rule: User or group has access via a sharing rule.
2113
Standard Objects
WorkFeedback
Field Name
Details
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that was given access to the coaching relationship. This field can’t be updated.
WorkFeedback Represents the answer to a question that a person was asked via a feedback request. Also used to store offered feedback without linking it to a particular question.
Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Additional Considerations and Related Objects • Ownership is transferred to the requester on submit for certain types (ad-hoc feedback). • The record is read-only after the request that it’s linked to is set to Submitted. • You can’t link a feedback object to a request unless you are the recipient. • The question that the feedback is linked to must be part of the same question set that the request is linked to.
Fields Field Name
Details
Feedback
Type textarea Properties Create, Nillable, Update Description Contains either the free-form text of the answer, or the choice selected by the user. Max length is 65536.
Name
Type string
2114
Standard Objects
Field Name
WorkFeedbackHistory
Details Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the WorkFeedback record.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the WorkFeedback record.
QuestionId
Type reference Properties Create, Filter, Group, Nillable, Sort Description The question this answer applies to. When this feedback is linked to a request of an unsolicited type, the question ID is null.
RequestId
Type reference Properties Create, Filter, Group, Sort Description The ID of the request this response belongs to, in case of offered feedback.
WorkFeedbackHistory Represents the history of changes to the values in the fields of a WorkFeedback object. Access is read-only.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
2115
Standard Objects
WorkFeedbackQuestion
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed.
WorkFeedbackId
Type reference Properties Filter, Group, Sort Description ID of the WorkFeedback object.
WorkFeedbackQuestion Represents a free-form text type or multiple choice question within a set of questions.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
2116
Standard Objects
WorkFeedbackQuestion
Fields Field Name
Details
Choices
Type textarea Properties Create, Nillable, Update Description New-line separated list of valid choices for multiple choice questions. Maximum length is 1000 characters.
Detail
Type textarea Properties Create, Nillable, Update Description Detailed instructions on how to answer the question.
IsConfidentialAnswer
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Answers to questions marked confidential will not be shared with the subject of the review. This field applies only to performance summaries.
IsOptional
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If this option is selected, the question is optional and isn’t required to be answered. This field applies only to performance summaries.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description A short description of the question, which can be used as a header for reports and Calibration.
2117
Standard Objects
WorkFeedbackQuestion
Field Name
Details
Number
Type int Properties Create, Filter, Group, Sort, Update Description The order of the question that is displayed within the question set, such as question number three in a question set that has five questions.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the WorkFeedbackQuestion.
QuestionSetId
Type reference Properties Create, Filter, Group, Sort, Update Description The question set this question is a part of.
Text
Type textarea Properties Create, Update Description The body of the question. Max length is 16384 characters.
Type
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Allows for either a free-form text answer or a multiple choice question defined by new-line separate choices in the ‘Choices’ field. Valid picklist values are: • MultipleChoice • FreeText • Rating
2118
Standard Objects
WorkFeedbackQuestionHistory
WorkFeedbackQuestionHistory Represents the history of changes to the values in the fields of a WorkFeedbackQuestion.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed.
WorkFeedbackQuestionId
Type reference Properties Filter, Group, Sort Description ID of the WorkFeedbackQuestion.
2119
Standard Objects
WorkFeedbackQuestionSet
WorkFeedbackQuestionSet Represents a set of questions being asked. The question set is used to link all the individual requests where different recipients were asked the same set of questions on the same subject. In the Work.com performance application, a question set defines the type of summaries and their due dates that will accompany the deployment of a specific performance summary cycle.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field Name
Details
DueDate
Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date that this specific question set is expected to be submitted by the recipient. This field applies only to performance summaries.
FeedbackType
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The description of the collection of questions that are written in context to the type of recipient answering them, relative to the subject of the summary. This field applies only to performance summaries.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the question set. Maximum length is 225 characters.
OwnerId
Type reference
2120
Standard Objects
Field Name
WorkFeedbackQuestionSetHistory
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the WorkFeedbackQuestionSet.
PerformanceCycleId
Type reference Properties Create, Filter, Group, Nillable, Sort Description If a question set is associated to a performance summary cycle, then that cycle ID is referenced in this field. This field applies only to performance summaries.
WorkFeedbackQuestionSetHistory Represents the history of changes to the values in the fields of a WorkFeedbackQuestionSet object. Access is read-only.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
2121
Standard Objects
WorkFeedbackQuestionSetShare
Field Name
Details
OldValue
Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed.
WorkFeedbackQuestionSetId
Type reference Properties Filter, Group, Sort Description ID of the WorkFeedbackQuestionSet object.
WorkFeedbackQuestionSetShare Represents a sharing entry on a WorkFeedbackQuestionSet.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The user’s or group’s level of access to the feedback question set. The possible values are: • Read • Edit • All: This value is not valid when you create, update, or delete records.
2122
Standard Objects
Field Name
WorkFeedbackQuestionShare
Details This field must be set to an access level that is higher than the organization’s default access level for feedback question sets.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the WorkFeedbackQuestionSet object that is associated with this sharing entry.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. Read-only. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Valid values include: • Owner: User is the owner of the WorkFeedbackQuestionSet or is in a user role above the WorkFeedbackQuestionSet owner in the role hierarchy. • Manual: User or group has access, because a user with “All” access manually shared the WorkFeedbackQuestionSet with the user or group. • Rule: User or group has access via a WorkFeedbackQuestionSet sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that was given access to the feedback question set. This field can’t be updated.
WorkFeedbackQuestionShare Represents a sharing entry on a WorkFeedbackQuestion.
2123
Standard Objects
WorkFeedbackQuestionShare
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The user’s or group’s level of access to the feedback question. The possible values are: • Read • Edit • All: This value is not valid when you create, update, or delete records. This field must be set to an access level that is higher than the organization’s default access level for feedback questions.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the WorkFeedbackQuestion object that is associated with this sharing entry.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. Read-only. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Valid values include: • Owner: User is the owner of the WorkFeedbackQuestion or is in a user role above the WorkFeedbackQuestion owner in the role hierarchy. • Manual: User or group has access, because a user with “All” access manually shared the WorkFeedbackQuestion with the user or group.
2124
Standard Objects
Field Name
WorkFeedbackRequest
Details • Rule: User or group has access via a WorkFeedbackQuestion sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that was given access to the feedback question. This field can’t be updated.
WorkFeedbackRequest Represents a single feedback request on a subject or topic (question) to a single recipient in the feedback application. In the case of offered feedback, WorkFeedbackRequest represents feedback that is offered about a subject. In the performance application, WorkFeedbackRequest represents a request for feedback on a set of questions from a question set, on a subject—for the recipient to complete and submit.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Additional Considerations and Related Objects • After a request’s state is changed to Submitted, fields can’t be changed, except for LastSharedDate and IsUnreadByOwner. • If LastRemindDate is updated, a reminder notification will be sent to the request’s recipient (only possible when request is in Draft state). • When a new request is created, a notification is sent to the recipient. • When a recipient of a request submits their feedback (Draft->Submitted), a notification will be sent to requester (except for offered feedback). • Requester cannot modify the subject of the question set after a request is created. • For offered feedback (to user, to manager, or both), the person who is offering feedback is both the creator of WorkFeedbackRequest as well as the recipient.
Fields Field Name
Details
AdHocFeedback
Type textarea
2125
Standard Objects
Field Name
WorkFeedbackRequest
Details Properties Create, Filter, Nillable, Sort Description The content of the feedback.
AdHocQuestion
Type textarea Properties Create, Filter, Nillable, Sort Description The content of the feedback question.
Description
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the WorkFeedbackRequest.
FeedbackRequestState
Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The current state of the feedback request. Allowed picklist values are: • Draft • Submitted • Declined
FeedbackType
Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Specifies the type of request. Picklist values that are used for performance summaries: • Unspecified • Peer Summary • Self Summary • Manager Summary • Skip Level Summary
2126
Standard Objects
Field Name
WorkFeedbackRequest
Details Picklist values that are used for feedback: • Personal • Unsolicited to User • Unsolicited to Manager • Unsolicited to User and Manager • On Topic The type of the feedback determines the sharing and visibility rules that are applied to answers.
IsDeployed
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, the feedback is part of a deployed performance summary cycle.
IsShareWithSubject
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, the feedback is shared with the summary subject.
IsUnreadByOwner
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, the submitted request has not been seen by the requester.
IsUnsolicited
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If true, the feedback request is unsolicited feedback offered to another user.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort
2127
Standard Objects
Field Name
WorkFeedbackRequest
Details Description The time stamp that indicates when the current user last viewed a record that is related to this WorkFeedbackRequest.
LastRemindDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The last time a reminder was sent to the recipient of this draft request.
LastSharedDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The last time this request was shared with another user or group.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this WorkFeedbackRequest. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the WorkFeedbackRequest.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the WorkFeedbackRequest.
2128
Standard Objects
WorkFeedbackRequest
Field Name
Details
PerformanceCycleId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Used by performance summaries to link to a summary cycle. This field applies only to performance summaries.
QuestionSetId
Type reference Properties Create, Filter, Group, Nillable, Sort Description Question set associated with the current request.
RecipientId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description User asked to provide feedback on the subject.
RelatedObjectId
Type reference Properties Create, Filter, Group, Nillable, Sort Description Specifies a record in the system that this feedback request is related to. Used by ad-hoc feedback to gather feedback in the context of an opportunity or Work.com goal. Used by performance summaries to link to a summary cycle.
SharingScope
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The users that see the feedback. SharingScope can have the following values: • Nobody • Subject
2129
Standard Objects
Field Name
WorkFeedbackRequestFeed
Details • Manager • SubjectAndManager
SubjectId
Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the user that this request (or offer) is about.
SubmitFeedbackToId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the person this performance summary feedback request (and its respective answers) is shared with. It’s also the ID of the person who owns the requested subject’s manager summary request. This field applies only to performance summaries.
SubmittedDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The last time (in case it was reopened by admin) this request was submitted by the recipient. This field applies only to performance summaries.
WorkFeedbackRequestFeed Represents a single feed item in the feed displayed on the feedback request detail page. The feedback request feed shows changes to a request for fields that are tracked in feeds, posts, and comments about the request.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
2130
Standard Objects
WorkFeedbackRequestFeed
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content of the FeedItem. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item.
ContentData
Type base64 Properties Nillable Description Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort Description The file uploaded to the feed. Required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
2131
Standard Objects
WorkFeedbackRequestFeed
Field Name
Details
ContentSize
Type int Properties Group, Nillable, Sort Description Read only. Automatically determined during insert. The size of the file (in bytes) uploaded to the feed.
ContentType
Type string Properties Group, Nillable, Sort Description Read only. Automatically determined during insert. The MIME type of the file uploaded to the feed.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if a client application migrates posts and comments from another application into a feed, then InsertedById is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • • •
2132
Standard Objects
Field Name
WorkFeedbackRequestFeed
Details • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the goal record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost.
2133
Standard Objects
Field Name
WorkFeedbackRequestFeed
Details For example, set this field to an existing ContentVersion and post it to a feed as a FeedItem object of TypeContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the FeedItem. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item. Except for ContentPost, LinkPost, and TextPost, don’t create feed item types directly from the API • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed.
2134
Standard Objects
Field Name
WorkFeedbackRequestHistory
Details • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • AttachArticleEvent—generated event when a user attaches an article to a case. • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • CaseCommentPost—generated event when a user adds a case comment for a case object. • ChangeStatusPost—generated event when a user changes the status of a case. • ChatTranscriptPost—generated event when Live Agent transcript is saved to a case. • EmailMessageEvent—generated event when an email related to a case object is sent or received. • FacebookPost—generated when a Facebook post is created from a case. Deprecated. • MilestoneEvent—generated when a case milestone is completed or reaches violation status. • SocialPost—generated when a social post is created from a case.
WorkFeedbackRequestHistory Represents the history of changes to the values in the fields of a WorkFeedbackRequest.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
2135
Standard Objects
WorkFeedbackRequestShare
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed.
WorkFeedbackRequestId
Type picklist Properties Filter, Group, Sort Description ID of the WorkFeedbackRequest.
WorkFeedbackRequestShare Represents a sharing entry on a WorkFeedbackRequest.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
2136
Standard Objects
WorkFeedbackRequestShare
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The user’s or group’s level of access to the feedback request. The possible values are: • Read • Edit • All: This value is not valid when you create, update, or delete records. This field must be set to an access level that is higher than the organization’s default access level for feedback requests.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the WorkFeedbackRequest object that is associated with this sharing entry.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. Read-only. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Valid values include: • Owner: User is the owner of the WorkFeedbackRequest or is in a user role above the WorkFeedbackRequest owner in the role hierarchy. • Manual: User or group has access, because a user with “All” access manually shared the WorkFeedbackRequest with the user or group. • Rule: User or group has access via a WorkFeedbackRequest sharing rule.
2137
Standard Objects
WorkFeedbackShare
Field Name
Details
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that was given access to the feedback request. This field can’t be updated.
WorkFeedbackShare Represents a sharing entry on a WorkFeedback object.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The user’s or group’s level of access to the feedback. The possible values are: • Read • Edit • All: This value is not valid when you create, update, or delete records. This field must be set to an access level that is higher than the organization’s default access level for feedback.
ParentId
Type reference Properties Create, Filter, Group, Sort
2138
Standard Objects
Field Name
WorkGoal
Details Description ID of the WorkFeedback object that is associated with this sharing entry.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. Read-only. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Valid values include: • Owner: User is the owner of the WorkFeedback or is in a user role above the WorkFeedback owner in the role hierarchy. • Manual: User or group has access, because a user with “All” access manually shared the WorkFeedback with the user or group. • Rule: User or group has access via a WorkFeedback sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that was given access to the feedback. This field can’t be updated.
WorkGoal Represents the components of a goal, such as its description and associated metrics. This object has been deprecated as of API version 35.0. Use the Goal object to query information about Work.com goals.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Related WorkGoalCollaborator, WorkGoalLink, WorkGoalFeed
2139
Standard Objects
WorkGoal
Fields Field Name
Details
ActualValue
Type double Properties Create, Filter, Nillable, Sort, Update Description The actual value of the WorkGoal metric. Applicable only to WorkGoal objects of Type: Metric.
ActualValueExternalUrl
Type url Properties Create, Filter, Group, Nillable, Sort, Update Description Contains a URL that references work.com data synchronization for the actual value of a metric. Applicable only to WorkGoal objects of Type: Metric.
CompletionDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The completion date of the goal. Note: Field-level security limits access to only administrators and owners by default, and only they can complete a goal.
Description
Type textarea (max length 4000) Properties Create, Nillable, Update Description The description of the goal.
DueDate
Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the WorkGoal object is due (optional). Applicable only to WorkGoal objects of Type: Metric.
2140
Standard Objects
WorkGoal
Field Name
Details
FlaggedAs
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The progress of the WorkGoal object. Applicable only to WorkGoal objects of Type: Metric. Possible values: • On Track: Progress on the metric is on track. • Behind: Progress on the metric is behind schedule. • Postponed: The metric is postponed. • Critical: Progress on the metric is critical.
ImageUrl
Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The URL for the goal image. The image must be stored in Documents and set as externally available. Applicable only to WorkGoal objects of Type: Goal.
InitialValue
Type double Properties Create, Filter, Nillable, Sort, Update Description The initial value of the WorkGoal metric. Applicable only to WorkGoal objects of Type: Metric and MetricType: Progress or Percent.
IsKeyCompanyGoal
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Used to indicate if the goal is a key company goal. Used for the Company Goal Showcase. Applicable only to WorkGoal objects of Type: Goal.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort
2141
Standard Objects
Field Name
WorkGoal
Details Description The time stamp that indicates when the current user last viewed a record that is related to this goal.
LastSyncDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time stamp that indicates when the actual value was last synced with the associated metrics report.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this goal.
MetricType
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of metric that is represented. (See values in the following list). Applies only to WorkGoal objects of Type: Metric. Possible values: • Progress: ActualValue / TargetValue as a percentage • Percent: the metric as a percentage only • YesNo: the completed / not completed metric as a milestone • Absolute: Deprecated
MetricTypeDataSource
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies how the metric (ActualValue and CurrentValue) is updated. Applies only to WorkGoal objects of Type: Goal and Metric. Possible values:
2142
Standard Objects
Field Name
WorkGoal
Details • Manual: indicates that the actual and target value of the metric is updated manually by the user • Rollup: indicates that the actual and target value of a goal is rolled up automatically by Work.com Goals • DataSyncActualOnly: indicates that the actual value of the metric is linked to a Salesforce report
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the WorkGoal object. (Maximum length is 255.)
OverallStatus
Type string Properties Filter, Group, Nillable, Sort Description The overall calculated status of the WorkGoal based on FlaggedAs and CompletionDate.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who owns the WorkGoal.
ParentId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the structural parent of the WorkGoal. For example, a goal that has a metric is represented by a WorkGoal of Type Metric, which has a parent of WorkGoal of Type Goal. Note: The root and the parent must be set to the parent goal for any child metrics.
Progress
Type percent
2143
Standard Objects
Field Name
WorkGoal
Details Properties Filter, Nillable, Sort Description Read Only. The overall progress of the WorkGoal.
RootId
Type reference to a WorkGoal object Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the structural root of the WorkGoal. For example, a goal that has a metric is represented by a WorkGoal of Type Metric, which has a root of WorkGoal of Type Goal.
State
Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The state of the WorkGoal object. Applies only to WorkGoal objects of Type: Metric. Possible values: • Draft: the draft state for the WorkGoal • Published: published state for the WorkGoal • Archived: archived state for the WorkGoal (for example, goals that no longer apply)
TargetValue
Type double Properties Create, Filter, Nillable, Sort, Update Description The target value of the WorkGoal. Applies only to WorkGoal objects of Type: Metric.
Type
Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
2144
Standard Objects
Field Name
WorkGoalCollaborator
Details Description The type of the WorkGoal object, used to differentiate between the components of a goal. (This field is used to represent components of a goal such as its description and associated metrics.) Possible values: • Goal: a goal • Metric: a metric (typically associated with goals) • Objective: an objective • KeyResult: a key result (typically associated with objectives • V2Mom: a V2MOM (pilot feature) • Vision: a vision (pilot feature — typically associated with V2MOM) • Value: a value (pilot feature - typically associated with V2MOM) • Method: a method (pilot feature - typically associated with V2MOM) • Obstacle: an obstacle (pilot feature - typically associated with V2MOM) • Measure: a measure (pilot feature - typically associated with a method) Note: Administrators can rename goals and metrics to objectives and key results, respectively. If this preference is enabled, use the Type Objective or KeyResult. Otherwise, use the default Type Goal or KeyResult.
Weight
Type double Properties Create, Filter, Nillable, Sort, Update Description The weight of the goal or metric. The sum of the weights should equal 100%.
WorkGoalCollaborator Represents collaborators on a WorkGoal object. This doesn’t include WorkGoal followers, which is handled by Chatter Feed Follow functionality. This object has been deprecated as of API version 35.0. Use the Goal object to query information about Work.com goals.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
2145
Standard Objects
WorkGoalCollaboratorHistory
Fields Field Name
Details
InvitationDate
Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date that a user was invited to become a collaborator (nill if the user was not invited).
State
Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the state of the collaborating user. Whether the user has not responded, joined, or declined collaboration. The possible values are: • PendingResponse: a user who was invited to collaborate but hasn’t joined or declined • Joined: a user who is collaborating on a goal (joined/commit) • Declined: a user who declined to collaborate on a goal
UserId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The collaborating user.
WorkGoalId
Type reference Properties Create, Filter, Group, Sort Description The WorkGoal object that this collaborator is a part of.
WorkGoalCollaboratorHistory Represents the history of changes to the values in the fields in a WorkGoalCollaborator object. Access is read-only.
2146
Standard Objects
WorkGoalCollaboratorHistory
Note: This object has been deprecated as of API version 35.0. Use the Goal object to query information about Work.com goals in API version 35.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Name of the standard or custom field.
NewValue
Type anyType Properties Nillable, Sort Description New value of the modified field.
OldValue
Type anyType Properties Nillable, Sort Description Previous value of the modified field.
WorkGoalCollaboratorId
Type reference Properties Filter, Group, Sort Description ID of the WorkGoalCollaborator object that is associated with this history entry.
2147
Standard Objects
WorkGoalFeed
WorkGoalFeed Represents a single feed item in the feed displayed on the goal page for a Goal record. The goal feed shows changes to a goal for fields that are tracked in feeds, posts, and comments about the goal, and updates on metrics. This object has been deprecated as of API version 35.0. Use the GoalFeed object to query information about feed items for Work.com goals.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The content of the FeedItem. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort
2148
Standard Objects
Field Name
WorkGoalFeed
Details Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The file uploaded to the feed. Required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. Automatically determined during insert. The size of the file (in bytes) uploaded to the feed.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. Automatically determined during insert. The MIME type of the file uploaded to the feed.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if a client application migrates multiple posts and comments from another application into a feed, then InsertedById is set to the ID of the logged-in user.
2149
Standard Objects
WorkGoalFeed
Field Name
Details
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • • • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort
2150
Standard Objects
Field Name
WorkGoalFeed
Details Description The URL of a LinkPost.
NetworkScope
Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. If Salesforce Communities is enabled for your organization, this field is available in API version 28.0 and later. NetworkScope can have the following values:
• NetworkId—The ID of the community in which the FeedItem is available. If left empty, the feed item is only available in the default community. • AllNetworks—The feed item is available in all communities. Note the following exceptions for NetworkScope: • Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks. • You can’t filter a FeedItem on the NetworkScope field. ParentId
Type reference Properties Filter, Group, Sort Description ID of the goal record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost. For example, set this field to an existing ContentVersion and post it to a feed as a FeedItem object of TypeContentPost.
2151
Standard Objects
WorkGoalFeed
Field Name
Details
Title
Type string Properties Group, Nillable, Sort Description The title of the FeedItem. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item. Except for ContentPost, LinkPost, and TextPost, don’t create feed item types directly from the API • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed.
2152
Standard Objects
Field Name
WorkGoalFeed
Details • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • AttachArticleEvent—generated event when a user attaches an article to a case. • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • CaseCommentPost—generated event when a user adds a case comment for a case object. • ChangeStatusPost—generated event when a user changes the status of a case. • ChatTranscriptPost—generated event when Live Agent transcript is saved to a case. • EmailMessageEvent—generated event when an email related to a case object is sent or received. • FacebookPost—generated when a Facebook post is created from a case. Deprecated. • MilestoneEvent—generated when a case milestone is completed or reaches violation status. • SocialPost—generated when a social post is created from a case.
Visibility
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The visibility of a FeedItem: • AllUsers: visible to all users • InternalUsers: visible to internal users
2153
Standard Objects
WorkGoalHistory
WorkGoalHistory Represents the history of changes to the values in the fields of a WorkGoal. Access is read-only. This object has been deprecated as of API version 35.0. Use the GoalHistory object to query historical information for Work.com goals.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type Any Type Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type Any Type Properties Nillable, Sort Description The latest value of the field before it was changed.
WorkGoalId
Type reference Properties Filter, Group, Sort Description ID of the Goal. Label is Goal ID.
2154
Standard Objects
WorkGoalLink
WorkGoalLink Represents the relationship between two goals (many to many relationship). This object has been deprecated as of API version 35.0. Use the GoalLink object to query information about the relationship between two Work.com goals.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update() , upsert()
Fields Field Name
Details
IsActive
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the WorkGoalLink is active (true) or not (false)
LinkType
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of link
Name
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The auto-generated name of the goal link
SourceGoalId
Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the source WorkGoal object
2155
Standard Objects
WorkGoalShare
Field Name
Details
TargetGoalId
Type reference Properties Create, Filter, Group, Sort, Update Description The ID of the target WorkGoal object
WorkGoalShare Represents a sharing entry on a WorkGoal object. This object has been deprecated as of API version 35.0. Use the GoalShare object to query information about sharing for Work.com goals.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The user’s or group’s level of access to the goal. The possible values are: • Read • Edit • All: This value is not valid when you create, update, or delete records This field must be set to an access level that is higher than the organization’s default access level for goals.
ParentId
Type reference Properties Create, Filter, Group, Sort
2156
Standard Objects
Field Name
WorkOrder
Details Description ID of the WorkGoal object that is associated with this sharing entry.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. Read-only. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Valid values include: • Owner: User is the owner of the WorkGoal or is in a user role above the WorkGoal owner in the role hierarchy. • Manual: User or group has access, because a user with “All” access manually shared the WorkGoal with the user or group. • Rule: User or group has access via a WorkGoal sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that was given access to the goal. This field can’t be updated.
WorkOrder Represents a task or series of tasks to be performed, typically in field service. This object is available in API version 36.0 and later.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
2157
Standard Objects
WorkOrder
Fields Field Name
Details
AccountId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account associated with the work order.
Address
Type address Properties Filter, Nillable Description The compound form of the address where the work order is completed.
AssetId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset associated with the work order.
BusinessHoursId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The business hours associated with the work order.
CaseId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The case associated with the work order.
City
Type string Properties Create, Filter, Group, Nillable, Sort, Update
2158
Standard Objects
Field Name
WorkOrder
Details Description The city where the work order is completed. Maximum length is 40 characters.
ContactId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The contact associated with the work order.
Country
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country where the work order is completed. Maximum length is 80 characters.
CurrencyIsoCode
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. The label in the user interface is Currency ISO Code.
Description
Type textarea Properties Create, Nillable, Update Description The description of the work order. Try to include the steps needed to change the work order’s status to Completed.
Discount
Type percent Properties Filter, Nillable, Sort Description Read only. The weighted average of the discounts on all line items in the work order. It can be any positive number up to 100.
2159
Standard Objects
WorkOrder
Field Name
Details
Duration
Type double Properties Create, Filter, Nillable, Sort, Update Description The estimated time required to complete the work order. Specify the duration unit in the Duration Type field.
DurationType
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit of the duration: Minutes or Hours.
EndDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the work order is completed. This field is blank unless you set up an Apex trigger or quick action to populate it. For example, you can create a quick action that sets the EndDate to 365 days after the StartDate.
EntitlementId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The entitlement associated with the work order.
GeocodeAccuracy
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address. See Compound Field Considerations and Limitations for details on geolocation compound fields. Note: This field is available in the API only.
2160
Standard Objects
WorkOrder
Field Name
Details
GrandTotal
Type currency Properties Filter, Nillable, Sort Description Read only. The total price of the work order with tax added.
IsClosed
Type boolean Properties Group, Defaulted on create, Filter, Sort Description Indicates whether the work order is closed (true) or open (false). Tip: Use this field to report on closed versus open work orders.
IsStopped
Type boolean Properties Group, Defaulted on create, Create, Filter, Sort, Update Description Indicates whether a milestone is paused (true) or counting down (false). This field is available only if Enable stopped time and actual elapsed time is selected on the Entitlement Settings page.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the work order was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the work order was last viewed.
Latitude
Type double
2161
Standard Objects
Field Name
WorkOrder
Details Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the work order is completed. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. Note: This field is available in the API only.
LineItemCount
Type int Properties Filter, Group, Nillable, Sort Description The number of work order line items in the work order. Its label in the user interface is Line Items.
Longitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the work order is completed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. Note: This field is available in the API only.
MaintenancePlanId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The maintenance plan associated with the work order. When the work order is auto-generated from a maintenance plan, this field automatically lists the related plan.
MilestoneStatus
Type string Properties Group, Nillable, Sort
2162
Standard Objects
Field Name
WorkOrder
Details Description Indicates the status of a milestone. This field is visible if an entitlement process is applied to a work order.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The work order’s assigned owner.
ParentWorkOrderId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order’s parent work order, if it has one. Tip: Create a custom report to view a work order’s child work orders.
PostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code where the work order is completed. Maximum length is 20 characters.
Pricebook2Id
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The price book associated with the work order. Adding a price book to the work order lets you assign different price book entries to the work order’s line items. This is only available if Product2 is enabled.
Priority
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
2163
Standard Objects
Field Name
WorkOrder
Details Description The priority of the work order. The picklist includes the following values, which can be customized: • Low • Medium • High • Critical
RootWorkOrderId
Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The top-level work order in a work order hierarchy. Depending on where a work order lies in the hierarchy, its root could be the same as its parent. Note: View a work order’s child work order in the Child Work Orders related list.
ServiceAppointmentCount
Type int Properties Filter, Group, Nillable, Sort Description The number of service appointments on the work order.
ServiceContractId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service contract associated with the work order.
ServiceTerritoryId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service territory where the work order is taking place.
SlaExitDate
Type dateTime
2164
Standard Objects
Field Name
WorkOrder
Details Properties Filter, Nillable, Sort Description The time that the work order exits the entitlement process.
SlaStartDate
Type dateTime Properties Create, Filter, Nillable, Update, Sort Description The time that the work order enters the entitlement process. You can update or reset the time if you have “Edit” permission on work orders.
StartDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the work order goes into effect. This field is blank unless you set up an Apex trigger or quick action to populate it. For example, you can create a quick action that sets the StartDate to the date when the Status changes to In Progress.
State
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state where the work order is completed. Maximum length is 80 characters.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the work order. The picklist includes the following values, which can be customized: • New—Work order was created, but there hasn’t yet been any activity. • In Progress—Work has begun. • On Hold—Work is paused. • Completed—Work is complete.
2165
Standard Objects
Field Name
WorkOrder
Details • Cannot Complete—Work could not be completed. • Closed—All work and associated activity is complete. • Canceled—Work is canceled, typically before any work began. Changing a work order’s status does not affect the status of its work order line items or associated service appointments.
StatusCategory
Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The category that each Status value falls into. The Status Category field has eight default values: seven values which are identical to the default Status values, and a None value for statuses without a status category. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Waiting for Response value, you may decide that it belongs in the On Hold category. The Status Category field can be useful to reference in custom apps, triggers, and validation rules. Status categories let you extend and customize the work life cycle while still maintaining a consistent work classification for tracking, reporting, and business process management.
StopStartDate
Type dateTime Properties Filter, Nillable, Sort Description Indicates when the milestone was paused. The label in the user interface is Stopped Since.
Street
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name where the work order is completed.
Subject
Type string Properties Create, Filter, Group, Nillable, Sort, Update
2166
Standard Objects
Field Name
WorkOrder
Details Description The subject of the work order. Try to describe the nature and purpose of the job to be completed. For example, “Annual On-Site Well Maintenance.” Maximum length is 255 characters.
Subtotal
Type currency Properties Filter, Nillable, Sort Description Read only. The total of the work order line items’ subtotals before discounts and taxes are applied.
SuggestedMaintenanceDate
Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The suggested date that the work order is completed. When the work order is auto-generated from a maintenance plan, this field is automatically populated based on the maintenance plan’s settings.
Tax
Type currency Properties Create, Filter, Nillable, Sort, Update Description The total tax on the work order. You can enter a number with or without the currency symbol and use up to two decimal places. For example, in a work order whose total price is $100, enter $10 to apply a 10% tax.
TotalPrice
Type currency Properties Filter, Nillable, Sort Description Read only. The total of the work order line items’ prices. This value has discounts applied but not tax.
WorkOrderNumber
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort
2167
Standard Objects
Field Name
WorkOrderFeed
Details Description An eight-digit, auto-generated number that identifies the work order.
WorkTypeId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work type associated with the work order. When a work type is selected, the work order automatically inherits the work type’s Duration, Duration Type, and required skills.
Usage A work order can be a child record of accounts, assets, cases, contacts, entitlements, service contracts, and other work orders. We recommend adding work order line items to the work order to break the main task into smaller subtasks.
WorkOrderFeed Represents a single feed item on a work order record detail page. This object is available in API version 36.0 and later. A work order feed shows changes to tracked fields on a work order record. It also shows posts and comments about the record. It’s a useful way to stay up to date with changes made to work orders in Salesforce.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Work orders or Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Work Order object • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.
2168
Standard Objects
WorkOrderFeed
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item.
ConnectionId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization. When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort
2169
Standard Objects
Field Name
WorkOrderFeed
Details Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. The name of the file to upload to the feed. Required if Type is ContentPost. Setting this field sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. The size of the file uploaded to the feed in bytes. Determined during insert.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. The MIME type of the file uploaded to the feed. Determined during insert.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort
2170
Standard Objects
Field Name
WorkOrderFeed
Details Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a link post.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the work order record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When the Type is LinkPost, the Link URL is the URL, and this field is the link name.
2171
Standard Objects
WorkOrderHistory
Field Name
Details
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
WorkOrderHistory Represents the history of changes made to tracked fields on a work order. This object is available in API version 36.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Work orders or Field Service Lightning must be enabled in your organization, and field tracking for work order fields must be configured.
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType
2172
Standard Objects
Field Name
WorkOrderLineItem
Details Properties Nillable, Sort Description The value of the field before it was changed.
WorkOrderId
Type reference Properties Filter, Group, Sort Description ID of the work order being tracked. The history is displayed on the detail page for this record.
WorkOrderLineItem Represents a subtask on a work order, typically in field service. This object is available in API version 36.0 and later.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field Name
Details
Address
Type address Properties Filter, Nillable Description The compound form of the address where the line item is completed.
AssetId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The asset associated with the work order line item. The asset is not automatically inherited from the parent work order.
2173
Standard Objects
WorkOrderLineItem
Field Name
Details
City
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city where the line item is completed. Maximum length is 40 characters.
Country
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country where the line item is completed. Maximum length is 80 characters.
CurrencyIsoCode
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. The label in the user interface is Currency ISO Code.
Description
Type textarea Properties Create, Nillable, Update Description The description of the work order line item. Try to describe the steps needed to mark the line item Completed.
Discount
Type percent Properties Create, Filter, Nillable, Sort, Update Description The percent discount to apply to the line item. You can enter a number with or without the percent symbol, and you can use up to two decimal places.
Duration
Type double
2174
Standard Objects
Field Name
WorkOrderLineItem
Details Properties Create, Filter, Nillable, Sort, Update Description The estimated time required to complete the line item. Specify the duration unit in the Duration Type field.
DurationType
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit of the duration: Minutes or Hours.
EndDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the line item is completed. This field is blank unless you set up an Apex trigger or quick action to populate it. For example, you can create a quick action that sets the EndDate to 365 days after the StartDate.
GeocodeAccuracy
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of a location’s geographical coordinates compared with its physical address. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. Note: This field is available in the API only.
IsClosed
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the line item has been closed. Changing the line item’s status to Closed causes this checkbox to be selected in the user interface (sets IsClosed to true). Tip: Use this field to report on closed versus open work order line items.
2175
Standard Objects
WorkOrderLineItem
Field Name
Details
Latitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the line item is completed. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. Note: This field is available in the API only.
LineItemNumber
Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description An auto-generated number that identifies the work order line item. Each work order’s line items start at 1.
ListPrice
Type currency Properties Filter, Nillable, Sort Description The price of the line item (product) as listed in its corresponding price book entry. If a price book entry isn’t specified, the list price defaults to zero.
Longitude
Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the line item is completed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. Note: This field is available in the API only.
OrderId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update
2176
Standard Objects
Field Name
WorkOrderLineItem
Details Description The order associated with the line item. For example, you may need to order replacement parts before you can complete the line item.
ParentWorkOrderLineItemId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The line item’s parent work order line item, if it has one. Tip: Create a custom report to view a line item’s child line items.
PostalCode
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code where the line item is completed. Maximum length is 20 characters.
PricebookEntryId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The price book entry (product) associated with the line item. The label in the user interface is Product. This field’s lookup search only returns products that are included in the work order’s price book.
Product2Id
Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The product associated with the price book entry. This field is not available in the user interface. For best results, use the PricebookEntryId field in any custom code or layouts.
Quantity
Type double Properties Create, Filter, Nillable, Sort, Update
2177
Standard Objects
Field Name
WorkOrderLineItem
Details Description Number of units of the line item included in the associated work order.
RootWorkOrderLineItemId
Type reference Properties Filter, Group, Nillable, Sort Description (Read only) The top-level line item in a work order line item hierarchy. Depending on where a line item lies in the hierarchy, its root could be the same as its parent. Note: View a line item’s child line items in the Child Work Order Line Items related list.
ServiceTerritoryId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service territory where the line item is completed.
StartDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the line item goes into effect. This field is blank unless you set up an Apex trigger or quick action to populate it. For example, you can create a quick action that sets the StartDate to the date when the Status changes to In Progress.
State
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state where the line item is completed. Maximum length is 80 characters.
Status
Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
2178
Standard Objects
Field Name
WorkOrderLineItem
Details Description The status of the line item. The picklist includes the following values, which can be customized: • New—Line item was created, but there hasn’t yet been any activity. • In Progress—Work has begun. • On Hold—Work is paused. • Completed—Work is complete. • Cannot Complete—Work could not be completed. • Closed—All work and associated activity is complete. • Canceled—Work is canceled, typically before any work began.
StatusCategory
Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The category that each Status value falls into. The Status Category field has eight default values: seven values which are identical to the default Status values, and a None value for statuses without a status category. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Waiting for Response value, you may decide that it belongs in the On Hold category. The Status Category field can be useful to reference in custom apps, triggers, and validation rules. Status categories let you extend and customize the work life cycle while still maintaining a consistent work classification for tracking, reporting, and business process management.
Street
Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street number and name where the line item is completed.
Subject
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description A word or phrase describing the line item.
2179
Standard Objects
WorkOrderLineItem
Field Name
Details
Subtotal
Type currency Properties Filter, Nillable, Sort Description (Read only) The line item’s unit price multiplied by the quantity.
TotalPrice
Type currency Properties Filter, Nillable, Sort Description Read only. The line item’s subtotal with discounts applied.
UnitPrice
Type currency Properties Create, Filter, Nillable, Sort, Update Description Initially, the unit price for a work order line item is the line item’s list price from the price book, but you can change it.
WorkOrderId
Type reference Properties Create, Filter, Group, Sort Description The line item’s parent work order. Because work order line items must be associated with a work order, this is a required field.
WorkTypeId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work type associated with the line item. When a work type is selected, the line item automatically inherits the work type’s Duration, Duration Type, and required skills.
2180
Standard Objects
WorkOrderLineItemFeed
Usage A work order line item is a child record of a work order. It represents a specific subtask on a work order. For example, suppose a customer purchased a truck from you. The truck is represented as an asset in your Salesforce org. After some time, the truck needs both headlight bulbs replaced. Here’s one way that you can use work orders and work order line items to track the repair. 1. Create a work order named “Replace Headlight Bulbs” from the asset record detail page. 2. Add three work order line items to the work order: “Replace Left Headlight Bulb,” “Replace Right Headlight Bulb,” and “Test Headlights.” 3. Assign the work order to a technician via a queue. 4. As the technician completes each line item, he or she marks the item as Completed. 5. When all the line items are complete, the technician marks the work order as Completed.
WorkOrderLineItemFeed Represents a single feed item on a work order line item record detail page. This object is available in API version 36.0 and later. A work order line item feed shows changes to tracked fields on a work order line item record. It also shows posts and comments about the record. It’s a useful way to stay up to date with changes made to work order line items in Salesforce.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Work orders or Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Work Order Line Item object • “Moderate Chatter” Note: Users with the “Moderate Chatter” permission can delete only the feed items and comments they see.
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort
2181
Standard Objects
Field Name
WorkOrderLineItemFeed
Details Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item.
ConnectionId
Type reference Properties Filter, Group, Nillable, Sort Description The ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization. When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort
2182
Standard Objects
Field Name
WorkOrderLineItemFeed
Details Description Available in API version 36.0 and earlier only. The name of the file to upload to the feed. Required if Type is ContentPost. Setting this field sets Type to ContentPost.
ContentSize
Type int Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. The size of the file uploaded to the feed in bytes. Determined during insert.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. The MIME type of the file uploaded to the feed. Determined during insert.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort
2183
Standard Objects
Field Name
WorkOrderLineItemFeed
Details Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a link post.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the work order line item record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the feed item. When Type = LinkPost, Link URL= the link URL and Title = the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
2184
Standard Objects
WorkOrderLineItemHistory
WorkOrderLineItemHistory Represents the history of changes made to tracked fields on a work order line item. This object is available in API version 36.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Work orders or Field Service Lightning must be enabled in your organization, and field tracking for work order line item fields must be configured.
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
WorkOrderLineItemId
Type reference Properties Filter, Group, Sort
2185
Standard Objects
Field Name
WorkOrderShare
Details Description ID of the work order line item being tracked. The history is displayed on the detail page for this record.
WorkOrderShare Represents a sharing entry on a work order. This object is available in API version 36.0 and later.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Special Access Rules Work orders or Field Service Lightning must be enabled in your organization. Community users can’t access this object.
Fields Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Level of access that the user or group has to the work order. The possible values are: • Read • Edit • All (This value isn’t valid for create or update calls.) Set to an access level that is at least equal to the organization’s default work order access level.
ParentId
Type reference Properties Create, Filter, Group, Sort Description The work order associated with the sharing entry.
2186
Standard Objects
WorkPerformanceCycle
Field Name
Details
RowCause
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The reason why this sharing entry exists. You can write to this field only when its value is omitted or set to Manual (default). Valid values include: • Manual—The user or group has access because a user with “All” access manually shared the work order. • Owner—The user is the owner of the work order. • Team—The user or group has team access. • Rule—The user or group has access via a work order sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description (Read Only) ID of the user or group that has access to the work order.
WorkPerformanceCycle Represents feedback that is gathered to assess the performance of a specific set of employees.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field Name
Details
ActivityFrom
Type date Properties Create, Filter, Group, Sort, Update Description The date that you want to start filtering the work.com objects to help requesters create accurate summaries. The start of the evaluation period.
2187
Standard Objects
WorkPerformanceCycle
Field Name
Details
ActivityTo
Type date Properties Create, Filter, Group, Sort, Update Description The date that you want to stop filtering the work.com objects to help requesters create accurate summaries. The end of the evaluation period.
CurrentTask
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The current task that the performance summary cycle is engaged in, including deploying and sharing.
LastManagerRequestsSharedDate
Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when all manager requests are set to be shared.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this WorkPerformanceCycle.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this WorkPerformanceCycle. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.
Name
Type string
2188
Standard Objects
Field Name
WorkPerformanceCycleFeed
Details Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the performance summary cycle that employees will participate in. This name is created by the administrator and is visible on all respective notifications and in the UI.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the WorkPerformanceCycle.
State
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The state that the performance summary cycle is in. Available pick list values: • Setup: The summary is in draft. • In Progress: The summary is deployed and people are answering the questions that were created. • Finished: The summary is no longer in progress. • Error: The summary encountered an error.
WorkPerformanceCycleFeed Represents a single feed item in the feed that is displayed on a Work.com Performance detail page.
Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Body
Type textarea
2189
Standard Objects
Field Name
WorkPerformanceCycleFeed
Details Properties Nillable, Sort Description The content of the FeedItem. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. This field is the message that appears in the feed.
CommentCount
Type int Properties Filter, Group, Sort Description The number of FeedComments associated with this feed item.
ContentData
Type base64 Properties Nillable Description Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
Type textarea Properties Nillable, Sort Description Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. This field is required if Type is ContentPost. The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
Type int
2190
Standard Objects
Field Name
WorkPerformanceCycleFeed
Details Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. Automatically determined during insert. The size of the file (in bytes) uploaded to the feed.
ContentType
Type string Properties Group, Nillable, Sort Description Available in API version 36.0 and earlier only. Read only. Automatically determined during insert. The MIME type of the file uploaded to the feed.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if a client application migrates multiple posts and comments from another application into a feed, then InsertedById is set to the ID of the logged-in user.
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the feed item Body contains rich text. Set IsRichText to true if you post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: • Tip: Though the
tag isn’t supported, you can use
to create lines. • • • • • •
2191
Standard Objects
Field Name
WorkPerformanceCycleFeed
Details • • - •
The tag is accessible only via the API and must reference files in Salesforce similar to this example:
Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. LikeCount
Type int Properties Filter, Group, Sort Description The number of FeedLikes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a LinkPost.
NetworkScope
Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Specifies whether this feed item is available in the default community, a specific community, or all communities. If Salesforce Communities is enabled for your organization, this field is available in API version 30.0 and later. NetworkScope can have the following values:
• NetworkId—The ID of the community in which the FeedItem is available. If left empty, the feed item is only available in the default community. • AllNetworks—The feed item is available in all communities. Note the following exceptions for NetworkScope: • Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. • For feed items with a record parent, users can set NetworkScope only to AllNetworks.
2192
Standard Objects
Field Name
WorkPerformanceCycleFeed
Details • You can’t filter a FeedItem on the NetworkScope field.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the group that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost. For example, set this field to an existing ContentVersion and post it to a feed as a FeedItem object of Type ContentPost.
Title
Type string Properties Group, Nillable, Sort Description The title of the FeedItem. When the Type is LinkPost, the LinkUrl is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item. Except for ContentPost, LinkPost, and TextPost, don’t create feed item types directly from the API • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence.
2193
Standard Objects
Field Name
WorkPerformanceCycleFeed
Details • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. • AnnouncementPost—Not used. • ApprovalPost—generated when a user submits an approval. • BasicTemplateFeedItem—Not used. • CanvasPost—a post made by a canvas app posted on a feed. • CollaborationGroupCreated—generated when a user creates a public group. • CollaborationGroupUnarchived—Not used. • ContentPost—a post with an attached file. • CreatedRecordEvent—generated when a user creates a record from the publisher. • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. • LinkPost—a post with an attached URL. • PollPost—a poll posted on a feed. • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. • QuestionPost—generated when a user posts a question. • ReplyPost—generated when Chatter Answers posts a reply. • RypplePost—generated when a user creates a Thanks badge in Work.com. • TextPost—a direct text entry on a feed. • TrackedChange—a change or group of changes to a tracked field. • UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: • AttachArticleEvent—generated event when a user attaches an article to a case. • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. • CaseCommentPost—generated event when a user adds a case comment for a case object. • ChangeStatusPost—generated event when a user changes the status of a case. • ChatTranscriptPost—generated event when Live Agent transcript is saved to a case.
2194
Standard Objects
Field Name
WorkPerformanceCycleHistory
Details • EmailMessageEvent—generated event when an email related to a case object is sent or received. • FacebookPost—generated when a Facebook post is created from a case. Deprecated. • MilestoneEvent—generated when a case milestone is completed or reaches violation status. • SocialPost—generated when a social post is created from a case.
Visibility
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The visibility of a FeedItem: • AllUsers: visible to all users • InternalUsers: visible to internal users
WorkPerformanceCycleHistory Represents the history of changes to the values in the fields of a WorkPerformanceCycle object.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort
2195
Standard Objects
Field Name
WorkPerformanceCycleShare
Details Description The new value of the field that was changed.
OldValue
Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed.
WorkPerformanceCycleId
Type reference Properties Filter, Group, Sort Description The ID of the WorkPerformanceCycle.
WorkPerformanceCycleShare Represents a sharing entry on a WorkPerformanceCycle object.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The user’s or group’s level of access to the work performance cycle. The possible values are: • Read
2196
Standard Objects
Field Name
WorkReward
Details • Edit • All: This value is not valid when you create, update, or delete records. This field must be set to an access level that is higher than the organization’s default access level for work performance cycles.
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID of the WorkPerformanceCycle object that is associated with this sharing entry.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. Read-only. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Valid values include: • Owner: User is the owner of the WorkPerformanceCycle or is in a user role above the WorkPerformanceCycle owner in the role hierarchy. • Manual: User or group has access, because a user with “All” access manually shared the WorkPerformanceCycle with the user or group. • Rule: User or group has access via a WorkPerformanceCycle sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description ID of the user or group that was given access to the performance cycle share. This field can’t be updated.
WorkReward Used to store reward codes tied to a Reward Fund. Reward Funds must have at least one WorkReward record.
2197
Standard Objects
WorkReward
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
Special Access Rules You must have the Reward permission enabled in order to use the Rewards feature, including WorkRewardFund and WorkReward.
Additional Considerations and Related Objects WorkReward is a lookup to WorkRewardFund. WorkRewardFund must have at least one WorkReward record to be available for use. Each WorkBadge record with a RewardId indicates a reward badge given to a Recipient.
Fields Field Name
Details
Code
Type string Properties Create, Filter, Group, Sort, Update Description Represents a singe reward code tied to a RewardFundId.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Represents the User ID of Owner of WorkReward record
RecipientId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Salesforce User ID for User associated with this WorkReward record.
RedemptionDisclaimer
Type textarea Properties Nillable
2198
Standard Objects
Field Name
WorkReward
Details Description The disclaimer information about the WorkReward.
RedemptionInfo
Type textarea Properties Nillable Description The instructions for redeeming the WorkReward.
RedemptionUrl
Type textarea Properties Nillable Description The URL for redeeming the WorkReward.
RewardFundId
Type reference Properties Create, Filter, Group, Sort, Update Description Salesforce unique ID for WorkRewardFund record that is associated with WorkReward record.
RewardFundTypeId
Type reference Properties Create, Filter, Group, Sort, Update Description Salesforce unique ID of the WorkRewardFundType associated with the WorkReward.
Value
Type double Properties Filter, Nillable, Sort Description The value of the WorkReward.
2199
Standard Objects
WorkRewardFund
WorkRewardFund Represents a Reward Fund and describes the Reward Fund attributes.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Special Access Rules To use the Rewards feature, including WorkRewardFund and WorkReward, you must have the Reward permission enabled. To create Rewards, the user must have Create on WorkRewardFund, which is not a standard permission.
Additional Considerations and Related Objects WorkReward is a lookup to WorkRewardFund. WorkRewardFund must have at least one WorkReward record available. Each WorkBadgeDefinition with a RewardFundId is a “Reward Badge.”
Fields Field Name
Details
IsActive
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the WorkRewardFund is active (true) or not (false).
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this WorkRewardFund.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort
2200
Standard Objects
Field Name
WorkRewardFund
Details Description The time stamp that indicates when the current user last viewed this WorkRewardFund. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the Reward Fund.
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Salesforce unique ID of User who is the Owner of the WorkRewardFund record.
RewardFundTypeId
Type reference Properties Create, Filter, Group, Sort, Update Description Salesforce unique ID of the WorkRewardFundType that is associated with the WorkRewardFund.
TotalCodeCount
Type int Properties Filter, Group, Nillable, Sort Description Total reward codes that are available in the WorkRewardFund. Derived from WorkReward records that are associated with the WorkRewardFund.
Type
Type string Properties Create, Filter, Group, Nillable, Sort, Update Description RewardType of the WorkRewardFund. Default is Amazon.com.
2201
Standard Objects
WorkRewardFundHistory
Field Name
Details
UsedCodeCount
Type int Properties Filter, Group, Nillable, Sort Description Total reward codes that are used in the WorkRewardFund. Derived from the total assigned WorkReward records that are associated with the WorkRewardFund.
Value
Type currency Properties Create, Filter, Sort, Update Description Value of each of the reward codes in the WorkRewardFund.
WorkRewardFundHistory Represents the history of changes to the values in the fields of a WorkRewardFund object.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Type of change (e.g., created).
NewValue
Type Any Type Properties Nillable, Sort Description Updated value of record.
2202
Standard Objects
WorkRewardFundShare
Field Name
Details
OldValue
Type Any Type Properties Nillable, Sort Description Previous value of record.
WorkRewardFundId
Type reference Properties Filter, Group, Sort Description ID of WorkRewardFund record.
WorkRewardFundShare Share records for WorkRewardFund.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description CRUD Access Level (picklist values: Read Only, Read/Write, Owner).
ParentId
Type reference Properties Create, Filter, Group, Sort
2203
Standard Objects
Field Name
WorkRewardFundType
Details Description ID for WorkRewardFund record.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Owner or Manual sharing. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description User or Group ID for WorkRewardFund record.
WorkRewardFundType Represents the type of WorkRewardFund object.
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields Field Name
Details
CreditSystem
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The credit system that is used by the WorkRewardFundType object (gift codes or points). If points are selected, the reward message will not consider the CurrencyCode field.
2204
Standard Objects
WorkRewardFundType
Field Name
Details
CurrencyCode
Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency code of the WorkRewardFundType
IsActive
Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether the WorkRewardFundType is active and available in the UI
IsPredefined
Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the WorkRewardFundType is predefined (true) or not (false)
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed a record that is related to this WorkRewardFundType.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The time stamp that indicates when the current user last viewed this WorkRewardFundType. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.
Name
Type string Properties Create, Filter, Group, idLookup, Sort, Update
2205
Standard Objects
Field Name
WorkRewardFundType
Details Description The name of the WorkRewardFundType
OwnerId
Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the WorkRewardFundType owner
RedemptionDisclaimer
Type textarea Properties Create, Nillable, Update Description The redemption disclaimer text for the WorkRewardFundType
RedemptionInfo
Type textarea Properties Create, Nillable, Update Description Redemption text for the WorkRewardFundType
RedemptionUrl
Type textarea Properties Create, Nillable, Update Description The URL that’s linked to the redemption
UploadCodeColumn
Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The column where the reward code is contained in the CSV file. The upload uses the second value by default.
UploadValueColumn
Type int
2206
Standard Objects
Field Name
WorkRewardFundTypeHistory
Details Properties Create, Filter, Group, Nillable, Sort, Update Description The column where the reward value is contained in the CSV file. The upload uses the third column by default.
WorkRewardFundTypeHistory Represents the history of changes to the values in the fields of a WorkRewardFundType object.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed
NewValue
Type anyType Properties Nillable, Sort Description The value of the changed field
OldValue
Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed
2207
Standard Objects
WorkRewardFundTypeShare
Field Name
Details
WorkRewardFundTypeId
Type reference Properties Filter, Group, Sort Description The ID of the WorkRewardFundType
WorkRewardFundTypeShare Represents a sharing entry on a WorkRewardFundType.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The user’s or group’s level of access to the work reward fund type. The possible values are: • Read • Edit • All: This value is not valid when you create, update, or delete records. This field must be set to an access level that is higher than the organization’s default access level for WorkRewardFundType objects.
ParentId
Type reference Properties Create, Filter, Group, Sort
2208
Standard Objects
Field Name
WorkRewardHistory
Details Description The ID of the WorkRewardFundType object that is associated with this sharing entry.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The reason that this sharing entry exists. Read-only. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings. Valid values include: • Owner: User is the owner of the WorkRewardFundType or is in a user role above the WorkRewardFundType owner in the role hierarchy. • Manual: User or group has access, because a user with “All” access manually shared the WorkRewardFundType with the user or group. • Rule: User or group has access via a WorkRewardFundType sharing rule.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description The ID of the user or group that was given access to the WorkRewardFundType. This field can’t be updated.
WorkRewardHistory Represents the history of changes to the fields of a WorkReward.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
2209
Standard Objects
WorkRewardShare
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed
OldValue
Type anyType Properties Nillable, Sort Description The latest value of the field before it was changed
WorkRewardId
Type reference Properties Filter, Group, Sort Description The ID of the WorkReward
WorkRewardShare Share records for WorkReward object.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
2210
Standard Objects
WorkThanks
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description CRUD Access Level (picklist values: Read Only, Read/Write, Owner).
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID for WorkReward record.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Owner or Manual sharing. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description User or Group ID for WorkReward record.
WorkThanks Represents the source and message of a thanks post.
2211
Standard Objects
WorkThanks
Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
Additional Considerations and Related Objects WorkBadge is a lookup to WorkThanks. Each WorkBadge record must derive a SourceId from WorkThanks.
Fields Field Name
Details
FeedItemId
Type reference Properties Filter, Group, Nillable, Sort Description ID of the FeedItem related to the thanks badge.
GiverId
Type reference Properties Create, Filter, Group, Sort Description Salesforce user ID for the giver of the Thanks record.
Message
Type textarea Properties Create Description Required. Message associated with the Thanks record.
NetworkId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the community that this WorkThanks is associated with. This field is available only if Salesforce Communities is enabled in your organization.
OwnerId
Type reference
2212
Standard Objects
Field Name
WorkThanksShare
Details Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Salesforce user ID for the owner of the badge record (typically the same user as the giver of the record).
WorkThanksShare Share records for WorkThanks object.
Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Fields The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields. Field Name
Details
AccessLevel
Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description CRUD Access Level (picklist values: Read Only, Read/Write, Owner).
ParentId
Type reference Properties Create, Filter, Group, Sort Description ID for WorkThanks record.
RowCause
Type picklist Properties Filter, Group, Restricted picklist, Sort Description Owner or Manual sharing.
2213
Standard Objects
Field Name
WorkType
Details You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings.
UserOrGroupId
Type reference Properties Create, Filter, Group, Sort Description User or Group ID for WorkThanks record.
WorkType Represents a type of work to be performed. Work types are templates that can be applied to work order or work order line items. This object is available in API version 38.0 and later.
Supported Calls create(),delete(),describeLayout(),describeSObjects(),getDeleted(),getUpdated(),query(),retrieve(),search(), undelete(), update(), upsert()
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Description
Type textarea Properties Create, Nillable, Update Description The description of the work type. Try to add details about the task or tasks that this work type represents.
DurationType
Type picklist Properties Create, Filter, Group, Defaulted on create, Restricted picklist, Sort, Update
2214
Standard Objects
Field Name
WorkType
Details Description The unit of the Estimated Duration: Minutes or Hours.
EstimatedDuration
Type double Properties Create, Filter, Group, Nillable, Sort, Update Description The estimated length of the work. The estimated duration is in minutes or hours based on the value selected in the Duration Type field.
LastReferencedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the work type was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate
Type dateTime Properties Filter, Nillable, Sort Description The date when the work type was last viewed by the current user.
Name
Type string Properties Create, Filter, Group, Sort, Update Description The name of the work type. Try to use a name that helps users quickly understand the type of work orders that can be created from the work type. For example, “Annual Refrigerator Maintenance” or “Valve Replacement.”
ServiceReportTemplateId
Type reference Properties Create, Filter, Group, Nillable, Sort, Update
2215
Standard Objects
Field Name
WorkTypeFeed
Details Description The service report template associated with the work type. When users create service reports from a work order or work order line item that uses this work type, the reports will use this template.
ShouldAutoCreateSvcAppt
Type boolean Properties Create, Filter, Group, Defaulted on create, Sort, Update Description Select this option to have a service appointment automatically created on work orders and work order line items that use the work type. Note: • By default, the Due Date on auto-created service appointments is seven days after the created date. Admins can adjust this offset from the Field Service Settings page in Setup. • If a work type with the Auto-Create Service Appointment option selected is added to an existing work order or work order line item, a service appointment is only created for the work order or work order line item if it doesn’t yet have one. • If someone updates an existing work type by selecting the Auto-Create Service Appointment option, service appointments aren’t created on work orders and work order line items that were already using the work type.
Usage To apply a work type to a work order or work order line item, select the work type in the Work Type lookup field on the record. When you add a work type, the work order or work order line item inherits the work type’s duration values and required skills. Note: • If needed, you can update the duration values and required skills on a work order or work order line item after they’re inherited from the work type. • If a work order or work order line item already has required skills, associating it with a work type doesn’t cause it to inherit the work type’s required skills. • Customizations to required skills, such as validation rules or Apex triggers, are not carried over from work types to work orders and work order line items.
WorkTypeFeed Represents a single feed item on a work type record detail page. This object is available in API version 38.0 and later.
2216
Standard Objects
WorkTypeFeed
A work type feed shows changes to tracked fields on a work type record. It also shows posts and comments about the record. It’s a useful way to stay up to date with changes made to work types in Salesforce.
Supported Calls delete(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled in your organization, and you can delete all feed items you created. To delete feed items you didn’t create, you must have one of these permissions: • “Modify All Data” • “Modify All” on the Operating Hours object • “Moderate Chatter”
Fields Field Name
Details
Body
Type textarea Properties Nillable, Sort Description The message that appears in the feed. Required when Type is TextPost. Optional when Type is ContentPost orLinkPost.
CommentCount
Type int Properties Filter, Group, Sort Description The number of comments associated with this feed item.
InsertedById
Type reference Properties Group, Nillable, Sort Description ID of the user who added this object to the feed. For example, if an application migrates posts and comments from another application into a feed, the value is set to the ID of the logged-in user.
2217
Standard Objects
WorkTypeFeed
Field Name
Details
IsRichText
Type boolean Properties Defaulted on create, Filter, Group, Sort Description true indicates that the body of the feed contains rich text. false indicates that the post is rendered as plain text.
LikeCount
Type int Properties Filter, Group, Sort Description The number of feed likes associated with this feed item.
LinkUrl
Type url Properties Nillable, Sort Description The URL of a link post.
ParentId
Type reference Properties Filter, Group, Sort Description ID of the work type record tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
Type reference Properties Group, Nillable, Sort Description ID of the ContentVersion object associated with a content post. This field is null for all posts, except ContentPost.
Title
Type string Properties Group, Nillable, Sort
2218
Standard Objects
Field Name
WorkTypeHistory
Details Description The title of the feed item. When the Type is LinkPost, the Link URL is the URL, and this field is the link name.
Type
Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of feed item.
WorkTypeHistory Represents the history of changes made to tracked fields on a work type. This object is available in API version 38.0 and later.
Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Special Access Rules Field Service Lightning must be enabled.
Fields Field Name
Details
Field
Type picklist Properties Filter, Group, Restricted picklist, Sort Description The name of the field that was changed.
NewValue
Type anyType Properties Nillable, Sort Description The new value of the field that was changed.
2219
Standard Objects
Reusable Terms for API Objects
Field Name
Details
OldValue
Type anyType Properties Nillable, Sort Description The value of the field before it was changed.
WorkTypeId
Type reference Properties Filter, Group, Sort Description ID of the work type being tracked. The history is displayed on the detail page for this record.
Reusable Terms for API Objects API Version Availability. This object is available in API version 39.0 and later. This object is available in API version 38.0 and later. This object is available in API version 37.0 and later. This object is available in API version 27.0 and later. This object is available in API version 21.0 and later. This object is available in API version 20.0 and later. This object is available in API version 18.0 and later.
API Reusables Note: To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer support to enable access to this object for your org.
2220
CHAPTER 3
Data Model
The entity relationship diagrams (ERDs) for standard Salesforce objects in this section illustrate important relationships between objects. Salesforce ERDs use crow’s foot notation. The following ERDs are available. • Sales Objects—includes accounts, contacts, opportunities, leads, campaigns, and other related objects • Task and Event Objects—includes tasks and events and their related objects • Support Objects—includes cases and solutions and their related objects • Salesforce Knowledge Objects—includes view and vote statistics, article versions, and other related objects • Document, Note, and Attachment Objects—includes documents, notes, and attachments and their related objects • User, Sharing, and Permission Objects—includes users, profiles, and roles • Profile and Permission Objects—includes users, profiles, permission sets, and related permission objects • Record Type Objects—includes record types and business processes and their related objects • Product and Schedule Objects—includes opportunities, products, and schedules • Sharing and Team Selling Objects—includes account teams, opportunity teams, and sharing objects • Customizable Forecasting Objects—includes forecasts and related objects • Forecasts Objects—includes objects for Collaborative Forecasts. • Territory Management 2.0 Objects—includes territories and related objects associated with Territory Management 2.0 • Territory Management—includes territories and related objects • Process Objects—includes approval processes and related objects • Content Objects—includes content and libraries and their related objects • Chatter Feed Objects—includes objects related to feeds • Work.com Badge and Reward Objects—includes badge and reward objects • Work.com Feedback and Performance Cycle Objects—includes feedback and performance cycle objects Each ERD includes links to the topics that describe the fields in objects related to the diagram. The data model for your custom objects depends on what you create.
2221
Data Model
Sales Objects
Sales Objects
SEE ALSO: Standard Objects Data Model
2222
Data Model
Task and Event Objects
Task and Event Objects
SEE ALSO: Standard Objects Data Model
2223
Data Model
Support Objects
Support Objects
SEE ALSO: Standard Objects Data Model
2224
Data Model
Document, Note, and Attachment Objects
Document, Note, and Attachment Objects
SEE ALSO: Standard Objects Data Model
2225
Data Model
User, Sharing, and Permission Objects
User, Sharing, and Permission Objects
SEE ALSO: Standard Objects Data Model Profile and Permission Objects
2226
Data Model
Profile and Permission Objects
Profile and Permission Objects
SEE ALSO: Standard Objects Data Model
2227
Data Model
Record Type Objects
Record Type Objects
SEE ALSO: Standard Objects Data Model
2228
Data Model
Product and Schedule Objects
Product and Schedule Objects
Create a separate PricebookEntry for each currency and price combination. SEE ALSO: Standard Objects Data Model
2229
Data Model
Sharing and Team Selling Objects
Sharing and Team Selling Objects
SEE ALSO: Standard Objects Data Model
Customizable Forecasting Objects
SEE ALSO: Standard Objects Data Model
2230
Data Model
Forecasts Objects
Forecasts Objects Note: This information only applies to Collaborative Forecasts.
SEE ALSO: Standard Objects Data Model
Territory Management 2.0 Objects Note: This information applies to Territory Management 2.0 only, not to previous versions of Territory Management.
2231
Data Model
Territory Management 2.0 Objects
SEE ALSO: Standard Objects Data Model
2232
Data Model
Territory Management
Territory Management
SEE ALSO: Standard Objects Data Model
2233
Data Model
Process Objects
Process Objects
SEE ALSO: Standard Objects Data Model
2234
Data Model
Content Objects
Content Objects
SEE ALSO: Standard Objects Data Model
ContentNote Objects The ContentNote object represents notes created with the enhanced version of the Salesforce note-taking tool.
2235
Data Model
Chatter Objects
SEE ALSO: ContentNote
Chatter Objects Diagram showing the relationships between the Chatter objects The following diagram shows the relationships between the major Chatter objects. • A feed item is an entry in the feed, such as a change to a record that's being followed, an updated post, or a user status change. • All feed items have a ParentId, which is either: – a record – a user – a group
2236
Data Model
Chatter Objects
SEE ALSO: Standard Objects Data Model
2237
Data Model
Chatter Feed Objects
Chatter Feed Objects
Standard Objects with Feeds The following standard objects can have Chatter feeds: Account, Asset, Case, CollaborationGroup, Contact, ContentDocument, Contract, Dashboard, DashboardComponent, Entitlement, Event, KnowledgeArticle, Lead, Opportunity, Product2, Quote, Report, ServiceContract, Site, Solution, Task, Topic, User, WorkOrder, and WorkOrderLineItem. SEE ALSO: Standard Objects Data Model
2238
Data Model
Salesforce Knowledge Objects
Salesforce Knowledge Objects
SEE ALSO: Standard Objects Data Model
2239
Data Model
Work.com Badge and Reward Objects
Work.com Badge and Reward Objects
2240
Data Model
Work.com Feedback and Performance Cycle Objects
SEE ALSO: Standard Objects Data Model
Work.com Feedback and Performance Cycle Objects
SEE ALSO: Standard Objects Data Model
2241
INDEX A AcceptedEventRelation object 68 Account object 69 AccountCleanInfo object 91 AccountContactRelation object 89 AccountContactRole object 113 AccountFeed object 114 AccountHistory object 122 AccountOwnerSharingRule object 123 AccountPartner object 126 AccountShare object 128 AccountTag object 132 AccountTeamMember object 133 AccountTerritoryAssignmentRule object 137 AccountTerritoryAssignmentRuleItem object 138 ActionLinkGroupTemplate object 143 ActionLinkTemplate object 145 ActiveScratchOrg object 150 ActivityHistory 154 AdditionalNumber object 163 address 9, 13 Address object 164 AgentWork object 167 AllowedEmailDomain object 173 Announcement object 174 ApexClass object 176 ApexComponent object 178 ApexLog object 181 ApexPage object 183 ApexTestQueueItem object 186 ApexTestResult object 188 ApexTestResultLimits object 191 ApexTestRunResult object 194 ApexTestSuite object 197 ApexTrigger object 197 AppMenuItem object 201 Approval object 207 Article DataCategorySelection 209 Asset object 217 AssetFeed object 221 AssetTag object 232 AssetTokenEvent object 234 AssignedResource object 237 AssignmentRule object 238
AssociatedLocation object 239 AsyncApexJob object 241 AttachedContentDocument object 244 AttachedContentNote object 246 Attachment object 248 AuraDefinition object 252 AuraDefinitionBundle object 254 AuthConfig object 256 AuthConfigProviders object 258 AuthProvider object 259 AuthSession object 265
B BackgroundOperation object 268 Badge data model 2240 Bookmark object 275 BrandTemplate 276 BusinessProcess object 282
C CallCenter object 284 Campaign object 286 CampaignFeed object 294 CampaignHistory object 302 CampaignInfluence object 303 CampaignInfluenceModel object 305 CampaignMember object 307 CampaignMemberStatus object 313 CampaignOwnerSharingRule object 315 CampaignShare object 317 CampaignTag object 319 Cascading deletes 23 Case object 320 CaseComment object 332 CaseContactRole object 334 CaseFeed object 335 CaseHistory object 343 CaseMilestone object 345 CaseOwnerSharingRule object 348 CaseShare object 350 CaseSolution object 352 CaseStatus object 353 CaseTag object 355 CaseTeamMember object 356 CaseTeamRole object 357
2242
Index
CaseTeamTemplate object 358 CaseTeamTemplateMember object 358 CaseTeamTemplateRecord object 359 CategoryData object 360 CategoryNode object 361 CategoryNodeLocalization object 363 Chatter objects 2236 ChatterActivity object 368 ChatterAnswersActivity object 370 ChatterAnswersReputationLevel object 374 ChatterConversation object 375 ChatterConversationMember object 376 ChatterMessage object 377 ClientBrowser object 378 CollaborationGroup object 379 CollaborationGroupFeed object 386 CollaborationGroupMember object 393 CollaborationGroupMemberRequest object 395 CollaborationGroupRecord object 397 CollaborationInvitation object 398 CombinedAttachment object 401 Community (Zone) object 403 compound fields 9, 12–13 ConnectedApplication object 405 Contact object 407 ContactCleanInfo object 419 ContactFeed object 428 ContactHistory object 436 ContactOwnerSharingRule object 437 ContactShare object 439 ContactTag object 441 ContentBody object 444 ContentDistribution object 445 ContentDistributionView object 450 ContentDocument object 452 ContentDocumentFeed object 458 ContentDocumentHistory object 465 ContentDocumentLink object 467 ContentFolder object 471 ContentFolderItem object 471 ContentFolderLink object 473 ContentFolderMember object 474 ContentHubItem object 475 ContentHubRepository object 479 ContentNote object 480 ContentVersion object 484 ContentVersionHistory object 496 ContentWorkspace object 498
ContentWorkspaceDoc object 501 ContentWorkspaceMember object 503 ContentWorkspacePermission object 504 Contract object 507 ContractContactRole object 516 ContractFeed object 517 ContractHistory object 525 ContractLineItem object 526 ContractLineItemHistory object 531 ContractStatus object 532 ContractTag object 534 CorsWhitelistEntry object 535 CreatedById fields 16 CreatedDate fields 16 CronJobDetail object 537 CronTrigger object 538 CurrencyType object 541 Custom fields 18 Custom Metadta Type__mdt object 546 Custom Object__Feed object 549 Custom objects 19 CustomBrand object 543 CustomBrandAsset object 544 CustomPermission object 550 CustomPermissionDependency object 553
D DandBCompany object 554 Dashboard object 577 DashboardComponent object 583 DashboardComponentFeed object 583 DashboardFeed object 591 DashboardTag object 598 Data access standard objects 24 Data types, mapping API to Salesforce field types 15 DataAssessmentFieldMetric object 599 DataAssessmentMetric object 601 DataAssessmentValueMetric object 603 DataCategorySelection article 209 DataCategorySelection question 1576 DatacloudCompany object 604 DatacloudContact object 612 DatacloudDandBCompany object 617 DatacloudOwnedEntity object 640 DatacloudPurchaseUsage object 642 DatacloudSocialHandle object 644 DatedConversionRate object 645 DcSocialProfile object 646
2243
Index
DcSocialProfileHandle object 648 DeclinedEventRelation object 649 Deleting and cascading deletes 23 Division object 651 DivisionLocalization object 652 Document object 654 DocumentAttachmentMap 658 DocumentTag object 659 Domain object 661 DomainSite object 662 DuplicateRule 666
E Effective dated currency 645 EmailDomainKey object 668 EmailMessage object 670 EmailMessageRelation object 677 EmailServicesAddress object 678 EmailServicesFunction object 680 EmailStatus 685 EmailTemplate object 658, 687 EmbeddedServiceDetail 692 Entitlement object 694 EntitlementContact object 698 EntitlementFeed object 699 EntitlementHistory object 706 EntitlementTemplate object 708 EntityHistory object 710 EntityMilestone object 712 EntitySubscription object 718 EnvironmentHubMember object 721 Event object 725 EventFeed object 739 EventLogFile External Cross-Org Callout 867 External Custom Apex Callout 871 External OData Callout 875 EventRelation object 917 EventTag object 923 EventWhoRelation object 924 External objects 22 ExternalDataSource object 925 ExternalDataUserAuth object 929
F FeedAttachment object 931 Feedback data model 2241 FeedComment object 933
FeedItem object 938, 956 FeedLike object 949 FeedPollChoice object 951 FeedPollVote object 952 FeedPost object 952 Feeds custom 959 post 952, 959 standard 959 FeedTrackedChange object 959 Field types 3, 9, 12–13 FieldHistoryArchive object 273, 962 FieldPermissions object 965 Fields custom fields 18 system fields 16 FiscalYearSettings object 968 FlowInterview object 973 Folder object 977 FolderedContentDocument object 980 ForecastingAdjustment object 981 ForecastingDisplayedFamily object 986 ForecastingFact object 986 ForecastingItem object 989 ForecastingOwnerAdjustment object 995 ForecastingQuota object 999 ForecastingType object 1002 ForecastingUserPreference object 1004 ForecastShare object 1006 Freeze users 1991
G geolocation 9, 12–13 Goal object 1008 GoalFeed object 1010 GoalHistory object 1016 GoalLink object 1017 GoalShare object 1017 GoogleDoc object 1019 Group object 1020 GroupMember object 1023
H HashtagDefinition object 1024 Holiday object 1026
I ID fields 16 Idea object 1029
2244
Index
IdeaComment object 1035 IdeaReputation 1038 IdeaReputationLevel object 1040 IdeaTheme object 1041
LoginHistory object 1184 LoginIp object 1189 LookedUpFromActivity object 1190 Lookup relationships 23
K
M
KnowledgeableUser object 1043
macro 1199 Macro 1197 MacroInstruction object 1199 MailmergeTemplate object 1201 MaintenanceAsset object 1203 MaintenancePlan object 1205 map 9, 12 Mapping API data types to Salesforce field types 15 Master-detail relationships 23 MatchingRule object 1209 MatchingRuleItem object 1212 MetadataPackage object 1214 MetadataPackageVersion object 1215 Metric object 1218 MetricDataLink object 1221 MetricDataLinkHistory object 1222 MetricFeed object 1223 MetricHistory object 1228 MetricsDataFile object 1229 MetricShare object 1232 MilestoneType object 1234 mobile 9, 12
L LastModifiedById fields 16 LastModifiedDate fields 16 Lead object 1059 LeadCleanInfo object 1077 LeadFeed object 1091 LeadHistory object 1099 LeadOwnerSharingRule object 1100 LeadShare object 1102 LeadStatus object 1104 LeadTag object 1106 LimitAllocationPerApp object 1107 LineItemOverride object 1109 ListView object 1118 ListViewChart object 1120 ListViewChartInstance object 1122 LiveAgentSession object 1125 LiveAgentSessionHistory object 1129 LiveAgentSessionOwnerSharingRule object 1130 LiveAgentSessionShare object 1132 LiveChatBlockingRule object 1134 LiveChatButton object 1135 LiveChatButtonDeployment object 1144 LiveChatButtonSkill object 1144 LiveChatDeployment object 1145 LiveChatSensitiveDataRule object 1148 LiveChatTranscript object 1151 LiveChatTranscriptEvent object 1158 LiveChatTranscriptHistory object 1160 LiveChatTranscriptOwnerSharingRule 1161 LiveChatTranscriptOwnerSharingRule object LiveChatTranscriptOwnerSharingRule 1161 LiveChatTranscriptShare object 1163 LiveChatTranscriptSkill object 1165 LiveChatUserConfig object 1166 LiveChatUserConfigProfile object 1171 LiveChatUserConfigUser object 1172 LiveChatVisitor object 1172 location 9, 12 LoginEvent object 1174 LoginGeo object 1182
N NamedCredential object 1238 NamespaceRegistry object 1241 NavigationLinkSet object 1242 NavigationMenuItem object 1243 NavigationMenuItemLocalization object 1246 Network object 1247 NetworkActivityAudit object 1255 NetworkMember object 1258 NetworkMemberGroup object 1263 NetworkModeration object 1265 NetworkPageOverride object 1266 NetworkSelfRegistration object 1267 NewsFeed object 1268 Note object 1275 NoteAndAttachment object 1279 NoteTag object 1281
O OauthToken object 1277
2245
Index
Object_asset 229, 974 Object_Assets 231, 976 Object_name object 442, 2061 Object[PushTopic] 1556 Object[StreamingChannel] 1842 ObjectPermissions object 1282 Objects AcceptedEventRelation 68 Account 69 AccountCleanInfo 91 AccountContactRelation 89 AccountContractRole 113 AccountFeed 114 AccountHistory 122 AccountOwnerSharingRule 123 AccountPartner 126 AccountShare 128 AccountTag 132 AccountTeamMember 133 AccountTerritoryAssignmentRule 137 AccountTerritoryAssignmentRuleItem 138 ActionLinkGroupTemplate 143 ActionLinkTemplate 145 ActiveScratchOrg 150 ActivityHistory 154 AdditionalNumber 163 Address 164 AgentWork 167 AllowedEmailDomain 173 Announcement 174 ApexClass 176 ApexComponent 178 ApexLog 181 ApexPage 183 ApexTesResultLimits 191 ApexTestQueueItem 186 ApexTestResult 188 ApexTestRunResult 194 ApexTestSuite 197 ApexTrigger 197 AppMenuItem 201 Approval 207 Asset 217 AssetFeed 221 Assets 229, 231, 974, 976 AssetTag 232 AssetTokenEvent 234 AssignedResource 237 AssignmentRule 238
Objects (continued) AssociatedLocation 239 AsyncApexJob 241 AttachedContentDocument 244 AttachedContentNote 246 Attachment 248 AuraDefinition 252 AuraDefinitionBundle 254 AuthConfig 256 AuthConfigProviders 258 AuthProvider 259 AuthSession 265 BackgroundOperation 268 Bookmark 275 BrandTemplate 276 BusinessProcess 282 CallCenter 284 Campaign 286 CampaignFeed 294 CampaignHistory 302 CampaignInfluence 303 CampaignInfluenceModel 305 CampaignMember 307 CampaignMemberStatus 313 CampaignOwnerSharingRule 315 CampaignShare 317 CampaignTag 319 Case 320 CaseComment 332 CaseContactRole 334 CaseFeed 335 CaseHistory 343 CaseMilestone 345 CaseOwnerSharingRule 348 CaseShare 350 CaseSolution 352 CaseStatus 353 CaseTag 355 CaseTeamMember 356 CaseTeamRole 357 CaseTeamTemplate 358 CaseTeamTemplateMember 358 CaseTeamTemplateRecord 359 CategoryData 360 CategoryNode 361 CategoryNodeLocalization 363 ChatterActivity 368 ChatterAnswersActivity 370 ChatterAnswersReputationLevel 374
2246
Index
Objects (continued) ChatterConversation 375 ChatterConversationMember 376 ChatterMessage 377 ClientBrowser 378 CollaborationGroup 379 CollaborationGroupFeed 386 CollaborationGroupMember 393 CollaborationGroupMemberRequest 395 CollaborationGroupRecord 397 CollaborationInvitation 398 CombinedAttachment 401 Community (Zone) 403 ConnectedApplication 405 Contact 407 ContactCleanInfo 419 ContactFeed 428 ContactHistory 436 ContactOwnerSharingRule 437 ContactShare 439 ContactTag 441 ContentBody 444 ContentDistribution 445 ContentDistributionView 450 ContentDocument 452 ContentDocumentFeed 458 ContentDocumentHistory 465 ContentDocumentLink 467 ContentFolder 471 ContentFolderItem 471 ContentFolderLink 473 ContentFolderMember 474 ContentHubItem 475 ContentHubRepository 479 ContentNote 480 ContentVersion 484 ContentVersionHistory 496 ContentWorkspace 498 ContentWorkspaceDoc 501 ContentWorkspaceMember 503 ContentWorkspacePermission 504 Contract 507 ContractContactRole 516 ContractFeed 517 ContractHistory 525 ContractLineItem 526 ContractLineItemHistory 531 ContractStatus 532 ContractTag 534
Objects (continued) CorsWhitelistEntry 535 CronJobDetail 537 CronTrigger 538 CurrencyType 541 Custom Metadta Type__mdt 546 Custom Object__Feed 549 custom objects 19 CustomBrand 543 CustomBrandAsset 544 CustomPermission 550 CustomPermissionDependency 553 DandBCompany 554 Dashboard 577 DashboardComponent 583 DashboardComponentFeed 583 DashboardFeed 591 DashboardTag 598 DataAssessmentFieldMetric 599 DataAssessmentMetric 601 DataAssessmentValueMetric 603 DatacloudCompany 604 DatacloudContact 612 DatacloudDandBCompany 617 DatacloudOwnedEntity 640 DatacloudPurchaseUsage 642 DatacloudSocialHandle 644 DatedConversionRate 645 DcSocialProfile 646 DcSocialProfileHandle 648 DeclinedEventRelation 649 Division 651 DivisionLocalization 652 Document 654 DocumentAttachmentMap 658 DocumentTag 659 Domain 661 DomainSite 662 DuplicateRule 666 EmailDomainKey 668 EmailMessage 670 EmailMessageRelation 677 EmailServicesAddress 678 EmailServicesFunction 680 EmailStatus 685 EmailTemplate 687 EmbeddedServiceDetail 692 Entitlement 694 EntitlementContact 698
2247
Index
Objects (continued) EntitlementFeed 699 EntitlementHistory 706 EntitlementTemplate 708 EntityHistory 710 EntityMilestone 712 EntitySubscription 718 EnvironmentHubMember 721 Event 725 EventFeed 739 EventLogFile 746, 880, 886, 893, 901, 907, 912 EventRelation 917 EventTag 923 EventWhoRelation 924 external objects 22 ExternalDataSource 925 ExternalDataUserAuth 929 FeedAttachment 931 FeedComment 933 FeedItem 938 FeedLike 949 FeedPollChoice 951 FeedPollVote 952 FeedPost 952 FeedRevision 956 FeedTrackedChange 959 FieldHistoryArchive 273, 962 FieldPermissions 965 FiscalYearSettings 968 FlowInterview 973 Folder 977 FolderedContentDocument 980 ForecastingAdjustment 981 ForecastingDisplayedFamily 986 ForecastingFact 986 ForecastingItem 989 ForecastingOwnerAdjustment 995 ForecastingQuota 999 ForecastingType 1002 ForecastingUserPreference 1004 ForecastShare 1006 Goal 1008 GoalFeed 1010 GoalHistory 1016 GoalLink 1017 GoalShare 1017 GoogleDoc 1019 Group 1020 GroupMember 1023
Objects (continued) HashtagDefinition 1024 Holiday 1026 Idea 1029 idea comment 1035 IdeaReputation 1038 IdeaReputationLevel 1040 IdeaTheme 1041 KnowledgeableUser 1043 Lead 1059 LeadCleanInfo 1077 LeadFeed 1091 LeadHistory 1099 LeadOwnerSharingRule 1100 LeadShare 1102 LeadStatus 1104 LeadTag 1106 LimitAllocationPerApp 1107 LineItemOverride 1109 ListView 1118 ListViewChart 1120 ListViewChartInstance 1122 LiveAgentSession 1125 LiveAgentSessionHistory 1129 LiveAgentSessionOwnerSharingRule 1130 LiveAgentSessionShare 1132 LiveChatBlockingRule 1134 LiveChatButton 1135 LiveChatButtonDeployment 1144 LiveChatButtonSkill 1144 LiveChatDeployment 1145 LiveChatSensitiveDataRule 1148 LiveChatTranscript 1151 LiveChatTranscriptEvent 1158 LiveChatTranscriptHistory 1160 LiveChatTranscriptShare 1163 LiveChatTranscriptSkill 1165 LiveChatUserConfig 1166 LiveChatUserConfigProfile 1171 LiveChatUserConfigUser 1172 LiveChatVisitor 1172 LoginEvent 1174 LoginGeo 1182 LoginHistory 1184 LoginIp 1189 LookedUpFromActivity 1190 Macro 1197 MacroInstruction 1199 MailmergeTemplate 1201
2248
Index
Objects (continued) MaintenanceAsset 1203 MaintenancePlan 1205 MatchingRule 1209 MatchingRuleItem 1212 MetadataPackage 1214 MetadataPackageVersion 1215 Metric 1218 MetricDataLink 1221 MetricDataLinkHistory 1222 MetricFeed 1223 MetricHistory 1228 MetricsDataFile 1229 MetricShare 1232 MilestoneType 1234 NamedCredential 1238 NamespaceRegistry 1241 NavigationLinkSet 1242 NavigationMenuItem 1243 NavigationMenuItemLocalization 1246 Network 1247 NetworkActivityAudit 1255 NetworkMember 1258 NetworkMemberGroup 1263 NetworkModeration 1265 NetworkPageOverride 1266 NetworkSelfRegistration 1267 NewsFeed 1268 Note 1275 NoteAndAttachment 1279 NoteTag 1281 OauthToken 1277 Object_name 442, 2061 ObjectPermissions 1282 ObjectTerritory2AssignmentRule 1285 ObjectTerritory2AssignmentRuleItem 1287 ObjectTerritory2Association 1289 OpenActivity 1290 OperatingHours 1298 OperatingHoursFeed 1299 OperatingHoursHistory 1302 Opportunity 1303 OpportunityCompetitor 1313 OpportunityContactRole 1314 OpportunityFeed 1316 OpportunityFieldHistory 1324 OpportunityHistory 1325 OpportunityLineItem 1327 OpportunityLineItemSchedule 1334
Objects (continued) OpportunityOverride 1338 OpportunityOwnerSharingRule 1341 OpportunityPartner 1343 OpportunityShare 1344 OpportunitySplit 1346 OpportunitySplitType 1348 OpportunityStage 1351 OpportunityTag 1354 OpportunityTeamMember 1355 Order 1358 OrderFeed 1367 OrderHistory 1374 OrderItem 1375 OrderItemFeed 1378 OrderItemHistory 1385 OrderOwnerSharingRule 1386 Organization 1389 OrgWideEmailAddress 1409 OwnedContentDocument 1410 PackageLicense 1412 PackagePushError 1414 PackagePushJob 1416 PackagePushRequest 1419 PackageSubscriber 1422 Partner 1426 PartnerNetworkConnection 1428 PartnerNetworkRecordConnection 1431 PartnerNetworkSyncLog 1435 PartnerRole 1437 Period 1438 PermissionSet 1440 PermissionSetAssignment 1446 PermissionSetLicense 1448 PermissionSetLicenseAssign 1451 PlatformAction 1452 PresenceUserConfig 1459 PresenceUserConfigProfile 1461 PresenceUserConfigUser 1462 Pricebook2 1462 Pricebook2History 1466 PricebookEntry 1467 ProcessDefinition 1470 ProcessInstance 1472 ProcessInstanceHistory 1475 ProcessInstanceNode 1480 ProcessInstanceStep 1477 ProcessInstanceWorkitem 1482 ProcessNode 1484
2249
Index
Objects (continued) Product2 1486 Product2Feed 1492 ProductEntitlementTemplate 1499 ProductItemTransaction 1500 ProductRequest 1502 ProductRequestFeed 1506 ProductRequestHistory 1511 ProductRequestLineItem 1512 ProductRequestOwnerSharingRule 1517 ProductRequestShare 1518 ProductTransfer 1519 ProductTransferFeed 1523 ProductTransferHistory 1527 ProductTransferOwnerSharingRule 1528 ProductTransferShare 1528 Profile 1530 ProfileSkill 1533 ProfileSkillEndorsement 1535 ProfileSkillEndorsementFeed 1536 ProfileSkillEndorsementHistory 1540 ProfileSkillFeed 1541 ProfileSkillHistory 1547 ProfileSkillShare 1548 ProfileSkillUser 1549 ProfileSkillUserFeed 1550 ProfileSkillUserHistory 1555 QuantityForecast 1558 QuantityForecastHistory 1566 Question 1571 QuestionReportAbuse 1578 QuestionSubscription 1579 QueueRoutingConfig 1568 QueueSobject 1580 QuickText 1581 QuickTextHistory 1583 QuickTextOwnerSharingRule 1584 QuickTextShare 1586 Quote 1587 QuoteDocument 1601 QuoteFeed 1602 QuoteLineItem 1607 RecordType 1615 RecordTypeLocalization 1618 Reply 1620 ReplyReportAbuse 1622 Report 1623 ReportFeed 1627 ReportTag 1634
Objects (continued) ReputationLevel 1636 ReputationLevelLocalization 1637 ReputationPointsRule 1639 ResourceAbsence 1640 ResourceAbsenceFeed 1644 ResourceAbsenceHistory 1646 ResourcePreference 1647 ResourcePreferenceFeed 1649 ResourcePreferenceHistory 1651 RevenueForecast 1652 RevenueForecastHistory 1661 RuleTerritory2Association 1663 SamlSsoConfig 1664 Scontrol 1669 ScontrolLocalization 1672 ScratchOrgInfo 1678 SecureAgent 1685 SecureAgentsCluster 1687 SecurityCustomBaseline 1688 SelfServiceUser 1690 ServiceAppointment 1693 ServiceAppointmentFeed 1701 ServiceAppointmentHistory 1703 ServiceAppointmentOwnerSharingRule 1704 ServiceAppointmentShare 1706 ServiceChannel 1708 ServiceChannelStatus 1709 ServiceContract 1710 ServiceContractFeed 1719 ServiceContractHistory 1726 ServiceContractOwnerSharingRule 1727 ServiceContractShare 1729 ServicePresenceStatus 1731 ServiceReport 1732 ServiceResource 1734 ServiceResourceCapacity 1737 ServiceResourceCapacityFeed 1740 ServiceResourceCapacityHistory 1742 ServiceResourceFeed 1744 ServiceResourceHistory 1746 ServiceResourceOwnerSharingRule 1747 ServiceResourceShare 1749 ServiceResourceSkill 1750 ServiceResourceSkillFeed 1752 ServiceResourceSkillHistory 1755 ServiceTerritory 1756 ServiceTerritoryFeed 1760 ServiceTerritoryHistory 1762
2250
Index
Objects (continued) ServiceTerritoryMember 1763 ServiceTerritoryMemberFeed 1768 ServiceTerritoryMemberHistory 1770 SessionPermSetAssignment 1771 SetupAuditTrail 1773 SetupEntityAccess 1775 Shipment 1777 SignupRequest 1784 Site 1791 SiteDomain 1796 SiteHistory 1798 Skill 1799 SkillProfile 1800 SkillRequirement 1801 SkillRequirementFeed 1803 SkillRequirementHistory 1806 SkillUser 1807 SlaProcess 1807 Solution 1811 SolutionFeed 1815 SolutionHistory 1822 SolutionStatus 1824 SolutionTag 1825 SOSDeployment 1827 SOSSession 1829 SOSSessionActivity 1832 SOSSessionHistory 1833 SOSSessionOwnerSharingRule 1834 SOSSessionShare 1836 Stamp 1838 StampAssignment 1838 standard objects 27 StaticResource 1839 TagDefinition 1843 Task 1845 TaskFeed 1856 TaskPriority 1864 TaskRelation 1865 TaskStatus 1867 TaskTag 1869 TaskWhoRelation 1870 TenantSecret 1872 Territory 1875 Territory2 1878 Territory2Model 1881 Territory2ModelHistory 1883 Territory2Type 1884 TestSuiteMembership 971, 1886
Objects (continued) ThirdPartyAccountLink 1886 TimeSheet 1889 TimeSheetEntry 1891 TimeSheetEntryFeed 1894 TimeSheetEntryHistory 1896 TimeSheetFeed 1897 TimeSheetHistory 1899 TimeSheetOwnerSharingRule 1900 TimeSheetShare 1902 TimeSlot 1904 TimeSlotHistory 1906 Topic 1907 TopicFeed 1910 TopicLocalization 1916 TwoFactorInfo 1921 TwoFactorMethodsInfo 1922 TwoFactorTempCode 1924 UndecidedEventRelation 1925 User 1927 UserAccountTeamMember 1966 UserAppInfo 1969 UserAppMenuCustomization 1970 UserAppMenuCustomizationShare 1971 UserAppMenuItem 1972 UserConfigTransferButton 1975 UserConfigTransferSkill 1976 UserCustomBadge 1977 UserCustomBadgeLocalization 1978 UserFeed 1980 UserLicense 1987 UserLogin 1991 UserMembershipSharingRule 1992 UserPackageLicense 1993 UserPreference 1994 UserProfile 1996 UserProfileFeed 2014 UserProvAccount 2021 UserProvAccountStaging 2024 UserProvisioningConfig 2028 UserProvisioningLog 2032 UserProvisioningRequest 2034 UserProvisioningRequestOwnerSharingRule 2039 UserProvisioningRequestShare 2041 UserProvMockTarget 2027 UserRecordAccess 2042 UserRole 2045 UserServicePresence 2049 UserShare 2050
2251
Index
Objects (continued) UserTeamMember 2052 UserTerritory 2053 UserTerritory2Association 2055 VerificationHistory 2056 VoiceCall 2062 VoiceCallList 2066 VoiceCallListItem 2066 VoiceCallListShare 2067 VoiceCallShare 2069 VoiceMailContent 2070 VoiceMailContentShare 2071 VoiceMailMessage 2072 VoiceMailMessageShare 2074 VoiceUserLine 2075 VoiceUserLineShare 2076 VoiceVendorInfo 2077 VoiceVendorLine 2078 VoiceVendorLineShare 2080 vote 2081 WebLink 2083 WebLinkLocalization 2088 WorkAccess 2093 WorkAccessShare 2094 WorkBadge 2095 WorkBadgeDefinition 2098 WorkBadgeDefinitionHistory 2101 WorkBadgeDefinitionShare 2102 WorkCoaching 2104 WorkCoachingFeed 2105 WorkCoachingHistory 2111 WorkCoachingShare 2112 WorkFeedback 2114 WorkFeedbackHistory 2115 WorkFeedbackQuestion 2116 WorkFeedbackQuestionHistory 2119 WorkFeedbackQuestionSet 2120 WorkFeedbackQuestionSetHistory 2121 WorkFeedbackQuestionSetShare 2122 WorkFeedbackQuestionShare 2123 WorkFeedbackRequest 2125 WorkFeedbackRequestFeed 2130 WorkFeedbackRequestHistory 2135 WorkFeedbackRequestShare 2136 WorkFeedbackShare 2138 WorkGoal 2139 WorkGoalCollaborator 2145 WorkGoalCollaboratorHistory 2146 WorkGoalFeed 2148
Objects (continued) WorkGoalHistory 2154 WorkGoalLink 2155 WorkGoalShare 2156 WorkOrder 2157 WorkOrderFeed 2168 WorkOrderHistory 2172 WorkOrderLineItem 2173 WorkOrderLineItemFeed 2181 WorkOrderLineItemHistory 2185 WorkOrderShare 2186 WorkPerformanceCycle 2187 WorkPerformanceCycleFeed 2189 WorkPerformanceCycleHistory 2195 WorkPerformanceCycleShare 2196 WorkReward 2197 WorkRewardFund 2200 WorkRewardFundHistory 2202 WorkRewardFundShare 2203 WorkRewardFundType 2204 WorkRewardFundTypeHistory 2207 WorkRewardFundTypeShare 2208 WorkRewardHistory 2209 WorkRewardShare 2210 WorkThanks 2211 WorkThanksShare 2213 WorkType 2214 WorkTypeFeed 2216 WorkTypeHistory 2219 ObjectTerritory2AssignmentRule object 1285 ObjectTerritory2AssignmentRuleItem object 1287 ObjectTerritory2Association object 1289 OpenActivity object 1290 OperatingHours object 1298 OperatingHoursFeed object 1299 OperatingHoursHistory object 1302 Opportunity object 1303 OpportunityCompetitor object 1313 OpportunityContactRole object 1314 OpportunityFeed object 1316 OpportunityFieldHistory object 1324 OpportunityHistory object 1325 OpportunityLineItem object 1327 OpportunityLineItemSchedule object 1334 OpportunityOverride object 1338 OpportunityOwnerSharingRule object 1341 OpportunityPartner object 1343 OpportunityShare object 1344 OpportunitySplit object 1346
2252
Index
OpportunitySplitType object 1348 OpportunityStage object 1351 OpportunityTag object 1354 OpportunityTeamMember object 1355 Order object 1358 OrderFeed object 1367 OrderHistory object 1374 OrderItem object 1375 OrderItemFeed object 1378 OrderItemHistory object 1385 OrderOwnerSharingRule object 1386 Organization object 1389 OrgWideEmailAddress object 1409 OwnedContentDocument object 1410
P PackageLicense object 1412 PackagePushError object 1414 PackagePushJob object 1416 PackagePushRequest object 1419 PackageSubscriber object 1422 Partner object 1426 PartnerNetworkConnection object 1428 PartnerNetworkRecordConnection object 1431 PartnerNetworkSyncLog object 1435 PartnerRole object 1437 Performance cycle data model 2241 Period object 1438 PermissionSet object 1440 PermissionSetAssignment object 1446 PermissionSetLicense object 1448 PermissionSetLicenseAssign object 1451 PlatformAction object 1452 Posts 952, 959 PresenceUserConfig object 1459 PresenceUserConfigProfile object 1461–1462 Pricebook2 object 1462 Pricebook2History object 1466 PricebookEntry object 1467 ProcessDefinition object 1470 ProcessInstance object 1472 ProcessInstanceHistory object 1475 ProcessInstanceNode object 1480 ProcessInstanceStep object 1477 ProcessInstanceWorkitem 1482 ProcessNode object 1484 Product2 object 1486 Product2Feed object 1492
ProductEntitlementTemplate object 1499 ProductItemTransaction object 1500 ProductRequest object 1502 ProductRequestFeed object 1506 ProductRequestHistory object 1511 ProductRequestLineItem object 1512 ProductRequestOwnerSharingRule object 1517 ProductRequestShare object 1518 ProductTransfer object 1519 ProductTransferFeed object 1523 ProductTransferHistory object 1527 ProductTransferOwnerSharingRule object 1528 ProductTransferShare object 1528 Profile object 1530 ProfileSkill object 1533 ProfileSkillEndorsement object 1535 ProfileSkillEndorsementFeed object 1536 ProfileSkillEndorsementHistory object 1540 ProfileSkillFeed object 1541 ProfileSkillHistory object 1547 ProfileSkillShare object 1548 ProfileSkillUser object 1549 ProfileSkillUserFeed object 1550 ProfileSkillUserHistory object 1555 PushTopic object 1556
Q QuantityForecast object 1558 QuantityForecastHistory object 1566 Question object 1571 QuestionDataCategorySelection 1576 QuestionReportAbuse object 1578 QuestionSubscription object 1579 QueueRoutingConfig object 1568 QueueSobject object 1580 QuickText object 1581 QuickTextHistory object 1583 QuickTextOwnerSharingRule object 1584 QuickTextShare object 1586 Quote object 1587 QuoteDocument object 1601 QuoteFeed object 1602 QuoteLineItem object 1607
R RecordType object 1615 RecordTypeLocalization object 1618 Relationships parent reference fields in child object 16
2253
Index
Reply object 1620 ReplyReportAbuse object 1622 Report object 1623 ReportFeed object 1627 ReportTag object 1634 ReputationLevel object 1636 ReputationLevelLocalization object 1637 ReputationPointsRule object 1639 ResourceAbsence object 1640 ResourceAbsenceFeed object 1644 ResourceAbsenceHistory object 1646 ResourcePreference object 1647 ResourcePreferenceFeed object 1649 ResourcePreferenceHistory object 1651 RevenueForecast object 1652 RevenueForecastHistory object 1661 Reward data model 2240 Role, see UserRole 2045 RuleTerritory2Association object 1663
S SamlSsoConfig object 1664 Scontrol object 1669 ScontrolLocalization object 1672 ScratchOrgInfo object 1678 SecureAgent object 1685 SecureAgentsCluster object 1687 SecurityCustomBaseline object 1688 SelfServiceUser object 1690 ServiceAppointment object 1693 ServiceAppointmentFeed object 1701 ServiceAppointmentHistory object 1703 ServiceAppointmentOwnerSharingRule object 1704 ServiceAppointmentShare object 1706 ServiceChannel object 1708 ServiceChannelStatus object 1709 ServiceContract object 1710 ServiceContractFeed object 1719 ServiceContractHistory object 1726 ServiceContractOwnerSharingRule object 1727 ServiceContractShare object 1729 ServicePresenceStatus object 1731 ServiceReport object 1732 ServiceResource object 1734 ServiceResourceCapacity object 1737 ServiceResourceCapacityFeed object 1740 ServiceResourceCapacityHistory object 1742 ServiceResourceFeed object 1744
ServiceResourceHistory object 1746 ServiceResourceOwnerSharingRule object 1747 ServiceResourceShare object 1749 ServiceResourceSkill object 1750 ServiceResourceSkillFeed object 1752 ServiceResourceSkillHistory object 1755 ServiceTerritory object 1756 ServiceTerritoryFeed object 1760 ServiceTerritoryHistory object 1762 ServiceTerritoryMember object 1763 ServiceTerritoryMemberFeed object 1768 ServiceTerritoryMemberHistory object 1770 SessionPermSetAssignment object 1771 SetupAuditTrail object 1773 SetupEntityAccess object 1775 Shipment object 1777 SignupRequest object 1784 Site object 1791 SiteDomain object 1796 SiteHistory object 1798 Skill object 1799 SkillProfile object 1800 SkillRequirement object 1801 SkillRequirementFeed object 1803 SkillRequirementHistory object 1806 SkillUser object 1807 SlaProcess object 1807 Solution object 1811 SolutionFeed object 1815 SolutionHistory object 1822 SolutionStatus object 1824 SolutionTag object 1825 SOSDeployment object 1827 SOSSession object 1829 SOSSessionActivity object 1832 SOSSessionHistory object 1833 SOSSessionOwnerSharingRule object 1834 SOSSessionShare object 1836 Stamp object 1838 StampAssignment object 1838 Standard objects data access 24 StaticResource object 1839 StreamingChannel object 1842 System fields 16 SystemModstamp fields 16
T TagDefinition object 1843
2254
Index
Task object 1845 TaskFeed object 1856 TaskPriority object 1864 TaskRelation object 1865 TaskStatus object 1867 TaskTag object 1869 TaskWhoRelation object 1870 TenantSecret object 1872 Territory object 1875 Territory2 object 1878 Territory2Model object 1881 Territory2ModelHistory object 1883 Territory2Type object 1884 TestSuiteMembership object 971, 1886 ThirdPartyAccountLink object 1886 TimeSheet object 1889 TimeSheetEntry object 1891 TimeSheetEntryFeed object 1894 TimeSheetEntryHistory object 1896 TimeSheetFeed object 1897 TimeSheetHistory object 1899 TimeSheetOwnerSharingRule object 1900 TimeSheetShare object 1902 TimeSlot object 1904 TimeSlotHistory object 1906 Topic object 1907 TopicFeed object 1910 TopicLocalization object 1916 TwoFactorInfo object 1921 TwoFactorMethodsInfo object 1922 TwoFactorTempCode object 1924 Types of fields 3, 9, 12–13
U UndecidedEventRelation object 1925 User object 1927 UserAccountTeamMember object 1966 UserAppInfo object 1969 UserAppMenuCustomization object 1970 UserAppMenuCustomizationShare object 1971 UserAppMenuItem object 1972 UserConfigTransferButton object 1975 UserConfigTransferSkill object 1976 UserCustomBadge object 1977 UserCustomBadgeLocalization object 1978 UserFeed object 1980 UserLicense object 1987 UserLogin object 1991 UserMembershipSharingRule object 1992
UserPackageLicense object 1993 UserPreference object 1994 UserProfile object 1996 UserProfileFeed object 2014 UserProvAccount object 2021 UserProvAccountStaging object 2024 UserProvisioningConfig object 2028 UserProvisioningLog object 2032 UserProvisioningRequest object 2034 UserProvisioningRequestOwnerSharingRule object 2039 UserProvisioningRequestShare object 2041 UserProvMockTarget object 2027 UserRecordAccess object 2042 UserRole object 2045 UserServicePresence object 2049 UserShare object 2050 UserTeamMember object 2052 UserTerritory object 2053 UserTerritory2Association object 2055
V VerificationHistory object 2056 VoiceCall object 2062 VoiceCallList object 2066 VoiceCallListItem object 2066 VoiceCallListShare object 2067 VoiceCallShare object 2069 VoiceMailContent object 2070 VoiceMailContentShare object 2071 VoiceMailMessage object 2072 VoiceMailMessageShare object 2074 VoiceUserLine object 2075 VoiceUserLineShare object 2076 VoiceVendorInfo object 2077 VoiceVendorLine object 2078 VoiceVendorLineShare object 2080 Vote object 2081
W WebLink object 2083 WebLinkLocalization object 2088 WorkAccess object 2093 WorkAccessShare object 2094 WorkBadge object 2095 WorkBadgeDefinition object 2098 WorkBadgeDefinitionHistory object 2101 WorkBadgeDefinitionShare object 2102 WorkCoaching object 2104 WorkCoachingFeed object 2105
2255
Index
WorkCoachingHistory object 2111 WorkCoachingShare object 2112 WorkFeedback object 2114 WorkFeedbackHistory object 2115 WorkFeedbackQuestion object 2116 WorkFeedbackQuestionHistory object 2119 WorkFeedbackQuestionSet object 2120 WorkFeedbackQuestionSetHistory object 2121 WorkFeedbackQuestionSetShare object 2122 WorkFeedbackQuestionShare object 2123 WorkFeedbackRequest object 2125 WorkFeedbackRequestFeed object 2130 WorkFeedbackRequestHistory object 2135 WorkFeedbackRequestShare object 2136 WorkFeedbackShare object 2138 WorkGoal object 2139 WorkGoalCollaborator object 2145 WorkGoalCollaboratorHistory object 2146 WorkGoalFeed object 2148 WorkGoalHistory object 2154 WorkGoalLink object 2155 WorkGoalShare object 2156 WorkOrder object 2157 WorkOrderFeed object 2168
WorkOrderHistory object 2172 WorkOrderLineItem object 2173 WorkOrderLineItemFeed object 2181 WorkOrderLineItemHistory object 2185 WorkOrderShare object 2186 WorkPerformanceCycle object 2187 WorkPerformanceCycleFeed object 2189 WorkPerformanceCycleHistory object 2195 WorkPerformanceCycleShare object 2196 WorkReward object 2197 WorkRewardFund object 2200 WorkRewardFundHistory object 2202 WorkRewardFundShare object 2203 WorkRewardFundType object 2204 WorkRewardFundTypeHistory object 2207 WorkRewardFundTypeShare object 2208 WorkRewardHistory object 2209 WorkRewardShare object 2210 WorkThanks object 2211 WorkThanksShare object 2213 WorkType object 2214 WorkTypeFeed object 2216 WorkTypeHistory object 2219
2256