Chatter REST API Developer Guide

Chatter REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Request Bodies
Action Link Definition Input
Action Link Group Definition Input
Action Link Input
Action Link Template Binding Input
Activity Reminder Input
Alternative Input
Announcement Input
Article Topic Assignment Job 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
Chatter Stream 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
Direct Message Capability Input
Environment Hub SSO User Mapping Input
Extension Input
Extensions Capability Input
Feed Element Capabilities Input
Feed Entity Share Capability 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
Invite Collection 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
Notification Member Input
Photo Input
Pin Capability Input (Beta)
Poll Capability Input
Push Notification Input
Question and Answers Capability Input
Read By Capability Input
Recommendation Audience Input
Recommendation Definition Input
Request Header Input
Scheduled Recommendation Input
Share Captured Activity Input
Share Input
Status Capability Input
Stream Subscription Input
Topic Assignment Input
Topic Endorsement Input
Topic Input
Topic Names Input
Topics Capability Input
Up Down Vote Capability 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
Verified Capability Input
Response Bodies
Appendices
PDF

Newer Version Available

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

File Input

Describes a new file input. To upload a file, provide the binary file in a multipart/form-data body part where name="fileData". See Uploading Binary Files.
Root XML tag
<fileInput>
JSON
1{ 
2   "desc":"Employee Survey Results",
3   "title":"emp_surv_results"
4}
Properties
Name Type Description Required or Optional Available Version
content​ModifiedDate Date File-specific last modified date that can be used to set a client-side modified date. Optional 32.0
desc String Description of the file to be uploaded. Optional 24.0
includeExternal��FilePermissions​Info Boolean Specifies whether to include permission information, such as whether the file is shared and what are the available permission types, for external files.

This property can be used with POST requests to /connect/files/users/userId, but not with POST requests to /connect/files/fileId.

 Optional 35.0
isInMyFileSync Boolean true if the file is synced with Salesforce Files Sync; false otherwise. Optional 31.0
isMajorVersion Boolean true if the file is a major version; false if the file is a minor version. Major versions can’t be replaced. Optional 31.0
parentFolderId String ID of the containing folder. Optional 31.0
repository​FileId String ID of the external file.

This property can be used with POST requests to /connect/files/users/userId, but not with POST requests to /connect/files/fileId.

If you specify repositoryFileId, don’t specify repositoryFileUri.

 Optional 32.0
repository​FileUri String URI of the external file, such as https://drive.google.com/file/d/​0B7a_ei8brT1TMy1CQ0o5NmZQNEE/view.

This property can be used with POST requests to /connect/files/users/userId, but not with POST requests to /connect/files/fileId.

If you specifyrepositoryFileUri, don’t specify repositoryFileId.

 Optional 39.0
repositoryId String ID of the external data source.

This property can be used with POST requests to /connect/files/users/userId, but not with POST requests to /connect/files/fileId.

 Required if repositoryFileId is specified. Otherwise, Optional. 32.0
reuseReference Boolean Specifies whether to reuse the latest version of a reference you own to an external file rather than creating a duplicate reference.

This property can be used with POST requests to /connect/files/users/userId, but not with POST requests to /connect/files/fileId.

 Optional 36.0
sharingOption String Sharing option of the file. Values are:
  • Allowed—Resharing of the file is allowed.
  • Restricted—Resharing of the file is restricted.
 Optional 35.0
sharingPrivacy String Specifies the sharing privacy of a file. Values are:
  • None—File is visible to anyone with record access.
  • PrivateOnRecords—File is private on records.
 Optional 41.0
title String Title of the file. Optional 24.0