Chatter REST API Developer Guide

Introducing Chatter REST API
Chatter REST API Quick Start
Chatter REST API Features
Chatter REST API Examples
Chatter REST API Resources
Chatter REST API Request Bodies
Action Link Definition Input
Action Link Group Definition Input
Action Link Input
Action Link Template Binding Input
Announcement Input
Associated Actions Capability Input
Async Query Input
Attachment Input: Canvas App
Attachment Input: Existing Content
Attachment Input: Feed Poll
Attachment Input: Link
Attachment Input: New File Upload
Banner Photo Input
Batch Collection Input
Batch Input
Bookmarks Capability Input
Canvas Capability Input
Clean Input
Comment Input
Comment Capabilities Input
Content Capability Input
Custom List Audience Criteria Input
Datacloud Contact Import Input
Datacloud Order Input
Dashboard Component Snapshot Input
Digest Job Input
Environment Hub SSO User Mapping Input
Feed Element Capabilities Input
Feed Favorite Input
Feed Item Input
Feed Item Topic Input
Feed Poll Input
File Input
File ID Input
Files Capability Input
File Shares Input
Files Connect Field Value Input
Files Connect Item Input
Files Connect Permission Collection Input
Files Connect Permission Input
Folder Input
Folder Item Input
Following Input
Generic Batch Collection Input
Generic Batch Input
Group Chatter Settings Input
Group Information Input
Group Input
Group Member Input
Group Membership Request Update
Group Record Input
Link Capability Input
Managed Topic Input
Managed Topic Position Collection Input
Managed Topic Position Input
Message Body Input
Message Segment Input: Hash Tag
Message Segment Input: Inline Image
Message Segment Input: Link
Message Segment Input: Markup Begin
Message Segment Input: Markup End
Message Segment Input: Mention
Message Segment Input: Text
Moderation Flag Input
Mute Capability Input
New User Audience Criteria Input
Photo Input
Poll Capability Input
Push Notification Input
Question and Answers Capability Input
Recommendation Audience Input
Recommendation Definition Input
Request Header Input
Scheduled Recommendation Input
Share Input
Status Capability Input (Beta)
Topic Assignment Input
Topic Endorsement Input
Topic Input
Topic Names Input
User Chatter Settings Input
User ID Collection Input
User Input
User Message
User Message Recipient Input
User Message Recipient List Input
User Status Input
User Stream (Conversation) Input
Chatter REST API Response Bodies
Chatter REST API Appendices
PDF

Newer Version Available

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

Async Query Input

Create an asynchronous query job.

This feature is currently available to select customers through a pilot program. To be nominated to join this pilot program, contact salesforce.com. Additional terms and conditions may apply to participate in the pilot program. Please note that pilot programs are subject to change, and as such, we cannot guarantee acceptance into this pilot program or a particular time frame in which this feature can be enabled. Any unreleased services or features referenced in this document, press releases, or public statements are not currently available and may not be delivered on time or at all. Customers who purchase our services should make their purchase decisions based upon features that are currently available.

Note

Root XML tag
<asyncQueryInput>
JSON example
1{
2   "query":"AnnualRevenue FROM Lead",
3   "targetObject":"bigDemo__b",
4   "targetFieldMap":{
5      "AnnualRevenue":"cf0__c"
6   },
7   "targetValueMap":{
8      "Today Count":"cf3__c"
9   }
10}
Properties
Name Type Description Required or Optional Available Version
query String SOQL query string. The pilot release supports these SOQL features in WHERE statements: simple equality filtering; AND and OR clauses; one level relationship fields (no subqueries); GROUP BY; aggregate functions COUNT(field),​ SUM(), AVG(). Required 35.0
targetFieldMap Map<String, String> A mapping of SOQL query fields to target object fields. Required 35.0
targetValueMap Map<String, String> A mapping of literal values to target object fields. Optional 37.0
targetObject String An object that stores the results of the SOQL query. The object can be a standard or custom Salesforce object, a big object, or an external object. Required 35.0