SOAP API Developer Guide

Getting Started
Reference
Using the API with Salesforce Features
Glossary
PDF

Newer Version Available

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

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

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.

Note

EventLogFile Reusables

Field Details
ACTION
API_TYPE
Type
String
Description
The type of API request.
Possible Values
  • D: Apex Class
  • E: SOAP Enterprise
  • I: SOAP Cross Instance
  • M: SOAP Metadata
  • O: Old SOAP
  • P: SOAP Partner
  • S: SOAP Apex
  • T: SOAP Tooling
  • X: XmlRPC
  • f: Feed
  • l: Live Agent
  • p: SOAP ClientSync
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
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from Salesforce Workbench or AppExchange) is shown as “Salesforce.com IP”.
Example
96.43.144.26
CALLOUT_TIME
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_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.
DELIVERY_ID
Type
Id
Description
The 15-character ID of the content delivery.
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
DOCUMENT_ID
Type
Id
Description
The 15-character ID of the document that’s being shared.
ENTITY_NAME
Type
String
Description
The name of the object affected by the trigger.
Type
Set
Description
API objects that are accessed.
Example
Account, Opportunity, Contact, and so on.
EVALUATION_TIME_MS
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.
Example
ReportExport, URI, API, RestApi, and so on. For details, see EventLogFile Supported Event Types.
EXEC_TIME
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
METHOD
Type
String
Description
The HTTP method of the callout.
Example
GET, POST, PUT, and so on.
METHOD
Type
String
Description
The HTTP method of the request—GET, POST, PUT, and so on.
METHOD_NAME
Type
String
Description
The name of the calling Apex method.
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.
OPERATION
Type
String
Description
The operation that’s being performed.
Possible Values
  • meta_deploy
  • meta_list
  • meta_retrieve
  • meta_synchronous_create
  • meta_synchronous_read
  • meta_synchronous_upsert
ORGANIZATION_ID
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.
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
QUERY
Type
String
Description
The SOQL query, if one was performed.
RECORD_ID
Type
String
Description
The Salesforce ID of the Analytics object.
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)
REPORT_ID
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_SIZE
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
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 callout response, in bytes.
RESULT
Type
String
Description
The outcome of evaluating the policy.
Example
TRIGGERED or NOT TRIGGERED
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 user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
Example
d7DEq/ANa7nNZZVD
SORT
Type
String
Description
The sort column and order that was used in the report.
SOURCE_IP
Type
IP
Description
The source IP of the login request.
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
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
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.
URL
Type
String
Description
The callout endpoint URL.
Example
www.salesforce.com
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.
Example
00590000000I1SNIA0
USER_NAME
Type
String
Description
The username that’s used for login.
VERSION_ID
Type
Id
Description
The 15-character ID of the content version.
WAVE_SESSION_ID
Type
String
Description
The ID of a particular session of Analytics. Use this field to determine which log lines originated from a particular session.
WAVE_TIMESTAMP
Type
Number
Description
The time at which this log line was generated.