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.
REST: DELETE, GET, PATCH, POST (query requests are specified in the URI)
SOAP: create(), delete(), describe(), describeSObjects(), query(), retrieve(), update()
| 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: 24.0 |
| CreatedById | ID | System field: ID of the User who created this record. |
| CreatedDate | dateTime | System field: Date and time when this record was
created. 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 |
| LastModifiedById | ID | System field: Date and time when this record
was last modified by a user. Field Properties:Default on create, Filter, Group, Sort |
| LastModifiedDate | dateTime | System field: Date and time when this record
was last modified by a user. Field Properties:Default on create, Filter, Sort |
| Name | string | Required. Descriptive name of the PushTopic, such as MyNewCases or TeamUpdatedContacts. Limit: 25 characters. This value identifies
the channel. Field Properties:Create, Filter, Group, Sort, Update |
| NotifyForFields | picklist | Specifies which fields are evaluated to generate a notification. Valid values:
Field Properties:Create, Filter, Sort, Update |
| NotifyForOperations | picklist | Specifies which record events may generate a notification. Valid values:
Field Properties:Create, Filter, Sort, Update |
| Query | string | Required. The SOQL query statement that determines which record changes trigger events
to be sent to the channel. Limit: 1300 characters Field Properties:Create, Filter, Sort, Update |
| SystemModstamp | dateTime | System field: Date and time when this record was last
modified by a user or by a workflow process (such as a trigger). Field Properties:Default on create, Filter, Sort |