--- schema_version: "1" id: 28752b7baad34a3352fdc020e8247c9c74e306f17fe9286312a187cefc62476d title: Files and Folders Connect REST API collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/connect-rest/connect-rest-api/references/generated-api-specs/connect-rest-api-files.md canonical_url: https://developer.salesforce.com/docs/platform/connect-rest-api/references/connect-rest-api-files source_site: developer.salesforce.com content_type: documentation content_hash: 0bccababca9f120f545f09cc93da2aac27423b5c78a018fd9440d48b5170fbdf products: - Connect REST API Developer Guide - Connect REST APIs --- Files and Folders Connect REST API # Files and Folders Connect REST API > **Note**: The API Reference has a new three-panel layout. Browse grouped endpoints on the left, review endpoint details in the center, and access examples on the right. **Important**: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. **Version:** v68.0 ## Servers * `https://{MyDomainName}.my.salesforce.com/services/data/v68.0` API server for your Salesforce org. * ``MyDomainName (default None) Your org's My Domain name, which is used as a subdomain for the URLs that Salesforce uses to serve your org. For example, if your Lightning URL is `https://yourcompanyname.lightning.force.com`, then your My Domain name is `yourcompanyname`. Find your My Domain name and login URL on the My Domain page in Setup, or use the `getMyDomainName()` method in the Apex Domain class.`` ## Tags ### Files Connect Repository Resources A Files Connect repository is an external content repository that’s connected to Salesforce. Use these resources to get a list of repositories, to get information about a repository or a repository file, and to get the content of a repository file. Also use these resources to get information about the files and folders in a repository folder. Use these resources to get a repository’s directory entries, permissions, and permission types. Also use these resources to update a repository’s permissions. ### Files Resources Get the file upload config. Get information about files, including content, rendered version, and sharing. Get information about asset files, including content and rendition. ### Folders Resources Get information about a folder or the contents of a folder. Modify, delete, and add items to folders. ### User Files Resources Get information about a user’s files. Upload a file. ## Operations ### GET Files Connect Repository for a File `GET /connect/content-hub/items/{repositoryItemId}/repository` Operation ID: `getContentHubItemRepository`. Tags: Files Connect Repository Resources. If a contentHubItemId id is given, this returns the repository. Get Files Connect repository information for a repository file. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/items/{repositoryItemId}/repository` _Available in: v38.0_ #### Parameters * `repositoryItemId` (path, string, required) ID of the repository item. #### Responses * **200** _Files Connect Repository_ Information about a Files Connect repository. Media type: `application/json`. Schema: `FilesConnectRepositoryContenthub`. ### GET Files Connect Repository List `GET /connect/content-hub/repositories` Operation ID: `getContentHubRepositoryCollection`. Tags: Files Connect Repository Resources. List Content Hub repositories. Get a list of Files Connect repositories. **Note**: The Experience Cloud site path (`/connect/communities/{communityId}/...`) is available in version 35.0 and later. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories` _Available in: v32.0_ #### Parameters * `canBrowseOnly` (query, boolean) Retrieves only repositories that support browsing. _Available in: v32.0_ * `canSearchOnly` (query, boolean) Retrieves only repositories that support searching. _Available in: v32.0_ * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. _Available in: v32.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are between 1 and 100. If you pass in `null`, the default is 25. _Available in: v32.0_ #### Responses * **200** _Files Connect Repository Collection_ A collection of Files Connect repositories. Media type: `application/json`. Schema: `FilesConnectRepositoryCollection`. ### GET Files Connect Repository `GET /connect/content-hub/repositories/{repositoryId}` Operation ID: `getContentHubRepository`. Tags: Files Connect Repository Resources. Content Hub repository resource. Get information about a Files Connect repository. **Note**: The Experience Cloud site path (`/connect/communities/{communityId}/...`) is available in version 35.0 and later. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}` _Available in: v32.0_ #### Parameters * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. #### Responses * **200** _Files Connect Repository_ Information about a Files Connect repository. Media type: `application/json`. Schema: `FilesConnectRepositoryContenthub`. ### GET Files Connect Repository Directory Entries `GET /connect/content-hub/repositories/{repositoryId}/directory-entries` Operation ID: `getContentHubDirectoryEntryCollection`. Tags: Files Connect Repository Resources. Collection of directory entries of an external repository. Get the user and group directory entries of a repository. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/directory-entries` _Available in: v35.0_ #### Parameters * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. #### Responses * **200** _Repository Directory Entry Collection_ A collection of directory entries. Media type: `application/json`. Schema: `RepositoryDirectoryEntryCollection`. ### GET Files Connect Repository File `GET /connect/content-hub/repositories/{repositoryId}/files/{repositoryFileId}` Operation ID: `getContentHubRepositoryFile`. Tags: Files Connect Repository Resources. Repository file. Get information about a Files Connect repository file. **Note**: The Experience Cloud site path (`/connect/communities/{communityId}/...`) is available in version 35.0 and later. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/files/{repositoryFileId}` _Available in: v32.0_ #### Parameters * `repositoryFileId` (path, string, required) ID of the repository file. * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. * `includeExternalFilePermissionsInfo` (query, boolean) Specifies whether to include permission information, such as whether the file is shared and what are the available permission types. Managing external file permissions is supported for Google Drive, SharePoint Online, and OneDrive for Business. _Available in: v36.0_ #### Responses * **200** _Repository File Detail_ Detailed description of a repository file. Media type: `application/json`. Schema: `RepositoryFileDetail`. ### PATCH Files Connect Repository File `PATCH /connect/content-hub/repositories/{repositoryId}/files/{repositoryFileId}` Operation ID: `patchContentHubRepositoryFile`. Tags: Files Connect Repository Resources. Repository file. Update a Files Connect repository file. **Note**: The Experience Cloud site path (`/connect/communities/{communityId}/...`) is available in version 35.0 and later. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/files/{repositoryFileId}` _Available in: v32.0_ #### Parameters * `repositoryFileId` (path, string, required) ID of the repository file. * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. #### Request body The item type ID and fields of the item type. Media type: `multipart/form-data`. Schema: `object`. * `fileData` (_string (binary)_) * `fields` (_array of any_) List of fields for the item. Required to create a SharePoint file in a repository because the file name is required; otherwise optional _Available in: v35.0_ * `itemTypeId` (_string_) ID of the item type, such as `L3NpdGVzL0FDRVRfRklMRUNPTk5FQ1RfSU5U:5f33e0f4-b33c-4127-b9e4-dd5a73dd2f1b:0c847e7c-d4a2-4136-bfda-c468fae2d087:0x0101`. To get the `itemTypeId`, use the [Files Connect Repository Folder Allowed Item Types](/docs/platform/connect-rest-api/references/connect-rest-api-files#tag/Files-Connect-Repository-Resources/operation/getContentHubFolderAllowedItemTypes) resource. Required to create a file in a repository _Available in: v35.0_ _Example: example\_1_ Payload 1 ``` { "itemTypeId": "L3NpdGVzL0FDRVRfRklMRUNPTk5FQ1RfSU5U:5f33e0f4-b33c-4127-b9e4-dd5a73dd2f1b:0c847e7c-d4a2-4136-bfda-c468fae2d087:0x0101", "fields": [ { "name": "name", "value": "Content Hub Simple Create Specs" }, { "name": "description", "value": "Document explaining the various connect api endpoints required for simple create" } ] } ``` #### Responses * **200** _Repository File Detail_ Detailed description of a repository file. Media type: `application/json`. Schema: `RepositoryFileDetail`. ### GET Files Connect Repository File Content `GET /connect/content-hub/repositories/{repositoryId}/files/{repositoryFileId}/content` Operation ID: `getContentHubRepositoryFileContent`. Tags: Files Connect Repository Resources. Return the content of the repository file from the external system. The content is streamed as the body of the response. Get the content of the repository file from the external system. The content is streamed as the body of the response. **Note**: The Experience Cloud site path (`/connect/communities/{communityId}/...`) is available in version 35.0 and later. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/files/{repositoryFileId}/content` _Available in: v32.0_ #### Parameters * `repositoryFileId` (path, string, required) ID of the repository file. * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. #### Responses * **200** Binary stream of the file content. Media type: `application/octet-stream`. Schema: `string (binary)`. Binary stream of the file content. Type: `string (binary)`. ### GET Files Connect Repository File Previews `GET /connect/content-hub/repositories/{repositoryId}/files/{repositoryFileId}/previews` Operation ID: `getContentHubFilePreviewCollection`. Tags: Files Connect Repository Resources. Repository file previews Get information about a repository file's supported previews. File previews are supported only for Google Drive. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/files/{repositoryFileId}/previews` _Available in: v36.0_ #### Parameters * `repositoryFileId` (path, string, required) ID of the repository file. * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. #### Responses * **200** _File Preview Collection_ A collection of file previews. Media type: `application/json`. Schema: `FilePreviewCollectionContenthub`. ### GET Files Connect Repository File Preview `GET /connect/content-hub/repositories/{repositoryId}/files/{repositoryFileId}/previews/{formatType}` Operation ID: `getContentHubFilePreview`. Tags: Files Connect Repository Resources. Repository file preview of a given format Get a repository file preview or a specific page in a preview. File previews are supported only for Google Drive. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/files/{repositoryFileId}/previews/{formatType}` _Available in: v36.0_ #### Parameters * `formatType` (path, ConnectFilePreviewFormatEnumContenthub, required) The file preview format. Hyperforce doesn’t support the SVG file preview format. Any org hosted on Hyperforce defaults to JPG file preview format regardless of the org preference in Setup. * `repositoryFileId` (path, string, required) ID of the repository file. * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. * `endPageNumber` (query, integer) The ending page number in the range of file preview URLs. _Available in: v36.0_ * `startPageNumber` (query, integer) The starting page number in the range of file preview URLs. _Available in: v36.0_ #### Responses * **200** _File Preview_ A file preview. Media type: `application/json`. Schema: `FilePreviewContenthub`. ### GET Files Connect Repository Folder `GET /connect/content-hub/repositories/{repositoryId}/folders/{repositoryFolderId}` Operation ID: `getContentHubRepositoryFolder`. Tags: Files Connect Repository Resources. Repository folder. Get information about a repository folder. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/folders/{repositoryFolderId}` _Available in: v38.0_ #### Parameters * `repositoryFolderId` (path, string, required) The ID of the repository folder. * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. #### Responses * **200** _Repository Folder Detail_ Details of a repository folder. Media type: `application/json`. Schema: `RepositoryFolderDetail`. ### GET Files Connect Repository Folder Allowed Item Types `GET /connect/content-hub/repositories/{repositoryId}/folders/{repositoryFolderId}/allowed-item-types` Operation ID: `getContentHubFolderAllowedItemTypes`. Tags: Files Connect Repository Resources. Allowed Item Types are a collection of item types which are allowed to be created in a folder under a repository. The item type definition may not always contain the field definition when using this end point. To get the properties of a item type you should call the get on /item by passing in the item id. Returns item types that are allowed to be created in the repository folder. To get information about a specific item type, use the [Files Connect Repository Item Type](/docs/platform/connect-rest-api/references/connect-rest-api-files#tag/Files-Connect-Repository-Resources/operation/getContentHubItemType) resource. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/folders/{repositoryFolderId}/allowed-item-types` _Available in: v35.0_ #### Parameters * `repositoryFolderId` (path, string, required) The ID of the repository folder. * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. * `filter` (query, FilesConnectItemTypeEnum) Specifies the item types. Values are: * `Any` —Includes files and folders. * `FilesOnly` —Includes files only. * `FoldersOnly` —Includes folders only. In version 35.0, specify `FilesOnly` . _Available in: v35.0_ #### Responses * **200** _Files Connect Allowed Item Type Collection_ The item types allowed to be created in the repository folder. Media type: `application/json`. Schema: `FilesConnectAllowedItemTypeCollection`. ### GET Files Connect Repository Folder Items `GET /connect/content-hub/repositories/{repositoryId}/folders/{repositoryFolderId}/items` Operation ID: `getContentHubRepositoryFolderItems`. Tags: Files Connect Repository Resources. Collection of items in a repository folder. Get information about the files and folders in a repository folder. **Note**: The Experience Cloud site path (`/connect/communities/{communityId}/...`) is available in version 35.0 and later. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/folders/{repositoryFolderId}/items` _Available in: v32.0_ #### Parameters * `repositoryFolderId` (path, string, required) The ID of the repository folder. * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. _Available in: v32.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are between 1 and 100. If you pass in `null`, the default is 25. _Available in: v32.0_ #### Responses * **200** _Repository Folder Items Collection_ A collection of repository folder items. Media type: `application/json`. Schema: `RepositoryFolderItemsCollection`. ### POST Files Connect Repository Folder Items `POST /connect/content-hub/repositories/{repositoryId}/folders/{repositoryFolderId}/items` Operation ID: `postContentHubRepositoryFolderItems`. Tags: Files Connect Repository Resources. Collection of items in a repository folder. Create a file in a repository folder. Uploads to repositories are limited to 75 MB. Before you create an item in a repository folder, check to see which item types you’re allowed to create. Use the [Files Connect Repository Folder Allowed Item Types](/docs/platform/connect-rest-api/references/connect-rest-api-files#tag/Files-Connect-Repository-Resources/operation/getContentHubFolderAllowedItemTypes) resource. To upload a file, send it in a multipart/form-data request. You can include metadata for the file in the multipart/form-data request as a JSON or XML request body. For information about how to create the multipart/form-data message, see [Uploading Binary Files](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). **Note**: The Experience Cloud site path (`/connect/communities/{communityId}/...`) is available in version 35.0 and later. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/folders/{repositoryFolderId}/items` _Available in: v32.0_ #### Parameters * `repositoryFolderId` (path, string, required) The ID of the repository folder. * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. #### Request body The item type ID and fields of the item type. Media type: `multipart/form-data`. Schema: `object`. * `file` (_FilesConnectItemInput_) * `fileData` (_string (binary)_) * `fields` (_array of any_) List of fields for the item. Required to create a SharePoint file in a repository because the file name is required; otherwise optional _Available in: v35.0_ * `itemTypeId` (_string_) ID of the item type, such as `L3NpdGVzL0FDRVRfRklMRUNPTk5FQ1RfSU5U:5f33e0f4-b33c-4127-b9e4-dd5a73dd2f1b:0c847e7c-d4a2-4136-bfda-c468fae2d087:0x0101`. To get the `itemTypeId`, use the [Files Connect Repository Folder Allowed Item Types](/docs/platform/connect-rest-api/references/connect-rest-api-files#tag/Files-Connect-Repository-Resources/operation/getContentHubFolderAllowedItemTypes) resource. Required to create a file in a repository _Available in: v35.0_ _Example example\_1: same as PATCH /connect/content-hub/repositories/{repositoryId}/files/{repositoryFileId} request._ Payload 1 _Example: example\_1_ Payload 1 #### Responses * **200** _Repository Folder Item_ Description of a folder item. Media type: `application/json`. Schema: `RepositoryFolderItem`. #### Code samples _Example: Example 1 · HTTP_ ``` # This example creates a file and uploads it to an external repository. The # example shows the body parts in a multipart/form-data request. The first body # part is a Files Connect Item Input request body. The second is the content of # the file. For more information, see [Uploading Binary # Files](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). POST /services/data/v67.0/connect/content-hub/repositories/0XCxx000000002CGAQ/ folders/folder:0Bz0nXuFg43SiflFNdFNIaUJrY2hQaHVIVHMxYVpHd2ZHeXphTW83TElzcE84RUJ2Q3Q4Rm8/items Authorization: OAuth 00DD0000000Jhd2!AQIAQC.lh4qTQcBhOPm4TZom5IaOOZLVPVK4wI_rPYJvmE8r2VW8XA. OZ7S29JEM_7Ctq1lst2dzoV.owisJc0KacUbDxyae User-Agent: Jakarta Commons-HttpClient/3.0.1 Host: instance_name Content-Length: 489 Content-Type: multipart/form-data; boundary=a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq Accept: application/json --a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq Content-Type: application/json Content-Disposition: form-data; name="json" { "itemTypeId" : "L3NpdGVzL0FDRVRfRklMRUNPTk5FQ1RfSU5U:5f33e0f4-b33c-4127-b9e4-dd5a73dd2f1b:0c847e7c-d4a2-4136-bfda-c468fae2d087:0x0101", "fields" : [ { "name" : "name", "value" : "Items Sharepoint 012.png" }, { "name" : "description", "value" : "This is a test file" }] } --a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq Content-Disposition: form-data; name="fileData"; filename="items_Sharepoint_012.png" Content-Type: image/png ...PNG... --a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq-- ``` ### GET Files Connect Repository Item Type `GET /connect/content-hub/repositories/{repositoryId}/item-types/{repositoryItemTypeId}` Operation ID: `getContentHubItemType`. Tags: Files Connect Repository Resources. The information related to an individual item type associated with an external repository. The information returned consists of whether the item type requires and supports content, if the item type is versionable etc, and also a collection of field information which is the properties that can be set as part of the metadata of this item type. Returns information about an item type associated with a repository. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/item-types/{repositoryItemTypeId}` _Available in: v35.0_ #### Parameters * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. * `repositoryItemTypeId` (path, string, required) The ID of the repository item type. #### Responses * **200** _Files Connect Item Type Detail_ Detailed information about an item type associated with a repository folder. The Files Connect Item Type Detail response body includes all the Files Connect Item Type Summary response body and this property. Media type: `application/json`. Schema: `FilesConnectItemTypeDetail`. ### GET Files Connect Repository Permissions `GET /connect/content-hub/repositories/{repositoryId}/items/{repositoryItemId}/permissions` Operation ID: `getContentHubPermissionCollection`. Tags: Files Connect Repository Resources. Collection of permissions of an external repository. Get the permissions of a repository file. Managing external file permissions is supported for Google Drive, SharePoint Online, and OneDrive for Business. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/items/{repositoryItemId}/permissions` _Available in: v35.0_ #### Parameters * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. * `repositoryItemId` (path, string, required) The `{repositoryItemId}` must be a file ID. #### Responses * **200** _Files Connect Permission Collection_ A collection of permissions. Media type: `application/json`. Schema: `FilesConnectPermissionCollection`. ### PATCH Files Connect Repository Permissions `PATCH /connect/content-hub/repositories/{repositoryId}/items/{repositoryItemId}/permissions` Operation ID: `patchContentHubPermissionCollection`. Tags: Files Connect Repository Resources. Collection of permissions of an external repository. Update the permissions of a repository file. Managing external file permissions is supported for Google Drive, SharePoint Online, and OneDrive for Business. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/items/{repositoryItemId}/permissions` _Available in: v35.0_ #### Parameters * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. * `repositoryItemId` (path, string, required) The `{repositoryItemId}` must be a file ID. #### Request body A collection of permissions to apply or remove. Media type: `application/json`. Schema: `FilesConnectPermissionCollectionInput`. _Example: example\_1_ Payload 1 ``` { "permissionsToApply": [ { "directoryEntryId": "Anyone", "permissionTypesIds": [ "CanView" ] } ], "permissionsToRemove": [ { "directoryEntryId": "AnyoneInMyDomain", "permissionTypesIds": [ "CanDelete", "CanEdit" ] } ] } ``` #### Responses * **200** _Files Connect Permission Collection_ A collection of permissions. Media type: `application/json`. Schema: `FilesConnectPermissionCollection`. ### GET Files Connect Repository Permission Types `GET /connect/content-hub/repositories/{repositoryId}/items/{repositoryItemId}/permissions/types` Operation ID: `getContentHubPermissionTypeCollection`. Tags: Files Connect Repository Resources. Collection of permission types of an external repository. Get the permission types of a repository file. Managing external file permissions is supported for Google Drive, SharePoint Online, and OneDrive for Business. #### Experience Cloud site path `/connect/communities/{communityId}/content-hub/repositories/{repositoryId}/items/{repositoryItemId}/permissions/types` _Available in: v35.0_ #### Parameters * `repositoryId` (path, string (Id), required) ID of a repository. Pattern: ^(0XC)\\w\*. * `repositoryItemId` (path, string, required) The `{repositoryItemId}` must be a file ID. #### Responses * **200** _Repository Permission Type Collection_ A collection of permission types. Media type: `application/json`. Schema: `RepositoryPermissionTypeCollection`. ### GET Asset Files, Batch `GET /connect/file-assets/batch/{assetIds}` Operation ID: `getFileAssetBatch`. Tags: Files Resources. Return details about the specified asset Ids Get information about a comma-separated list of up to 100 asset files. _Available in: v43.0_ #### Experience Cloud site path `/connect/communities/{communityId}/file-assets/batch/{assetIds}` _Available in: v43.0_ #### Parameters * `assetIds` (path, array of string (Id), required) Comma-separated list of asset IDs. #### Responses * **200** _Batch Results_ Batch results. Media type: `application/json`. Schema: `Batch`. ### GET Asset File Information `GET /connect/file-assets/{assetId}` Operation ID: `getFileAsset`. Tags: Files Resources. Return details about the specified asset. Get information about an asset file. _Available in: v38.0_ #### Experience Cloud site path `/connect/communities/{communityId}/file-assets/{assetId}` _Available in: v38.0_ #### Parameters * `assetId` (path, string (Id), required) ID of the asset. Pattern: ^(03S)\\w\*. #### Responses * **200** _File Detail_ Success Media type: `application/json`. Schema: `FileDetail`. ### PATCH Asset File Information `PATCH /connect/file-assets/{assetId}` Operation ID: `patchFileAsset`. Tags: Files Resources. Return details about the specified asset. Change the visibility of an asset file for unauthenticated users. _Available in: v43.0_ #### Experience Cloud site path `/connect/communities/{communityId}/file-assets/{assetId}` _Available in: v43.0_ #### Parameters * `assetId` (path, string (Id), required) ID of the asset. Pattern: ^(03S)\\w\*. #### Request body Media type: `application/json`. Schema: `FileAssetInput`. _Example: example\_1_ Payload 1 ``` { "isVisibleByExternalUsers": "true" } ``` #### Responses * **200** _File Detail_ Success Media type: `application/json`. Schema: `FileDetail`. ### GET Asset File Content `GET /connect/file-assets/{fullyQualifiedName}/content` Operation ID: `getFileAssetContent`. Tags: Files Resources. Return the content of the asset file. The content is streamed as the body of the response. Get the streamed content of an asset file. _Available in: v42.0_ #### Experience Cloud site path `/connect/communities/{communityId}/file-assets/{fullyQualifiedName}/content` _Available in: v42.0_ #### Parameters * `fullyQualifiedName` (path, string, required) The `{fullyQualifiedName}` is the namespace prefix, if there is one, followed by the developer name of the ContentAsset. * `versionNumber` (query, integer) Specify an existing version number for the file. If not specified, the latest version is returned. _Available in: v42.0_ #### Responses * **200** Binary stream of the content Media type: `application/octet-stream`. Schema: `string (binary)`. Binary stream of the content Type: `string (binary)`. ### GET Asset File Rendition `GET /connect/file-assets/{fullyQualifiedName}/rendition` Operation ID: `getFileAssetRendition`. Tags: Files Resources. Return the rendition of the asset file. Get up to 25 streamed renditions of an asset file. A rendition is a binary preview of the file. _Available in: v42.0_ #### Experience Cloud site path `/connect/communities/{communityId}/file-assets/{fullyQualifiedName}/rendition` _Available in: v42.0_ #### Parameters * `fullyQualifiedName` (path, string, required) The `{fullyQualifiedName}` is the namespace prefix, if there is one, followed by the developer name of the ContentAsset. * `format` (query, string) Specify the format of the file, either `jpg` or `png`. If unspecified, BMP and JPG files default to JPG, and PNG files default to PNG. _Available in: v60.0_ * `height` (query, integer) Specify the height of the image file in pixels. You must specify a dimension greater than 24 pixels and smaller than the original image dimension. You can specify up to 25 image dimension combinations. If only height or width is specified, the original image dimension is returned. _Available in: v42.0_ * `versionNumber` (query, integer) Specify an existing version number for the file. If not specified, the latest version is returned. _Available in: v42.0_ * `width` (query, integer) Specify the width of the image file in pixels. You must specify a dimension greater than 24 pixels and smaller than the original image dimension. You can specify up to 25 image dimension combinations. If only height or width is specified, the original image dimension is returned. _Available in: v42.0_ #### Responses * **200** Binary stream of the rendition Media type: `application/octet-stream`. Schema: `string (binary)`. Binary stream of the rendition Type: `string (binary)`. ### GET File Upload Config `GET /connect/file/upload/config` Operation ID: `getFileUploadConfig`. Tags: Files Resources. This API allows to get the File Upload Config Get the file upload config. _Available in: v62.0_ #### Responses * **200** _File Upload Config_ File upload config. Media type: `application/json`. Schema: `FileUploadConfig`. ### GET File Information, Batch `GET /connect/files/batch/{fileIds}` Operation ID: `getFileBatch`. Tags: Files Resources. A list of files, specified by file IDs. Get information about a list of files. _Available in: v36.0_ #### Parameters * `fileIds` (path, array of string (Id), required) The number of file IDs you can specify is limited by the length of the URL. In general, you can specify up to 100 file IDs in a comma-separated list. #### Responses * **200** _Batch Result Item_ Batch result item. Media type: `application/json`. Schema: `Batch`. ### DELETE File Information, Batch `DELETE /connect/files/batch/{fileIds}` Operation ID: `deleteFileBatch`. Tags: Files Resources. A list of files, specified by file IDs. Delete a list of files. _Available in: v36.0_ #### Parameters * `fileIds` (path, array of string (Id), required) The number of file IDs you can specify is limited by the length of the URL. In general, you can specify up to 100 file IDs in a comma-separated list. #### Responses * **200** _Batch Result Item_ Batch result item. ### POST File Content Body `POST /connect/files/content-body` Operation ID: `postFileContentBody`. Tags: Files Resources. Creates a ContentBody record for either a single-shot or chunked file upload. Create a ContentBody. Provide binary data to create the ContentBody immediately. Provide `fullFileSize` without binary data to start a chunked upload session. Upload each binary chunk from the response to [File Content Body Chunk](/docs/platform/connect-rest-api/references/connect-rest-api-files#tag/Files-Resources/operation/postFileContentBodyChunked) to get the completed ContentBody. Create the ContentVersion by referencing the completed `contentBodyId` in the request schema for [File Information](/docs/platform/connect-rest-api/references/connect-rest-api-files#tag/Files-Resources/operation/postFileDetail). _Available in: v68.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/content-body` _Available in: v68.0_ #### Parameters * `fileName` (query, string, required) Name of the file. _Available in: v68.0_ * `fullFileSize` (query, number (int64)) Total file size in bytes. Provide without binary data to initiate a chunked upload session. _Available in: v68.0_ #### Request body Media type: `multipart/form-data`. Schema: `object`. * `data` (_string (binary)_) * `file` (_FileBodyInput_) _Available in: v68.0_ #### Responses * **200** _File Body_ Representation of a blob in a content body. Media type: `application/json`. Schema: `FileBody`. ### POST File Content Body Chunk `POST /connect/files/content-body/{contentBodyId}/chunked` Operation ID: `postFileContentBodyChunked`. Tags: Files Resources. Uploads one binary chunk to a partial ContentBody created by a chunked upload session. Upload a chunk of binary data that was created with [File Content Body](/docs/platform/connect-rest-api/references/connect-rest-api-files#tag/Files-Resources/operation/postFileContentBody). Set `complete=true` on the last chunk to finalize the blob. Create the ContentVersion by referencing the completed `contentBodyId` in the request schema for [File Information](/docs/platform/connect-rest-api/references/connect-rest-api-files#tag/Files-Resources/operation/postFileDetail). _Available in: v68.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/content-body/{contentBodyId}/chunked` _Available in: v68.0_ #### Parameters * `contentBodyId` (path, string (Id), required) ID of the content body returned from the POST request to `/connect/files/content-body`. Pattern: ^(05T)\\w\*. * `chunkNumber` (query, integer, required) Ordinal position of the chunk in the upload session, starting with 1. _Available in: v68.0_ * `complete` (query, boolean) Set to `true` on the last chunk to finalize the blob. _Available in: v68.0_ #### Request body Media type: `multipart/form-data`. Schema: `object`. * `chunkData` (_string (binary)_, required) Binary data for this chunk. _Available in: v68.0_ #### Responses * **200** _File Body_ Representation of a blob in a content body. Media type: `application/json`. Schema: `FileBody`. ### GET Users Files, General `GET /connect/files/users/{userId}` Operation ID: `getUserFilesCollection`. Tags: User Files Resources. List, search, and create files in a user's file share. Get information about files that a user owns. These files don’t include files shared with a user, files a user follows, or general organization files. **Important**: This resource can return a large amount of data and, when it does, takes some time to process. **Note**: In versions 24.0–35.0, use `/chatter/users/{userId}/files` and `/connect/communities/{communityId}/chatter/users/{userId}/files`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/users/{userId}` _Available in: v36.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25. * `q` (query, string) A query string to filter the results. The string must contain at least two characters, not including wildcards. For information about wildcards, see [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards). #### Responses * **200** _File Summary Page_ Success Media type: `application/json`. Schema: `FileSummaryPage`. ### POST Users Files, General `POST /connect/files/users/{userId}` Operation ID: `postUserFilesCollection`. Tags: User Files Resources. List, search, and create files in a user's file share. Upload a file, including references to external files, to the Files home. When you upload a file to the Files home, it is private and available only to the file owner. To upload a file, send it in a multipart/form-data request. You can include the description and title of the file in the multipart/form-data request as a JSON or XML request body. You can also send the information as request parameters. For information about how to create the multipart/form-data message, see [Uploading Binary Files](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). To upload multiple files in the same call, see [Batch Resource](/docs/platform/connect-rest-api/references/connect-rest-api-core#tag/Batch-Resources/operation/postGenericBatch). **Important**: This resource can return a large amount of data and, when it does, takes some time to process. **Note**: In versions 24.0–35.0, use `/chatter/users/{userId}/files` and `/connect/communities/{communityId}/chatter/users/{userId}/files`, which require Chatter. **Note**: POST is available to guest users in version 62.0 and later. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/users/{userId}` _Available in: v36.0_ #### Parameters * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. * `contentModifiedDate` (query, string) File-specific last modified date that can be used to set a client-side modified date. Specify the date in ISO 8601 format. _Available in: v32.0_ * `desc` (query, string) Description of the file _Available in: v24.0_ * `includeExternalFilePermissionsInfo` (query, boolean) Specifies whether to include permission information, such as whether the file is shared and what are the available permission types, for external files. _Available in: v35.0_ * `isDataSync` (query, boolean) An automated client generates the request. _Available in: v31.0_ * `isInMyFileSync` (query, boolean) `true` if the file is synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v31.0_ * `isMajorVersion` (query, boolean) `true` if the file is a major version; `false` if the file is a minor version. Major versions can’t be replaced. The default value is `false`. _Available in: v31.0_ * `repositoryFileId` (query, string) ID of the external file. _Available in: v32.0_ * `repositoryFileUri` (query, string) URI of the external file, such as `https://drive.google.com/file/d/0B7a_ei8brT1TMy1CQ0o5NmZQNEE/view`. _Available in: v39.0_ * `repositoryId` (query, string) ID of the external data source. Required if `repositoryFileId` is specified. Otherwise, Optional. _Available in: v32.0_ * `reuseReference` (query, boolean) Specifies whether to reuse the latest version of a reference you own to an external file rather than creating a duplicate reference. _Available in: v36.0_ * `sharingOption` (query, string) Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v35.0_ * `sharingPrivacy` (query, string) Sharing privacy of a file. Values are: * `None` — File is visible to anyone with record access. * `PrivateOnRecords` — File is private on records. _Available in: v41.0_ * `title` (query, string) Title of the file _Available in: v24.0_ #### Request body _Available in: v32.0_ Media type: `multipart/form-data`. Schema: `object`. * `fileData` (_string (binary)_) * `contentBodyId` (_string_) ID of the content body. _Available in: v62.0_ * `contentModifiedDate` (_string_) File-specific last modified date that can be used to set a client-side modified date. Specify the date in ISO 8601 format. _Available in: v32.0_ * `desc` (_string_) Description of the file to be uploaded. _Available in: v24.0_ * `fieldName` (_string_) Name of a custom field on the ContentVersion object. The API name of the customer field must end with `fileupload__c`. _Available in: v62.0_ * `fieldValue` (_string_) Value to store for the custom field specified in `fieldName` for the uploaded file. _Available in: v62.0_ * `firstPublishLocationId` (_string_) ID of the location where the version was first published. _Available in: v62.0_ * `includeExternalFilePermissionsInfo` (_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}.` _Available in: v35.0_ * `isInMyFileSync` (_boolean_) `true` if the file is synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v31.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. _Available in: v31.0_ * `networkId` (_string_) ID of the Experience Cloud site where this file originated. _Available in: v62.0_ * `parentFolderId` (_string_) ID of the containing folder. _Available in: v31.0_ * `pathOnClient` (_string_) Complete path of the file. _Available in: v62.0_ * `repositoryFileId` (_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`. _Available in: v32.0_ * `repositoryFileUri` (_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 specify `repositoryFileUri`, don’t specify `repositoryFileId`. _Available in: v39.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. _Available in: v32.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}.` _Available in: v36.0_ * `sharingOption` (_string_) Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v35.0_ * `sharingPrivacy` (_string_) Sharing privacy of a file. Values are: * `None` — File is visible to anyone with record access. * `PrivateOnRecords` — File is private on records. _Available in: v41.0_ * `title` (_string_) Title of the file. _Available in: v24.0_ _Example: example\_1_ Payload 1 Creating a file ``` { "desc": "Employee Survey Results", "title": "emp_surv_results" } ``` _Example: example\_2_ Payload 2 Creating a reference to an external file ``` { "repositoryId": "0XCB00000004CHJ", "repositoryFileId": "document:1AnPHWYq_j56yryuRbxiVp93rD2qGqNWx7yZHvidxDpQ" } ``` #### Responses * **200** _File Summary_ Description of a file. For all rendition properties, note the following: For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. Media type: `application/json`. Schema: `FileDetail`. #### Code samples _Example: Example 1 · HTTP_ ``` { "contentBodyId": "05Txx0000004CH6EAM", "title": "Screenshot 2024-06-17 at 6.24.49 PM", "networkId": "0DBxx0000004CH6GAM", “pathOnClient”: ”Screenshot 2024-06-17 at 6.24.49 PM.png”, "firstPublishLocationId": null, "fieldName": "Guest_Record_Main_fileupload__c", "fieldValue": "Version1" } Content-Type: application/json { "desc": "Employee Survey Results", "title": "emp_surv_results" } ``` _Example: Example 2 · HTTP_ ``` { "contentBodyId": "05Txx0000004CH6EAM", "title": "Screenshot 2024-06-17 at 6.24.49 PM", "networkId": "0DBxx0000004CH6GAM", “pathOnClient”: ”Screenshot 2024-06-17 at 6.24.49 PM.png”, "firstPublishLocationId": null, "fieldName": "Guest_Record_Main_fileupload__c", "fieldValue": "Version1" } Content-Type: application/json { "repositoryId": "0XCB00000004CHJ", "repositoryFileId": "document:1AnPHWYq_j56yryuRbxiVp93rD2qGqNWx7yZHvidxDpQ" } ``` _Example: Example 3 · HTTP_ ``` # This example creates a file and uploads it to Salesforce. The example shows # the body parts in a multipart/form-data request. The first body part is a File # Input request body. The second is the content of the file. For more # information, see [Uploading Binary Files](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). POST /services/data/v67.0/connect/files/users/me Authorization: OAuth 00DD0000000Jhd2!AQIAQC.lh4qTQcBhOPm4TZom5IaOOZLVPVK4wI_rPYJvmE8r2VW8XA. OZ7S29JEM_7Ctq1lst2dzoV.owisJc0KacUbDxyae User-Agent: Jakarta Commons-HttpClient/3.0.1 Host: instance_name Content-Length: 489 Content-Type: multipart/form-data; boundary=a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq Accept: application/json --a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq Content-Type: application/json; charset=UTF-8 Content-Disposition: form-data; name="json" { "title":"BoatPrices" } --a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq Content-Disposition: form-data; name="fileData"; filename="BoatPrices.txt" Content-Type: application/octet-stream; charset=ISO-8859-1 ...contents of BoatPrices.txt... --a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq-- Content-Type: application/json { "desc": "Employee Survey Results", "title": "emp_surv_results" } ``` _Example: Example 4 · HTTP_ ``` # This example creates a file and uploads it to Salesforce. The example shows # the body parts in a multipart/form-data request. The first body part is a File # Input request body. The second is the content of the file. For more # information, see [Uploading Binary Files](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). POST /services/data/v67.0/connect/files/users/me Authorization: OAuth 00DD0000000Jhd2!AQIAQC.lh4qTQcBhOPm4TZom5IaOOZLVPVK4wI_rPYJvmE8r2VW8XA. OZ7S29JEM_7Ctq1lst2dzoV.owisJc0KacUbDxyae User-Agent: Jakarta Commons-HttpClient/3.0.1 Host: instance_name Content-Length: 489 Content-Type: multipart/form-data; boundary=a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq Accept: application/json --a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq Content-Type: application/json; charset=UTF-8 Content-Disposition: form-data; name="json" { "title":"BoatPrices" } --a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq Content-Disposition: form-data; name="fileData"; filename="BoatPrices.txt" Content-Type: application/octet-stream; charset=ISO-8859-1 ...contents of BoatPrices.txt... --a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq-- Content-Type: application/json { "repositoryId": "0XCB00000004CHJ", "repositoryFileId": "document:1AnPHWYq_j56yryuRbxiVp93rD2qGqNWx7yZHvidxDpQ" } ``` ### GET User Files, Filtered by Sharing or Groups `GET /connect/files/users/{userId}/filter/{filterType}` Operation ID: `getUserFilesCollection_-1390363905`. Tags: User Files Resources. List, search, and create files in a user's file share. Get information about files that are shared with the context user. Get information about files that are posted to groups that the context user is a member of. _Available in: v36.0_ **Note**: In versions 24.0–36.0, use `/chatter/users/{userId}/files/filter/{filterType}` and `/connect/communities/{communityId}/chatter/users/{userId}/files/filter/{filterType}`, which require Chatter. #### Experience Cloud site path `/connect/communities/{communityId}/files/users/{userId}/filter/{filterType}` #### Parameters * `filterType` (path, ConnectUserFilesFilterType, required) The filter type. Use `groups` to filter the files to those that are posted to groups that the context user is a member of. Use `shared-with-me` or `sharedwithme` to filter the files to those that are shared with the context user. * `userId` (path, string (IdOrMe), required) ID of the user. Pattern: ^(005)\\w\*|me. * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. _Available in: v24.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25. _Available in: v24.0_ * `q` (query, string) A query string to filter the results. The string must contain at least two characters, not including wildcards. For information about wildcards, see [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards). _Available in: v27.0_ #### Responses * **200** _File Summary Page_ File summary page. Media type: `application/json`. Schema: `FileSummaryPage`. ### GET File Information `GET /connect/files/{fileId}` Operation ID: `getFileDetail`. Tags: Files Resources. Return details about the specified file. Can also be used to rename an existing file. Get information about a specified file, including references to external files. **Note**: In versions 24.0–35.0, use `/chatter/files/{fileId}` and `/connect/communities/{communityId}/chatter/files/{fileId}`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. * `versionNumber` (query, integer) Specify an existing version number for the file. If not specified, the latest version is returned. _Available in: v23.0_ #### Responses * **200** _File Detail_ Includes all the File Summary response body with these additional items. Media type: `application/json`. Schema: `FileDetail`. ### POST File Information `POST /connect/files/{fileId}` Operation ID: `postFileDetail`. Tags: Files Resources. Return details about the specified file. Can also be used to rename an existing file. Upload a new version of an existing file, including references to external files. To upload a new version of an existing file, make a POST request. Upload the new version as a binary part in a multipart/form-data request. See [Inputs and Binary File Upload Examples](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files). To upload a new file to the Files home, use [`/connect/files/users/me`](/docs/platform/connect-rest-api/references/connect-rest-api-files#tag/User-Files-Resources/operation/getUserFilesCollection). **Note**: In versions 24.0–35.0, use `/chatter/files/{fileId}` and `/connect/communities/{communityId}/chatter/files/{fileId}`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. * `desc` (query, string) Description of the file to be uploaded. _Available in: v26.0_ * `isDataSync` (query, boolean) Indicates whether an automated client generates the request. _Available in: v31.0_ * `isInMyFileSync` (query, boolean) `true` if the file is synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v31.0_ * `isMajorVersion` (query, boolean) `true` if the file is a major version; `false` if the file is a minor version. Major versions can’t be replaced. _Available in: v31.0_ * `sharingOption` (query, string) Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v35.0_ * `sharingPrivacy` (query, string) Sharing privacy of a file. Values are: * `None` — File is visible to anyone with record access. * `PrivateOnRecords` — File is private on records. _Available in: v41.0_ * `title` (query, string) Title of the file. _Available in: v26.0_ #### Request body _Available in: v26.0_ Media type: `multipart/form-data`. Schema: `object`. * `fileData` (_string (binary)_) * `contentBodyId` (_string_) ID of the content body. _Available in: v62.0_ * `contentModifiedDate` (_string_) File-specific last modified date that can be used to set a client-side modified date. Specify the date in ISO 8601 format. _Available in: v32.0_ * `desc` (_string_) Description of the file to be uploaded. _Available in: v24.0_ * `fieldName` (_string_) Name of a custom field on the ContentVersion object. The API name of the customer field must end with `fileupload__c`. _Available in: v62.0_ * `fieldValue` (_string_) Value to store for the custom field specified in `fieldName` for the uploaded file. _Available in: v62.0_ * `firstPublishLocationId` (_string_) ID of the location where the version was first published. _Available in: v62.0_ * `includeExternalFilePermissionsInfo` (_boolean_) This property can be used with POST requests to `/connect/files/users/{userId}`, but not with POST requests to `/connect/files/{fileId}.` _Available in: v35.0_ * `isInMyFileSync` (_boolean_) _Available in: v31.0_ * `isMajorVersion` (_boolean_) _Available in: v31.0_ * `networkId` (_string_) ID of the Experience Cloud site where this file originated. _Available in: v62.0_ * `parentFolderId` (_string_) ID of the containing folder. _Available in: v31.0_ * `pathOnClient` (_string_) Complete path of the file. _Available in: v62.0_ * `repositoryFileId` (_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`. _Available in: v32.0_ * `repositoryFileUri` (_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 specify `repositoryFileUri`, don’t specify `repositoryFileId`. _Available in: v39.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. _Available in: v32.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}.` _Available in: v36.0_ * `sharingOption` (_string_) Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v35.0_ * `sharingPrivacy` (_string_) Sharing privacy of a file. Values are: * `None` — File is visible to anyone with record access. * `PrivateOnRecords` — File is private on records. _Available in: v41.0_ * `title` (_string_) Title of the file. _Available in: v24.0_ #### Responses * **200** _File Detail_ Includes all the File Summary response body with these additional items. Media type: `application/json`. Schema: `FileDetail`. #### Code samples _Example: Example 1 · HTTP_ ``` { "desc" : "Employee Survey Results", "title" : "emp_surv_results" } ``` ### DELETE File Information `DELETE /connect/files/{fileId}` Operation ID: `deleteFileDetail`. Tags: Files Resources. Return details about the specified file. Can also be used to rename an existing file. Delete a file. **Note**: In versions 24.0–35.0, use `/chatter/files/{fileId}` and `/connect/communities/{communityId}/chatter/files/{fileId}`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. #### Responses * **204** _Successful Delete_ Success ### PATCH File Information `PATCH /connect/files/{fileId}` Operation ID: `patchFileDetail`. Tags: Files Resources. Return details about the specified file. Can also be used to rename an existing file. Rename a file and move a file to a different folder. **Note**: In versions 24.0–35.0, use `/chatter/files/{fileId}` and `/connect/communities/{communityId}/chatter/files/{fileId}`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. * `desc` (query, string) A new description for the file _Available in: v32.0_ * `isArchived` (query, boolean) Specifies if the file is archived (`true`) or not (`false`). _Available in: v68.0_ * `isInMyFileSync` (query, boolean) `true` if the file is synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v31.0_ * `parentFolderId` (query, string) ID of the containing folder _Available in: v31.0_ * `sharingOption` (query, string) Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v35.0_ * `sharingPrivacy` (query, string) Sharing privacy of a file. Values are: * `None` — File is visible to anyone with record access. * `PrivateOnRecords` — File is private on records. _Available in: v41.0_ * `title` (query, string) A new title for the file _Available in: v26.0_ #### Request body _Available in: v32.0_ Media type: `application/json`. Schema: `FileInput`. #### Responses * **200** _File Detail_ Includes all the File Summary response body with these additional items. Media type: `application/json`. Schema: `FileDetail`. #### Code samples _Example: Example 1 · HTTP_ ``` # This PATCH request updates the title of a file: PATCH /connect/files/069D00000001FHF?title=A+New+Title ``` ### POST Asset File `POST /connect/files/{fileId}/asset` Operation ID: `makeFileAsset`. Tags: Files Resources. Create new file assets. Create an asset file. _Available in: v38.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}/asset` _Available in: v38.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. * `assetLabel` (query, string) Master label for the asset file. This internal label doesn’t get translated. _Available in: v46.0_ * `developerName` (query, string) Developer name for the asset file. 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 org. _Available in: v46.0_ * `isVisibleByExternalUsers` (query, boolean) Indicates whether unauthenticated users can see the asset file (`true`) or not (`false`). If not specified, the default value is `false`. _Available in: v43.0_ * `shareWithIds` (query, array of string) A list of org IDs, Experience Cloud site IDs, or content workspace IDs with which to share the file. _Available in: v39.0_ #### Responses * **200** _File Detail_ Includes all the File Summary response body with these additional items. Media type: `application/json`. Schema: `FileDetail`. ### GET File Content `GET /connect/files/{fileId}/content` Operation ID: `getFileContent`. Tags: Files Resources. Return the content of the file. The content is streamed as the body of the response. Returns the content of the file, including references to external files. The content is streamed as the body of the response. **Note**: In versions 24.0–35.0, use `/chatter/files/{fileId}/content` and `/connect/communities/{communityId}/chatter/files/{fileId}/content`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}/content` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. * `isDataSync` (query, boolean) Indicates whether an automated client generates the request. _Available in: v31.0_ * `versionNumber` (query, integer) Specify an existing version number for the file. If not specified, the latest version is returned. _Available in: v24.0_ #### Responses * **200** Binary stream of the file content. Media type: `application/octet-stream`. Schema: `string (binary)`. Binary stream of the file content. Type: `string (binary)`. ### GET File Shares `GET /connect/files/{fileId}/file-shares` Operation ID: `getFileShareCollection`. Tags: Files Resources. Returns information about the entities with which the specified file has been shared. Entities can be users, groups, or records. Get the users, groups, or records with which a file has been shared. **Note**: In versions 24.0–35.0, use `/chatter/files/{fileId}/file-shares` and `/connect/communities/{communityId}/chatter/files/{fileId}/file-shares`, which require Chatter. **Note**: In versions 30.0 and later, the first share returned in a GET request is the organization record share. In communities, the first share returned is the network record share. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}/file-shares` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. * `page` (query, integer) An integer greater than 0 specifying a page of topics. The default value is zero. * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 to 100. The default value is 25. #### Responses * **200** _File Shares Page_ Success Media type: `application/json`. Schema: `FileSharesPage`. ### POST File Shares `POST /connect/files/{fileId}/file-shares` Operation ID: `postFileShareCollection`. Tags: Files Resources. Returns information about the entities with which the specified file has been shared. Entities can be users, groups, or records. Share a file with users. **Note**: In versions 24.0–35.0, use `/chatter/files/{fileId}/file-shares` and `/connect/communities/{communityId}/chatter/files/{fileId}/file-shares`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}/file-shares` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. * `id1` (query, string, required) List of up to 9 user IDs to share this file with. This list must match the list of sharing types. * `id2` (query, string) List of up to 9 user IDs to share this file with. This list must match the list of sharing types. * `id3` (query, string) List of up to 9 user IDs to share this file with. This list must match the list of sharing types. * `id4` (query, string) List of up to 9 user IDs to share this file with. This list must match the list of sharing types. * `id5` (query, string) List of up to 9 user IDs to share this file with. This list must match the list of sharing types. * `id6` (query, string) List of up to 9 user IDs to share this file with. This list must match the list of sharing types. * `id7` (query, string) List of up to 9 user IDs to share this file with. This list must match the list of sharing types. * `id8` (query, string) List of up to 9 user IDs to share this file with. This list must match the list of sharing types. * `id9` (query, string) List of up to 9 user IDs to share this file with. This list must match the list of sharing types. * `message` (query, string) Private message body that’s sent to the recipients. If Salesforce Communities is enabled, an email is sent instead of a private message. * `sharingType1` (query, string, required) List of sharing types, either `C` for collaborator or `V` for viewer. This list must match the list of user IDs. * `sharingType2` (query, string) List of sharing types, either `C` for collaborator or `V` for viewer. This list must match the list of user IDs. * `sharingType3` (query, string) List of sharing types, either `C` for collaborator or `V` for viewer. This list must match the list of user IDs. * `sharingType4` (query, string) List of sharing types, either `C` for collaborator or `V` for viewer. This list must match the list of user IDs. * `sharingType5` (query, string) List of sharing types, either `C` for collaborator or `V` for viewer. This list must match the list of user IDs. * `sharingType6` (query, string) List of sharing types, either `C` for collaborator or `V` for viewer. This list must match the list of user IDs. * `sharingType7` (query, string) List of sharing types, either `C` for collaborator or `V` for viewer. This list must match the list of user IDs. * `sharingType8` (query, string) List of sharing types, either `C` for collaborator or `V` for viewer. This list must match the list of user IDs. * `sharingType9` (query, string) List of sharing types, either `C` for collaborator or `V` for viewer. This list must match the list of user IDs. #### Request body Media type: `application/json`. Schema: `FileShareCollectionInput`. _Example: example\_1_ Payload 1 ``` { "message": "I shared a document with you.", "shares": [ { "id": "005D0000001Az4l", "sharingType": "V" }, { "id": "005D0000001B2ny", "sharingType": "C" } ] } ``` #### Responses * **200** _File Shares Page_ Success Media type: `application/json`. Schema: `FileSharesPage`. #### Code samples _Example: Example 1 · HTTP_ ``` # This example uses request parameters to share a file with two users. POST /connect/files/069D00000001JDU/file-shares?id1=005D0000001LL8O&id2=005D0000001QdEL&sharingType1=C&sharingType2=V Content-Type: application/json { "message": "I shared a document with you.", "shares": [ { "id": "005D0000001Az4l", "sharingType": "V" }, { "id": "005D0000001B2ny", "sharingType": "C" } ] } ``` _Example: Example 2 · HTTP_ ``` # Here is the same example using a request body. POST /connect/files/069D00000001JDU/file-shares { "shares": [ { "id": "005D0000001LL8O", "sharingType": "C" }, { "id": "005D0000001QdEL", "sharingType": "V" } ] } Content-Type: application/json { "message": "I shared a document with you.", "shares": [ { "id": "005D0000001Az4l", "sharingType": "V" }, { "id": "005D0000001B2ny", "sharingType": "C" } ] } ``` ### GET Files Shares Link `GET /connect/files/{fileId}/file-shares/link` Operation ID: `getFileShareLink`. Tags: Files Resources. Manages creation, access, and deletion of a file's link share. Get a file’s share link. **Note**: In versions 30.0–35.0, use `/chatter/files/{fileId}/file-shares/link` and `/connect/communities/{communityId}/chatter/files/{fileId}/file-shares/link`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}/file-shares/link` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. #### Responses * **200** _File Share Link_ Success Media type: `application/json`. Schema: `FileShareLink`. ### PUT Files Shares Link `PUT /connect/files/{fileId}/file-shares/link` Operation ID: `putFileShareLink`. Tags: Files Resources. Manages creation, access, and deletion of a file's link share. Create a file’s share link. In v36.0–57.0, PUT requests don’t require a request body and they ignore any request body provided. In v58.0 and later, the File Share Link Input request body is available for PUT requests but isn’t required. **Note**: In versions 30.0–35.0, use `/chatter/files/{fileId}/file-shares/link` and `/connect/communities/{communityId}/chatter/files/{fileId}/file-shares/link`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}/file-shares/link` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. #### Request body File share link input. Media type: `application/json`. Schema: `FileShareLinkInput`. _Example: example\_1_ Payload 1 ``` { "expirationDate": "2024-07-07T23:59:11.168Z", "isPasswordRequired": "true" } ``` #### Responses * **200** _File Share Link_ Success Media type: `application/json`. Schema: `FileShareLink`. ### DELETE Files Shares Link `DELETE /connect/files/{fileId}/file-shares/link` Operation ID: `deleteFileShareLink`. Tags: Files Resources. Manages creation, access, and deletion of a file's link share. Delete a file’s share link. **Note**: In versions 30.0–35.0, use `/chatter/files/{fileId}/file-shares/link` and `/connect/communities/{communityId}/chatter/files/{fileId}/file-shares/link`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}/file-shares/link` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. #### Responses * **204** _Successful Delete_ Success ### GET File Image `GET /connect/files/{fileId}/image` Operation ID: `getImageFile`. Tags: Files Resources. Details for a given Content File Image. Get information about a file image. _Available in: v39.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}/image` _Available in: v39.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. #### Responses * **200** _Image File_ An image file. Media type: `application/json`. Schema: `ImageFile`. ### GET File Previews `GET /connect/files/{fileId}/previews` Operation ID: `getFilePreviewCollection`. Tags: Files Resources. Return detailed information about a file's supported previews. Get information about a file's supported previews. **Note**: In version 35.0, use `/chatter/files/{fileId}/previews` and `/connect/communities/{communityId}/chatter/files/{fileId}/previews`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}/previews` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. * `versionNumber` (query, integer) Version number of the file. Default value is latest version. _Available in: v40.0_ #### Responses * **200** _File Preview Collection_ A collection of file previews. Media type: `application/json`. Schema: `FilePreviewCollection`. ### PATCH File Previews `PATCH /connect/files/{fileId}/previews` Operation ID: `patchFilePreviewCollection`. Tags: Files Resources. Return detailed information about a file's supported previews. Get information about a file's supported previews and generate up to 500 pages in a file preview. **Note**: In version 35.0, use `/chatter/files/{fileId}/previews` and `/connect/communities/{communityId}/chatter/files/{fileId}/previews`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}/previews` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. * `versionNumber` (query, integer) Version number of the file. Default value is latest version. _Available in: v40.0_ #### Responses * **200** _File Preview Collection_ A collection of file previews. Media type: `application/json`. Schema: `FilePreviewCollection`. ### GET File Preview `GET /connect/files/{fileId}/previews/{previewFormat}` Operation ID: `getFilePreview`. Tags: Files Resources. Return detailed information about a specific preview type of a file. Get up to 500 pages in a file preview or get a specific page in a preview. **Note**: Hyperforce doesn’t support the SVG file preview format. Any org hosted on Hyperforce defaults to JPG file preview format regardless of the org preference in Setup. SVG files are generated on demand. Alternatively, you can generate an SVG preview by making a PATCH request to `/connect/files/{fileId}/previews`. **Note**: In version 35.0, use `/chatter/files/{fileId}/previews/{previewFormat}` and `/connect/communities/{communityId}/chatter/files/{fileId}/previews/{previewFormat}`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}/previews/{previewFormat}` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. * `previewFormat` (path, string, required) Supported values for `previewFormat`: * `jpg` — Preview format is JPG. If you’re concerned that feature-rich SVG previews don’t work in your org, choose alternative file previews. To use JPG file previews, enter `general` in the Quick Find box in Setup. Select General Settings, and then select Display alternative file previews. * `pdf` — Preview format is PDF. PDF previews are available for files of type DOC, DOCX, PPT, PPTX, TEXT, XLS, and XLSX. If you need a PDF preview for files of type PDF, call the download version using the File Content resource. * `svg` — Preview format is SVG. SVG files are generated on demand. Alternatively, you can generate an SVG preview by making a PATCH request to `/connect/files/{fileId}/previews`. Hyperforce doesn’t support the SVG file preview format. Any org hosted on Hyperforce defaults to JPG file preview format regardless of the org preference in Setup. * `thumbnail` — Preview format is 240 x 180 PNG. * `big-thumbnail` — Preview format is 720 x 480 PNG. * `tiny-thumbnail` — Preview format is 120 x 90 PNG. Allowed values: `jpg`, `pdf`, `svg`, `thumbnail`, `big-thumbnail`, `tiny-thumbnail`. * `endPageNumber` (query, integer) The ending page number in the range of file preview URLs. Up to 500 pages are available in preview. _Available in: v35.0_ * `startPageNumber` (query, integer) The starting page number in the range of file preview URLs. Up to 500 pages are available in preview. _Available in: v35.0_ * `versionNumber` (query, integer) Version number of the file. Default value is latest version. _Available in: v40.0_ #### Responses * **200** _File Preview_ A file preview. Media type: `application/json`. Schema: `FilePreview`. ### GET File Rendition `GET /connect/files/{fileId}/rendition` Operation ID: `getFileRendition`. Tags: Files Resources. Returns a rendition of the file. A rendition is a binary preview of the file. The format of the binary depends on the format specified in the request. A rendition of the file. A rendition is a binary preview of the file. The format of the binary depends on the format specified in the request. **Note**: For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. **Note**: In versions 24.0–35.0, use `/chatter/files/{fileId}/rendition` and `/connect/communities/{communityId}/chatter/files/{fileId}/rendition`, which require Chatter. _Available in: v36.0_ #### Experience Cloud site path `/connect/communities/{communityId}/files/{fileId}/rendition` _Available in: v36.0_ #### Parameters * `fileId` (path, string (Id), required) ID of a file. Pattern: ^(069)\\w\*. * `page` (query, integer) Specify a rendition of a specific page. The first page is 0. If you don’t specify a specific page, a rendition of the first page is returned. For a PDF file rendition, the rendition is for the entire document. The only valid value is 0: you can’t get the rendition of a single page. * `type` (query, string) Specify the type of rendition to be returned. Default value is `THUMB120BY90`. Valid values are: * `PDF` * `THUMB120BY90` * `THUMB240BY180` * `THUMB720BY480` #### Responses * **200** Binary stream of the rendition. Media type: `application/octet-stream`. Schema: `string (binary)`. Binary stream of the rendition. Type: `string (binary)`. ### GET Folder Information `GET /connect/folders/{folderId}` Operation ID: `getFolderDetail`. Tags: Folders Resources. Return details about a folder. Also used for deleting and renaming the folder. Get information about the specified folder. **Note**: In versions 30.0–35.0, use `/chatter/folders/{folderId}`, which requires Chatter. _Available in: v36.0_ #### Parameters * `folderId` (path, string (IdOrRoot), required) ID of the folder. You can use `root` as the `{folderId}`. Pattern: ^(07H)\\w\*|root. #### Responses * **200** _Folder_ Description of a folder. Media type: `application/json`. Schema: `FolderDetail`. ### DELETE Folder Information `DELETE /connect/folders/{folderId}` Operation ID: `deleteFolderDetail`. Tags: Folders Resources. Return details about a folder. Also used for deleting and renaming the folder. Delete a folder. Deleting a folder deletes all the folders within that folder and removes all files from the deleted folders. **Note**: In versions 30.0–35.0, use `/chatter/folders/{folderId}`, which requires Chatter. _Available in: v36.0_ #### Parameters * `folderId` (path, string (IdOrRoot), required) ID of the folder. You can use `root` as the `{folderId}`. Pattern: ^(07H)\\w\*|root. #### Responses * **200** Success ### PATCH Folder Information `PATCH /connect/folders/{folderId}` Operation ID: `patchFolderDetail`. Tags: Folders Resources. Return details about a folder. Also used for deleting and renaming the folder. Move and rename a folder. **Note**: In versions 30.0–35.0, use `/chatter/folders/{folderId}`, which requires Chatter. **Note**: Salesforce Files Sync was retired on May 25, 2018. _Available in: v36.0_ #### Parameters * `folderId` (path, string (IdOrRoot), required) ID of the folder. You can use `root` as the `{folderId}`. Pattern: ^(07H)\\w\*|root. * `isInMyFileSync` (query, boolean) `true` if the folder and all folders in this folder are synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v33.0_ * `name` (query, string) The new name for the folder Required to rename a folder. _Available in: v30.0_ * `parentFolderId` (query, string) The ID of the new parent folder. If `null`, the folder is removed from its current folder. If the specified ID is `root`, the folder is moved to the root of the user’s folder hierarchy. Required to move a folder. _Available in: v30.0_ #### Request body Folder input. _Available in: v33.0_ Media type: `application/json`. Schema: `FolderInput`. _Example: example\_1_ Payload 1 ``` { "path": "my_documents/my_folder" } ``` #### Responses * **200** _Folder_ Description of a folder. Media type: `application/json`. Schema: `FolderDetail`. ### GET Folders Shares Link `GET /connect/folders/{folderId}/folder-shares/link` Operation ID: `getFolderShareLink`. Tags: Folders Resources. Manages creation, access, and deletion of a folder's link share. Access a folder’s share link. _Available in: v44.0_ #### Parameters * `folderId` (path, string (Id), required) ID of the folder. Pattern: ^(07H)\\w\*. #### Responses * **200** _Folder Share Link_ Success Media type: `application/json`. Schema: `FolderShareLink`. ### PUT Folders Shares Link `PUT /connect/folders/{folderId}/folder-shares/link` Operation ID: `putFolderShareLink`. Tags: Folders Resources. Manages creation, access, and deletion of a folder's link share. Create a folder’s share link. _Available in: v44.0_ #### Parameters * `folderId` (path, string (Id), required) ID of the folder. Pattern: ^(07H)\\w\*. #### Responses * **200** _Folder Share Link_ Success Media type: `application/json`. Schema: `FolderShareLink`. ### DELETE Folders Shares Link `DELETE /connect/folders/{folderId}/folder-shares/link` Operation ID: `deleteFolderShareLink`. Tags: Folders Resources. Manages creation, access, and deletion of a folder's link share. Delete a folder’s share link. _Available in: v44.0_ #### Parameters * `folderId` (path, string (Id), required) ID of the folder. Pattern: ^(07H)\\w\*. #### Responses * **204** _Successful Delete_ Success ### GET Folder Contents `GET /connect/folders/{folderId}/items` Operation ID: `getFolderItems`. Tags: Folders Resources. Return details about the items in a folder. Also used for adding items to a folder. Get information about the contents of a folder. **Note**: In versions 30.0–35.0, use `/chatter/folders/{folderId}/items`, which requires Chatter. _Available in: v36.0_ #### Parameters * `folderId` (path, string (IdOrRoot), required) ID of the folder. You can use `root` as the `{folderId}`. Pattern: ^(07H)\\w\*|root. * `filter` (query, ConnectFolderItemFilterEnum) Specifies a filter for items within a folder. _Available in: v33.0_ * `page` (query, integer) An integer specifying a page of items. The default value is 0, which returns the first page. _Available in: v30.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25. _Available in: v30.0_ #### Responses * **200** _Folder Item Page_ A paged collection of Folder Item response bodies. Media type: `application/json`. Schema: `FolderItemPage`. ### POST Folder Contents `POST /connect/folders/{folderId}/items` Operation ID: `postFolderItems`. Tags: Folders Resources. Return details about the items in a folder. Also used for adding items to a folder. Add a file to a folder. Create a folder. **Note**: In versions 30.0–35.0, use `/chatter/folders/{folderId}/items`, which requires Chatter. _Available in: v36.0_ #### Parameters * `folderId` (path, string (IdOrRoot), required) ID of the folder. You can use `root` as the `{folderId}`. Pattern: ^(07H)\\w\*|root. * `desc` (query, string) The description of the file _Available in: v30.0_ * `folderPath` (query, string) The path to the folder Required when creating a folder (type=Folder). _Available in: v30.0_ * `isInMyFileSync` (query, boolean) `true` if the folder and all folders in this folder are synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v33.0_ * `sharingOption` (query, string) Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v35.0_ * `sharingPrivacy` (query, string) Sharing privacy of a file. Values are: * `None` — File is visible to anyone with record access. * `PrivateOnRecords` — File is private on records. _Available in: v41.0_ * `title` (query, string) The title of the file _Available in: v30.0_ * `type` (query, ConnectFolderItemTypeEnum, required) The item type. To add a file to a folder, the value must be `File`. To create a folder, the value must be `Folder`. _Available in: v30.0_ #### Request body Folder Item Input _Available in: v30.0_ Media type: `multipart/form-data`. Schema: `object`. * `fileData` (_string (binary)_) * `folderItem` (_FolderItemInput_) #### Responses * **200** _Folder Item_ Description of an item (file or folder) in a folder. Media type: `application/json`. Schema: `FolderItem`. #### Code samples _Example: Example 1 · HTTP_ ``` { "file" : { "description" : "Yearly Report for Universal Containers Box Division", "title" : "Yearly.txt" }, "type" : "File" } ``` _Example: Example 2 · HTTP_ ``` { "folder" : { "path" : "my_documents/my_folder" }, "type" : "Folder" } ``` ## Schemas ### FilesConnectRepositoryContenthub Information about a Files Connect repository. * `authentication` (_object_) FilesConnectRepositoryAuthentication Repository authentication information. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepositoryAuthenticationContenthub`. * `features` (_object_) FilesConnectRepositoryFeatures Repository features. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepositoryFeatures`. * `id` (_string (Id)_) 18-character ID of the record. _Available in: v23.0_ _Filter group: Small_ * `label` (_string_) Repository label. _Available in: v32.0_ _Filter group: Small_ * `motif` (_object_) MotifContenthub Small, medium, and large icons indicating that the object is a user. The motif can also contain the object’s base color. The motif icon is not the user’s profile photo. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `MotifContenthub`. * `mySubscription` (_object_) ReferenceChatter If the context user is following this user, contains information about the subscription, otherwise `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `name` (_string_) Repository name. _Available in: v32.0_ _Filter group: Small_ * `providerType` (_object_) FilesConnectProviderType Repository provider type. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `FilesConnectProviderType`. * `rootFolderItemsUrl` (_string (url)_) URL to the repository root folder items, or `null` if the repository does not support browsing. _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ ### FilesConnectRepositoryCollection A collection of Files Connect repositories. * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v32.0_ _Filter group: Medium_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v32.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v32.0_ _Filter group: Medium_ * `repositories` (_array of FilesConnectRepositoryContenthub_) Collection of repositories. _Available in: v32.0_ _Filter group: Small_ ### RepositoryDirectoryEntryCollection A collection of directory entries. * `directoryEntries` (_RepositoryGroupSummaryContenthub | RepositoryUserSummary_) Collection of directory entries. _Available in: v35.0_ _Filter group: Small_ One of: `RepositoryGroupSummaryContenthub`, `RepositoryUserSummary`. ### RepositoryFileDetail Detail description of a repository file. * `checkinComment` (_string_) Checkin comment of the file. _Available in: v32.0_ _Filter group: Small_ * `contentBody` (_string_) Text of the file’s content if available, otherwise `null`. _Available in: v43.0_ _Filter group: Big_ * `contentItemSize` (_number (int64)_) Length in bytes of the content of the file, including files that are larger than 2 GB. _Available in: v65.0_ _Filter group: Small_ * `contentSize` (_integer_) Length in bytes of the content of the file, for files that are smaller than 2 GB. _Available in: v32.0_ _Filter group: Small_ * `createdBy` (_string_) Name of user who created the folder. _Available in: v32.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Created date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `description` (_string_) Folder description. _Available in: v32.0_ _Filter group: Small_ * `downloadUrl` (_string (url)_) URL to the repository file content. _Available in: v32.0_ _Filter group: Small_ * `externalContentUrl` (_string (url)_) URL to this file’s content in the external system. _Available in: v32.0_ _Filter group: Small_ * `externalDocumentUrl` (_string (url)_) URL to this file in the external system. _Available in: v32.0_ _Filter group: Small_ * `externalFilePermissionInformation` (_object_) ExternalFilePermissionInformationContenthub External file permission information, such as available groups, available permission types, and current sharing status, or `null` when `includeExternalFilePermissionsInfo` is `false` . _Available in: v36.0_ _Filter group: Big_ Includes all fields of `ExternalFilePermissionInformationContenthub`. * `id` (_string_) ID of the folder. _Available in: v32.0_ _Filter group: Small_ * `itemTypeUrl` (_string (url)_) URL to the item type information. _Available in: v35.0_ _Filter group: Small_ * `mimeType` (_string_) Mime type of the file. _Available in: v32.0_ _Filter group: Small_ * `modifiedBy` (_string_) Name of user who last modified the folder. _Available in: v32.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) Last modified date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `motif` (_object_) MotifContenthub Motif of the folder. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `MotifContenthub`. * `name` (_string_) Name of the folder. _Available in: v32.0_ _Filter group: Small_ * `previewsUrl` (_string (url)_) URL to the previews. _Available in: v36.0_ _Filter group: Small_ * `previewUrlThumbnail` (_string (url)_) URL to the thumbnail (240 x 180 PNG) preview. _Available in: v36.0_ _Filter group: Small_ * `previewUrlThumbnailBig` (_string (url)_) URL to the big thumbnail (720 x 480 PNG) preview. _Available in: v36.0_ _Filter group: Small_ * `previewUrlThumbnailTiny` (_string (url)_) URL to the tiny thumbnail (120 x 90 PNG) preview. _Available in: v36.0_ _Filter group: Small_ * `repository` (_object_) ReferenceChatter The folder external repository. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `title` (_string_) Title of the file. _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) Record type, `folder`. _Available in: v32.0_ _Filter group: Small_ * `url` (_string (url)_) Connect REST API URL to this folder. _Available in: v32.0_ _Filter group: Small_ * `versionId` (_string_) ID of the file version in the external system. _Available in: v32.0_ _Filter group: Small_ ### FilePreviewCollectionContenthub A collection of file previews. * `fileId` (_string (Id)_) ID of the file. _Available in: v35.0_ _Filter group: Small_ * `previews` (_array of FilePreviewContenthub_) Previews supported for the file. _Available in: v35.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the current page of file previews. _Available in: v35.0_ _Filter group: Medium_ * `versionNumber` (_string_) Version number of the file. _Available in: v40.0_ _Filter group: Medium_ ### ConnectFilePreviewFormatEnumContenthub The format of the preview. Values are: * `Audio` —Preview format is MP3. * `Jpg` —Preview format is JPG. * `Pdf` —Preview format is PDF. * `Svg` —Preview format is compressed SVG. * `Thumbnail` —Preview format is 240 x 180 PNG. * `ThumbnailBig` —Preview format is 720 x 480 PNG. * `ThumbnailTiny` —Preview format is 120 x 90 PNG. * `Video` —Preview format is MP4. _Available in: v35.0_ _Filter group: Small_ Type: `string`. Allowed values: `Audio`, `Jpg`, `Pdf`, `Svg`, `Thumbnail`, `ThumbnailBig`, `ThumbnailTiny`, `Video`. ### FilePreviewContenthub A file preview. * `format` (_object_) ConnectFilePreviewFormatEnum The format of the preview. Values are: * `Audio` —Preview format is MP3. * `Jpg` —Preview format is JPG. * `Pdf` —Preview format is PDF. * `Svg` —Preview format is compressed SVG. * `Thumbnail` —Preview format is 240 x 180 PNG. * `ThumbnailBig` —Preview format is 720 x 480 PNG. * `ThumbnailTiny` —Preview format is 120 x 90 PNG. * `Video` —Preview format is MP4. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `ConnectFilePreviewFormatEnumContenthub`. * `previewUrlCount` (_integer_) The total number of preview URLs for this preview format. _Available in: v35.0_ _Filter group: Small_ * `previewUrls` (_array of FilePreviewUrl_) A list of file preview URLs. _Available in: v35.0_ _Filter group: Small_ * `status` (_object_) ConnectFilePreviewStatusEnum The availability status of the preview. Values are: * `Available` —Preview is available. * `InProgress` —Preview is being processed. * `NotAvailable` —Preview is unavailable. * `NotScheduled` —Generation of the preview isn’t scheduled yet. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `ConnectFilePreviewStatusEnumContenthub`. * `url` (_string (url)_) The URL to the file preview. _Available in: v35.0_ _Filter group: Small_ ### RepositoryFolderDetail Details of a repository folder. * `createdBy` (_string_) Name of user who created the folder. _Available in: v32.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Created date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `description` (_string_) Folder description. _Available in: v32.0_ _Filter group: Small_ * `externalFolderUrl` (_string (url)_) Connect REST API URL to this folder in the external system. _Available in: v32.0_ _Filter group: Small_ * `folderItemsUrl` (_string (url)_) Connect REST API URL that lists the files and folders in this folder. _Available in: v32.0_ _Filter group: Small_ * `id` (_string_) ID of the folder. _Available in: v32.0_ _Filter group: Small_ * `itemTypeUrl` (_string (url)_) URL to the item type information. _Available in: v35.0_ _Filter group: Small_ * `modifiedBy` (_string_) Name of user who last modified the folder. _Available in: v32.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) Last modified date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `motif` (_object_) MotifContenthub Motif of the folder. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `MotifContenthub`. * `name` (_string_) Name of the folder. _Available in: v32.0_ _Filter group: Small_ * `path` (_string_) The absolute path of the folder in the external system. _Available in: v32.0_ _Filter group: Small_ * `repository` (_object_) ReferenceChatter The folder external repository. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `type` (_string_) Record type, `folder`. _Available in: v32.0_ _Filter group: Small_ * `url` (_string (url)_) Connect REST API URL to this folder. _Available in: v32.0_ _Filter group: Small_ ### FilesConnectItemTypeEnum Item types. One of these values: * `Any`: Includes files and folders. * `FilesOnly`: Includes files only. * `FoldersOnly`: Includes folders only. Type: `string`. Allowed values: `Any`, `FilesOnly`, `FoldersOnly`. ### FilesConnectAllowedItemTypeCollection The item types allowed to be created in the repository folder. * `allowedItemTypes` (_array of FilesConnectItemTypeSummary_) Collection of item types that can be created in the repository folder. _Available in: v35.0_ _Filter group: Small_ ### RepositoryFolderItemsCollection A collection of repository folder items. * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v32.0_ _Filter group: Medium_ * `items` (_array of RepositoryFolderItem_) Collection of items in a repository folder. _Available in: v32.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v32.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v32.0_ _Filter group: Medium_ ### FilesConnectItemInput The item type ID and fields of the item type. * `fields` (_array of FilesConnectFieldValueInput_) List of fields for the item. Required to create a SharePoint file in a repository because the file name is required; otherwise optional _Available in: v35.0_ * `itemTypeId` (_string_) ID of the item type, such as `L3NpdGVzL0FDRVRfRklMRUNPTk5FQ1RfSU5U:5f33e0f4-b33c-4127-b9e4-dd5a73dd2f1b:0c847e7c-d4a2-4136-bfda-c468fae2d087:0x0101`. To get the `itemTypeId`, use the [Files Connect Repository Folder Allowed Item Types](/docs/platform/connect-rest-api/references/connect-rest-api-files#tag/Files-Connect-Repository-Resources/operation/getContentHubFolderAllowedItemTypes) resource. Required to create a file in a repository _Available in: v35.0_ ### RepositoryFolderItem Description of a folder item. * `file` (_object_) RepositoryFileSummary If the folder item is a file, the file summary. If the folder item is a folder, `null`. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `RepositoryFileSummary`. * `folder` (_object_) RepositoryFolderSummary If the folder item is a folder, the folder summary. If the folder item is a file, `null`. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `RepositoryFolderSummary`. * `type` (_object_) ConnectFolderItemTypeEnum The type of folder item: `folder` or `file`. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ConnectFolderItemTypeEnumContenthub`. ### FilesConnectItemTypeDetail Detailed information about an item type associated with a repository folder. * `contentStreamSupport` (_object_) FilesConnectStreamSupportEnum Support for content streaming. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `FilesConnectStreamSupportEnum`. * `description` (_string_) Description of the item type. _Available in: v35.0_ _Filter group: Medium_ * `displayName` (_string_) Display name of the item type. _Available in: v35.0_ _Filter group: Small_ * `fields` (_array of FilesConnectFieldDefinition_) A list of fields that can be set for the item type. _Available in: v35.0_ _Filter group: Small_ * `id` (_string_) ID of the item type. _Available in: v35.0_ _Filter group: Small_ * `isVersionable` (_boolean_) Indicates whether the item type can have versions. _Available in: v35.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the detailed information of the item type. _Available in: v35.0_ _Filter group: Small_ ### FilesConnectPermissionCollection A collection of permissions. * `permissions` (_array of FilesConnectPermission_) Collection of permissions. _Available in: v35.0_ _Filter group: Small_ ### FilesConnectPermissionCollectionInput A collection of permissions to apply or remove. * `permissionsToApply` (_array of FilesConnectPermissionInput_) List of permissions to apply to the file. Required if `permissionsToRemove` isn’t specified _Available in: v35.0_ * `permissionsToRemove` (_array of FilesConnectPermissionInput_) List of permissions to remove from the file. Required if `permissionsToApply` isn’t specified _Available in: v35.0_ ### RepositoryPermissionTypeCollection A collection of permission types. * `permissionTypes` (_array of FilesConnectPermissionType_) Collection of permission types. _Available in: v35.0_ _Filter group: Small_ ### Batch Result of an entire batch request operation. Results are ordered in the same order in which the requests were given. Results may either be a successful result with a response body, a successful result without a response body, or an error result without a response body. Success and error are determined by the status code in each result. * `hasErrors` (_boolean_) True if at least one of the results is an error (a status code in the 400 or 500 range). _Available in: v28.0_ _Filter group: Small_ * `results` (_array of BatchResult_) Collection of batch result items. One for each request input. _Available in: v23.0_ _Filter group: Small_ ### FileDetail Includes all the File Summary response body with these additional items. * `checksum` (_string_) MD5 checksum for the file. _Available in: v26.0_ _Filter group: Big_ * `contentHubRepository` (_object_) FilesConnectRepository External data source associated with this file, or `null` if it doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepository`. * `contentModifiedDate` (_string (date-time)_) ISO 8601 format date string, for example, 2011-02-25T18:24:31.000Z. File-specific modified date, which is updated only for direct file operations, such as rename. Modifications to the file from outside of Salesforce can update this date. _Available in: v32.0_ _Filter group: Small_ * `contentSize` (_integer_) Size of the file in bytes. _Available in: v24.0_ _Filter group: Small_ * `contentUrl` (_string_) If the file is a link, returns the URL, otherwise the string `null`. _Available in: v24.0_ _Filter group: Small_ * `contentVersionId` (_string (Id)_) ID of the content version. _Available in: v62.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) ISO 8601 date string when the file was created. _Available in: v41.0_ _Filter group: Small_ * `description` (_string_) Description of the file. _Available in: v24.0_ _Filter group: Medium_ * `downloadUrl` (_string (url)_) URL to the file. _Available in: v26.0_ _Filter group: Small_ * `externalDocumentUrl` (_string (url)_) External URL this file points to, or `null` if it doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ * `externalFilePermissionInformation` (_object_) ExternalFilePermissionInformation External file permission information, such as available groups, available permission types, and current sharing status, or `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Big_ Includes all fields of `ExternalFilePermissionInformation`. * `fileAsset` (_object_) FileAsset An asset file. _Available in: v38.0_ _Filter group: Small_ Includes all fields of `FileAsset`. * `fileExtension` (_string_) Extension of the file. _Available in: v26.0_ _Filter group: Small_ * `fileType` (_string_) Type of file, such as PDF, PowerPoint. _Available in: v24.0_ _Filter group: Medium_ * `flashRenditionStatus` (_string_) Specifies if a flash preview version of the file has been rendered. Flash renditions were retired on July 16, 2021. _Available in: v24.0_ _Filter group: Big_ * `id` (_string (Id)_) 18-character ID of the object _Available in: v23.0_ _Filter group: Small_ * `isArchived` (_boolean_) Specifies if the file is archived (`true`) or not (`false`). _Available in: v68.0_ _Filter group: Small_ * `isFileAsset` (_boolean_) Specifies whether the file is an asset. _Available in: v46.0_ _Filter group: Small_ * `isInMyFileSync` (_boolean_) `true` if the file is synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v26.0_ _Filter group: Medium_ * `isMajorVersion` (_boolean_) `true` if the file is a major version; `false` if the file is a minor version. Major versions can’t be replaced. _Available in: v31.0_ _Filter group: Medium_ * `mimeType` (_string_) MIME type of the file. _Available in: v26.0_ _Filter group: Medium_ * `moderationFlags` (_object_) ModerationFlags Flags for this file. Moderators can view and act on flagged items. If the `communityModeration` property of the Features response body is `false`, this property is `null`. _Available in: v30.0_ _Filter group: Big_ Includes all fields of `ModerationFlags`. * `modifiedDate` (_string (date-time)_) ISO 8601 format date string, for example, 2011-02-25T18:24:31.000Z. Modifications to the file from within Salesforce update this date. _Available in: v24.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. The icon is not a preview of the file. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) Reference If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `name` (_string_) Name of the file. _Available in: v24.0_ _Filter group: Small_ * `origin` (_string_) Specifies the file source. Valid values are: * `Chatter` — file came from Chatter * `Content` — file came from content * `FileField` — file came from a record or other form _Available in: v24.0_ _Filter group: Big_ * `owner` (_object_) UserSummary Owner of the file. _Available in: v24.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `pageCount` (_integer_) Number of pages for documents that support flash renditions, or the number of slides in a presentation. Returns 0 if the flash rendition fails, or if it isn’t supported for the file type. **Note**: Flash renditions were retired on July 16, 2021. _Available in: v24.0_ _Filter group: Medium_ * `parentFolder` (_object_) Reference Reference to the parent folder. _Available in: v28.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `pdfRenditionStatus` (_string_) Specifies if a PDF preview version of the file has been rendered. _Available in: v24.0_ _Filter group: Big_ * `publishStatus` (_ConnectFilePublishStatusEnum_) * `renditionUrl` (_string (url)_) URL to the rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v26.0_ _Filter group: Medium_ * `renditionUrl240By180` (_string (url)_) URL to the 240px by 180px rendition for the file, if available. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v29.0_ _Filter group: Medium_ * `renditionUrl720By480` (_string (url)_) URL to the 720px by 480px rendition for the file, if available. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v29.0_ _Filter group: Medium_ * `repositoryFileId` (_string_) ID of the file in the external repository, or `null` if the file isn’t external. _Available in: v36.0_ _Filter group: Small_ * `repositoryFileUrl` (_string (url)_) URL to the Connect REST API resource giving access to the external repository file properties, or `null` if this file doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ * `sharingOption` (_ConnectFileSharingOptionEnum_) * `sharingPrivacy` (_ConnectFileSharingPrivacyEnum_) * `sharingRole` (_ConnectFileSharingRoleEnum_) * `systemModstamp` (_string (date-time)_) ISO 8601 date string indicating when a user or any automated system process, such as a trigger, updated the file. _Available in: v41.0_ _Filter group: Small_ * `textPreview` (_string_) Text preview of the file if available; `null` otherwise. _Available in: v30.0_ _Filter group: Big_ * `thumb120By90RenditionStatus` (_string_) Specifies the rendering status of the 120 x 90 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v24.0_ _Filter group: Small_ * `thumb240By180RenditionStatus` (_string_) Specifies the rendering status of the 240 x 180 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v24.0_ _Filter group: Small_ * `thumb720By480RenditionStatus` (_string_) Specifies the rendering status of the 720 x 480 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v24.0_ _Filter group: Small_ * `title` (_string_) Title of the file. _Available in: v24.0_ _Filter group: Small_ * `topics` (_object_) TopicCollection A paged collection of topics that are assigned to the file. Check page attributes to make sure that you get all the assigned topics. _Available in: v37.0_ _Filter group: Big_ Includes all fields of `TopicCollection`. * `type` (_string_) A fixed type name for this object. Check this value to determine the shape of a response body. _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) The Connect REST API URL resource for this object. _Available in: v23.0_ _Filter group: Small_ * `versionNumber` (_string_) Version number of the file. _Available in: v24.0_ _Filter group: Medium_ ### FileAssetInput Asset file input. * `isVisibleByExternalUsers` (_boolean_, required) Indicates whether unauthenticated users can see the asset file (`true`) or not (`false`). _Available in: v43.0_ ### FileUploadConfig File upload config. * `allowedFileExtensions` (_array of string_) File extensions that are allowed for upload. _Available in: v64.0_ _Filter group: Small_ * `hasCustomRecordTypes` (_boolean_) Specifies whether the ContentVersion has custom record types ( `true` ) or not ( `false` ). _Available in: v62.0_ _Filter group: Small_ * `maxFileAttachmentsOnFeed` (_integer_) Maximum number of file attachments on the feed. _Available in: v62.0_ _Filter group: Small_ * `maxFileSize` (_integer (int64)_) Maximum file size for upload. _Available in: v64.0_ _Filter group: Small_ * `token` (_string_) CSRF token that authenticates the file upload. _Available in: v62.0_ _Filter group: Small_ * `uploadUrl` (_string_) URL to the file upload. _Available in: v62.0_ _Filter group: Small_ ### FileBodyInput Describes a new file body input. To upload a file, provide the binary file in a multipart/form-data body part where name="fileData". * `fileName` (_string_, required) Name of the file. _Available in: v68.0_ * `fullFileSize` (_number (int64)_) Total file size in bytes. Required when initiating a chunked upload. _Available in: v68.0_ ### FileBody Basic representation of blob which resides in content body. * `chunkSize` (_number (int64)_) Maximum size in bytes for each chunk. Present only for chunked upload init responses. _Available in: v68.0_ _Filter group: Small_ * `fileBodyUrl` (_string (url)_) Reserved for future use. _Available in: v68.0_ _Filter group: Small_ * `fileName` (_string_) Name of the file. _Available in: v68.0_ _Filter group: Small_ * `fileSize` (_number (int64)_) Size of the file. _Available in: v68.0_ _Filter group: Small_ * `fileType` (_string_) Type of the file. _Available in: v68.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the content body. _Available in: v68.0_ _Filter group: Small_ * `uploadUrls` (_array of string (url)_) Ordered list of URLs to POST each binary chunk to. Present only for chunked upload init responses. _Available in: v68.0_ _Filter group: Small_ ### FileSummaryPage File summary page. * `currentPageUrl` (_string_) URL to the current page of files. _Available in: v24.0_ _Filter group: Medium_ * `files` (_array of FileSummary_) Collection of one or more files. _Available in: v24.0_ _Filter group: Small_ * `nextPageUrl` (_string_) URL to the next page of files. _Available in: v24.0_ _Filter group: Small_ * `previousPageUrl` (_string_) URL to the previous page of files. _Available in: v24.0_ _Filter group: Medium_ ### ConnectUserFilesFilterType When filtering on files feeds, specifies the feed items with files to view. Type: `string`. Allowed values: `Groups`, `SharedWithMe1`, `SharedWithMe2`. ### FileInput A new file. * `contentBodyId` (_string_) ID of the content body. _Available in: v62.0_ * `contentModifiedDate` (_string (date-time)_) File-specific last modified date that can be used to set a client-side modified date. Specify the date in ISO 8601 format. _Available in: v32.0_ * `desc` (_string_) Description of the file to be uploaded. _Available in: v24.0_ * `fieldName` (_string_) Name of a custom field on the ContentVersion object. The API name of the customer field must end with `fileupload__c`. _Available in: v62.0_ * `fieldValue` (_string_) Value to store for the custom field specified in `fieldName` for the uploaded file. _Available in: v62.0_ * `firstPublishLocationId` (_string_) ID of the location where the version was first published. _Available in: v62.0_ * `includeExternalFilePermissionsInfo` (_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}.` _Available in: v35.0_ * `isArchived` (_boolean_) Specify whether to archive (`true`) or unarchive (`false`) the file. Only supported for PATCH. Requires the ViewArchivedFiles user permission. The flag is applied to the ContentDocument and all of its versions. _Available in: v68.0_ * `isInMyFileSync` (_boolean_) `true` if the file is synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v31.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. _Available in: v31.0_ * `networkId` (_string_) ID of the Experience Cloud site where this file originated. _Available in: v62.0_ * `parentFolderId` (_string_) ID of the containing folder. _Available in: v31.0_ * `pathOnClient` (_string_) Complete path of the file. _Available in: v62.0_ * `repositoryFileId` (_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`. _Available in: v32.0_ * `repositoryFileUri` (_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 specify `repositoryFileUri`, don’t specify `repositoryFileId`. _Available in: v39.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. _Available in: v32.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}.` _Available in: v36.0_ * `sharingOption` (_string_) Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v35.0_ * `sharingPrivacy` (_string_) Sharing privacy of a file. Values are: * `None` — File is visible to anyone with record access. * `PrivateOnRecords` — File is private on records. _Available in: v41.0_ * `title` (_string_) Title of the file. _Available in: v24.0_ ### FileSharesPage Files share page. * `currentPageUrl` (_string_) URL to the current page of file shares. _Available in: v24.0_ _Filter group: Medium_ * `linkShare` (_object_) FileShareLink URL to the file share link. _Available in: v30.0_ _Filter group: Small_ Includes all fields of `FileShareLink`. * `shares` (_array of FileShare_) Collection of one or more file shares. _Available in: v24.0_ _Filter group: Small_ * `nextPageUrl` (_string_) URL to the next page of file shares. _Available in: v24.0_ _Filter group: Small_ * `previousPageUrl` (_string_) URL to the previous page of file shares. _Available in: v24.0_ _Filter group: Medium_ ### FileShareCollectionInput Describes a collection of entities (currently limited to users) to share a file with. To share a file, specify the entities, their sharing types ("C" for Collaborator or "V" for Viewer), and a message. * `message` (_string_) Private message body that’s sent to the recipients. If digital experiences is enabled, an email is sent instead of a private message. * `shares` (_array of FileShareInput_) Collection of Share Input request bodies. ### FileShareLink File shared as a link. * `expirationDate` (_string (date-time)_) Expiration date of the generated public link. _Available in: v58.0_ _Filter group: Small_ * `fileViewUrl` (_string (url)_) URL where the file can be viewed and downloaded. This value is also called the file share link. _Available in: v30.0_ _Filter group: Small_ * `isPasswordRequired` (_boolean_) Specifies whether a password is needed for the file’s public link (`true`) or not (`false`). _Available in: v58.0_ _Filter group: Small_ * `password` (_string_) If `isPasswordRequired` is `true`, the auto-generated password for the file’s public link. _Available in: v58.0_ _Filter group: Small_ * `sharingType` (_string_) The permission level of sharing. Values are: * `C` — Collaborator * `I` — Sharing permission is determined by location. This generally occurs when the sharing permission is not set on the file, but on the library. This value is also used when the context user is the owner of the file. * `N` — No access * `V` — Viewer _Available in: v30.0_ _Filter group: Small_ ### FileShareLinkInput File share link input. * `expirationDate` (_string_) Expiration date of the generated public link. _Available in: v58.0_ * `isPasswordRequired` (_boolean_) Specifies whether a password is needed for the file’s public link (`true`) or not (`false`). Specifying `true` generates a password. _Available in: v58.0_ ### ImageFile An image file. * `masterDetail` (_object_) ImageFileDetail Original image’s details. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `ImageFileDetail`. * `renditionDimensions` (_array of ImageFileDetail_) Original image’s available rendition dimensions. _Available in: v39.0_ _Filter group: Small_ ### FilePreviewCollection A collection of file previews. * `fileId` (_string (Id)_) ID of the file. _Available in: v35.0_ _Filter group: Small_ * `previews` (_array of FilePreview_) Previews supported for the file. _Available in: v35.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the current page of file previews. _Available in: v35.0_ _Filter group: Medium_ * `versionNumber` (_string_) Version number of the file. _Available in: v40.0_ _Filter group: Medium_ ### FilePreview A file preview. * `format` (_object_) ConnectFilePreviewFormatEnum The format of the preview. Values are: * `Audio` — Preview format is MP3. * `Jpg` — Preview format is JPG. * `Pdf` — Preview format is PDF. * `Svg` — Preview format is compressed SVG. * `Thumbnail` — Preview format is 240 x 180 PNG. * `ThumbnailBig` — Preview format is 720 x 480 PNG. * `ThumbnailTiny` — Preview format is 120 x 90 PNG. * `Video` — Preview format is MP4. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `ConnectFilePreviewFormatEnum`. * `previewUrlCount` (_integer_) The total number of preview URLs for this preview format. _Available in: v35.0_ _Filter group: Small_ * `previewUrls` (_array of FilePreviewUrl_) A list of file preview URLs. _Available in: v35.0_ _Filter group: Small_ * `status` (_object_) ConnectFilePreviewStatusEnum The availability status of the preview. Values are: * `Available` — Preview is available. * `InProgress` — Preview is being processed. * `NotAvailable` — Preview is unavailable. * `NotScheduled` — Generation of the preview isn’t scheduled yet. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `ConnectFilePreviewStatusEnum`. * `url` (_string (url)_) The URL to the file preview. _Available in: v35.0_ _Filter group: Small_ ### FolderDetail Description of a folder. * `createdDate` (_string (date-time)_) ISO 8601 date string specifying the creation date of the folder. _Available in: v30.0_ _Filter group: Small_ * `folderPaths` (_array of FolderPath_) Collection of folder paths. _Available in: v40.0_ _Filter group: Medium_ * `id` (_string (Id)_) 18-character ID of the object _Available in: v23.0_ _Filter group: Small_ * `isInMyFileSync` (_boolean_) `true` if the folder and all folders in this folder are synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v33.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) ISO 8601 date string specifying the last modified date of the folder. _Available in: v30.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) Reference If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `name` (_string_) Folder name. _Available in: v30.0_ _Filter group: Small_ * `parentFolder` (_object_) ReferenceChatter Reference to the parent folder. _Available in: v30.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `path` (_string_) Path to the folder. _Available in: v30.0_ _Filter group: Small_ * `systemModstamp` (_string (date-time)_) ISO 8601 date string when a user or any automated system process, such as a trigger, updates the folder. _Available in: v41.0_ _Filter group: Small_ * `type` (_string_) A fixed type name for this object. Check this value to determine the shape of a response body. _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) The Connect REST API URL resource for this object. _Available in: v23.0_ _Filter group: Small_ ### FolderInput Folder input. * `isInMyFileSync` (_boolean_) `true` if the folder and all folders in this folder are synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v33.0_ * `name` (_string_) The name of the folder. Either `path` or `name` is required. If you specify both, `path` is used and `name` is ignored. _Available in: v30.0_ * `parentFolderId` (_string_) The ID of the parent folder. Either `parentFolderId` or `path` is required. You can’t include both. _Available in: v30.0_ * `path` (_string_) The path of the folder. For example, `my documents/folder`. _Available in: v30.0_ ### FolderShareLink A folder shared as a link. * `folderViewUrl` (_string (url)_) URL where the folder can be viewed. This value is also called the folder share link. _Available in: v44.0_ _Filter group: Small_ ### ConnectFolderItemFilterEnum Specifies a filter of items contained within a folder. Type: `string`. Allowed values: `IsInMyFileSync`. ### FolderItemPage A paged collection of Folder Item response bodies. * `currentPageUrl` (_string_) Connect REST API URL identifying the current page. _Available in: v30.0_ _Filter group: Medium_ * `items` (_array of FolderItem_) A collection of folder items. _Available in: v30.0_ _Filter group: Small_ * `nextPageUrl` (_string_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v30.0_ _Filter group: Small_ * `previousPageUrl` (_string_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v30.0_ _Filter group: Medium_ ### ConnectFolderItemTypeEnum The type of item. _Available in: v30.0_ _Filter group: Small_ Type: `string`. Allowed values: `File`, `Folder`. ### FolderItemInput Folder item input. * `file` (_object_) FileInput A file in a folder Required to POST a `File` _Available in: v30.0_ Includes all fields of `FileInput`. * `folder` (_object_) FolderInput A folder in a folder Required to POST a `Folder` _Available in: v30.0_ Includes all fields of `FolderInput`. * `type` (_object_, required) ConnectFolderItemTypeEnum The item type. _Available in: v30.0_ Includes all fields of `ConnectFolderItemTypeEnum`. ### FolderItem Description of an item (file or folder) in a folder. * `file` (_object_) FileSummary A file representation _Available in: v30.0_ _Filter group: Small_ Includes all fields of `FileSummary`. * `folder` (_string_) A folder representation _Available in: v30.0_ _Filter group: Small_ * `type` (_object_) ConnectFolderItemTypeEnum The type of item. _Available in: v30.0_ _Filter group: Small_ Includes all fields of `ConnectFolderItemTypeEnum`. ### FilesConnectRepositoryAuthenticationContenthub Authentication information for a repository. * `authFlowUrl` (_string_) Depends on the `authProtocol`. * `NoAuthentication` — `null`. * `Oauth` —URL to start the OAuth flow. * `Password` —URL to the authentication settings for external systems. _Available in: v40.0_ _Filter group: Small_ Allowed values: `NoAuthentication`, `Oauth`, `Password`. * `authProtocol` (_object_) ConnectContenHubAuthenticationProtocolEnum Authentication protocol used for the repository. Values are: * `NoAuthentication` —Repository doesn’t require authentication. * `Oauth` —Repository uses OAuth authentication protocol. * `Password` —Repository uses user name and password authentication protocol. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ConnectContenHubAuthenticationProtocolEnumContenthub`. * `userHasAuthSettings` (_boolean_) Specifies whether the user has credentials or the administrator configured the external data source to use the same set of credentials for every user (`true`). Otherwise, `false`. _Available in: v40.0_ _Filter group: Small_ ### FilesConnectRepositoryFeatures Information about the features of a Files Connect repository. * `canBrowse` (_boolean_) Specifies whether the repository’s folder hierarchy can be browsed (`true`) or not (`false`). _Available in: v32.0_ _Filter group: Small_ * `canSearch` (_boolean_) Specifies whether the repository can be searched (`true`) or not (`false`). _Available in: v32.0_ _Filter group: Small_ ### MotifContenthub The motif properties contain URLs for small, medium, and large icons that indicate the Salesforce record type. Common record types are files, users, and groups, but all record types have a set of motif icons. Custom object records use their tab style icon. All icons are available to unauthenticated users so that, for example, you can display the motif icons in an email. The motif can also contain the record type’s base color. The motif images are icons, not user uploaded images or photos. For example, every user has the same set of motif icons. Custom object records use their tab style icon, for example, the following custom object uses the “boat” tab style: `"motif": { "color": "8C004C", "largeIconUrl": "/img/icon/custom51_100/boat64.png", "mediumIconUrl": "/img/icon/custom51_100/boat32.png", "smallIconUrl": "/img/icon/custom51_100/boat16.png", "svgIconUrl": null },` Users use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/icon/profile64.png", "mediumIconUrl": "/img/icon/profile32.png", "smallIconUrl": "/img/icon/profile16.png", "svgIconUrl": null },` Groups use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/icon/groups64.png", "mediumIconUrl": "/img/icon/groups32.png", "smallIconUrl": "/img/icon/groups16.png" },` Files use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/content/content64.png", "mediumIconUrl": "/img/content/content32.png", "smallIconUrl": "/img/icon/files16.png", "svgIconUrl": null },` To view the icons in the previous examples, preface the URL with `https://{instance_name}`. For example, `https://{instance_name}/img/icon/profile64.png`. * `color` (_string_) A hex value representing the base color of the record type, or `null` . _Available in: v29.0_ _Filter group: Small_ * `largeIconUrl` (_string_) A large icon indicating the record type. _Available in: v27.0_ _Filter group: Small_ * `mediumIconUrl` (_string_) A medium icon indicating the record type. _Available in: v27.0_ _Filter group: Small_ * `smallIconUrl` (_string_) A small icon indicating the record type. _Available in: v27.0_ _Filter group: Small_ * `svgIconUrl` (_string_) An icon in SVG format indicating the record type, or `null` if the icon doesn’t exist. _Available in: v34.0_ _Filter group: Small_ ### ReferenceChatter A reference to a record. * `id` (_string_) The ID of the record being referenced, which could be an 18-character ID or some other string identifier. _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) The URL to the resource endpoint. _Available in: v23.0_ _Filter group: Small_ ### FilesConnectProviderType Information about the Files Connect provider. * `label` (_string_) Localized label of the provider type. _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) Provider type. One of these values: * `ContentHubBox` * `ContentHubGDrive` * `ContentHubSharepoint` * `ContentHubSharepointOffice365` * `ContentHubSharepointOneDrive` * `SimpleUrl` _Available in: v32.0_ _Filter group: Small_ ### RepositoryGroupSummaryContenthub Detailed description of a group entry. * `domain` (_string_) Domain of the group. _Available in: v35.0_ _Filter group: Medium_ * `email` (_string_) Email of the group. _Available in: v35.0_ _Filter group: Small_ * `groupType` (_object_) FilesConnectGroupTypeEnum Type of group. Values are: * `Everybody` —Group is public to everybody. * `EverybodyInDomain` —Group is public to everybody in the same domain. * `Unknown` —Group type is unknown. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `FilesConnectGroupTypeEnumContenthub`. * `id` (_string_) ID of the group. _Available in: v35.0_ _Filter group: Small_ * `name` (_string_) Name of the group. _Available in: v35.0_ _Filter group: Medium_ * `type` (_object_) ConnectDirectoryEntryTypeEnum The type of entry. Value is `GroupEntry`. _Available in: v35.0_ _Filter group: Medium_ Includes all fields of `ConnectDirectoryEntryTypeEnumContenthub`. ### RepositoryUserSummary Detailed description of a user entry. * `domain` (_string_) Domain of the user. _Available in: v35.0_ _Filter group: Medium_ * `email` (_string_) Email of the user. _Available in: v35.0_ _Filter group: Small_ * `firstName` (_string_) First name of the user. _Available in: v35.0_ _Filter group: Medium_ * `id` (_string_) ID of the user. _Available in: v35.0_ _Filter group: Small_ * `lastName` (_string_) Last name of the user. _Available in: v35.0_ _Filter group: Medium_ * `type` (_string_) The type of entry. Value is `UserEntry`. _Available in: v35.0_ _Filter group: Medium_ ### ExternalFilePermissionInformationContenthub External file permissions information. * `externalFilePermissionTypes` (_array of FilesConnectPermissionType_) Available permission types for the parent folder of the external file, or `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Small_ * `externalFilePermissionsFailure` (_boolean_) `true` if the retrieval of external file information failed or if `includeExternalFilePermissionsInfo` is `false`; `false` otherwise. _Available in: v35.0_ _Filter group: Small_ * `externalFilePermissionsInfoFailureReason` (_string_) Explanation of the failure if a failure occurred and `includeExternalFilePermissionsInfo` is `true`; `null` otherwise. _Available in: v35.0_ _Filter group: Small_ * `externalFileSharingStatus` (_object_) ConnectExternalItemSharingTypeEnum Sharing status for the external file. Values are: * `DomainSharing` —File is shared with the domain. * `PrivateSharing` —File is private or shared only with individuals. * `PublicSharing` —File is publicly shared. Value is `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `ConnectExternalItemSharingTypeEnumContenthub`. * `repositoryPublicGroups` (_array of RepositoryGroupSummaryContenthub_) Available public groups in the external repository or `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Small_ ### FilePreviewUrl The URL to a file preview. * `pageNumber` (_integer_) Preview page number starting from zero, or `null` for PDF files. _Available in: v35.0_ _Filter group: Small_ * `previewUrl` (_string (url)_) File preview URL. _Available in: v35.0_ _Filter group: Small_ ### ConnectFilePreviewStatusEnumContenthub The availability status of the preview. Values are: * `Available` —Preview is available. * `InProgress` —Preview is being processed. * `NotAvailable` —Preview is unavailable. * `NotScheduled` —Generation of the preview isn’t scheduled yet. _Available in: v35.0_ _Filter group: Small_ Type: `string`. Allowed values: `Available`, `InProgress`, `NotAvailable`, `NotScheduled`. ### FilesConnectItemTypeSummary Summary information about an item type associated with a repository folder. * `contentStreamSupport` (_object_) FilesConnectStreamSupportEnum Support for content streaming. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `FilesConnectStreamSupportEnum`. * `description` (_string_) Description of the item type. _Available in: v35.0_ _Filter group: Medium_ * `displayName` (_string_) Display name of the item type. _Available in: v35.0_ _Filter group: Small_ * `id` (_string_) ID of the item type. _Available in: v35.0_ _Filter group: Small_ * `isVersionable` (_boolean_) Indicates whether the item type can have versions. _Available in: v35.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the detailed information of the item type. _Available in: v35.0_ _Filter group: Small_ ### FilesConnectFieldValueInput The fields of the item type. * `name` (_string_, required) Name of the field. _Available in: v35.0_ * `value` (_string_, required) Value of the field. _Available in: v35.0_ ### RepositoryFileSummary Description of a repository file. * `checkinComment` (_string_) Checkin comment of the file. _Available in: v32.0_ _Filter group: Small_ * `contentBody` (_string_) Text of the file’s content if available, otherwise `null`. _Available in: v43.0_ _Filter group: Big_ * `contentItemSize` (_number (int64)_) Length in bytes of the content of the file, including files that are larger than 2 GB. _Available in: v65.0_ _Filter group: Small_ * `contentSize` (_integer_) Length in bytes of the content of the file, for files that are smaller than 2 GB. _Available in: v32.0_ _Filter group: Small_ * `createdBy` (_string_) Name of user who created the folder. _Available in: v32.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Created date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `description` (_string_) Folder description. _Available in: v32.0_ _Filter group: Small_ * `downloadUrl` (_string (url)_) URL to the repository file content. _Available in: v32.0_ _Filter group: Small_ * `externalContentUrl` (_string (url)_) URL to this file’s content in the external system. _Available in: v32.0_ _Filter group: Small_ * `externalDocumentUrl` (_string (url)_) URL to this file in the external system. _Available in: v32.0_ _Filter group: Small_ * `externalFilePermissionInformation` (_object_) ExternalFilePermissionInformationContenthub External file permission information, such as available groups, available permission types, and current sharing status, or `null` when `includeExternalFilePermissionsInfo` is `false` . _Available in: v36.0_ _Filter group: Big_ Includes all fields of `ExternalFilePermissionInformationContenthub`. * `id` (_string_) ID of the folder. _Available in: v32.0_ _Filter group: Small_ * `itemTypeUrl` (_string (url)_) URL to the item type information. _Available in: v35.0_ _Filter group: Small_ * `mimeType` (_string_) Mime type of the file. _Available in: v32.0_ _Filter group: Small_ * `modifiedBy` (_string_) Name of user who last modified the folder. _Available in: v32.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) Last modified date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `motif` (_object_) MotifContenthub Motif of the folder. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `MotifContenthub`. * `name` (_string_) Name of the folder. _Available in: v32.0_ _Filter group: Small_ * `previewsUrl` (_string (url)_) URL to the previews. _Available in: v36.0_ _Filter group: Small_ * `previewUrlThumbnail` (_string (url)_) URL to the thumbnail (240 x 180 PNG) preview. _Available in: v36.0_ _Filter group: Small_ * `previewUrlThumbnailBig` (_string (url)_) URL to the big thumbnail (720 x 480 PNG) preview. _Available in: v36.0_ _Filter group: Small_ * `previewUrlThumbnailTiny` (_string (url)_) URL to the tiny thumbnail (120 x 90 PNG) preview. _Available in: v36.0_ _Filter group: Small_ * `repository` (_object_) ReferenceChatter The folder external repository. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `title` (_string_) Title of the file. _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) Record type, `folder`. _Available in: v32.0_ _Filter group: Small_ * `url` (_string (url)_) Connect REST API URL to this folder. _Available in: v32.0_ _Filter group: Small_ * `versionId` (_string_) ID of the file version in the external system. _Available in: v32.0_ _Filter group: Small_ ### RepositoryFolderSummary Summary of a repository folder. * `createdBy` (_string_) Name of user who created the folder. _Available in: v32.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Created date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `description` (_string_) Folder description. _Available in: v32.0_ _Filter group: Small_ * `externalFolderUrl` (_string (url)_) Connect REST API URL to this folder in the external system. _Available in: v32.0_ _Filter group: Small_ * `folderItemsUrl` (_string (url)_) Connect REST API URL that lists the files and folders in this folder. _Available in: v32.0_ _Filter group: Small_ * `id` (_string_) ID of the folder. _Available in: v32.0_ _Filter group: Small_ * `itemTypeUrl` (_string (url)_) URL to the item type information. _Available in: v35.0_ _Filter group: Small_ * `modifiedBy` (_string_) Name of user who last modified the folder. _Available in: v32.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) Last modified date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `motif` (_object_) MotifContenthub Motif of the folder. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `MotifContenthub`. * `name` (_string_) Name of the folder. _Available in: v32.0_ _Filter group: Small_ * `path` (_string_) The absolute path of the folder in the external system. _Available in: v32.0_ _Filter group: Small_ * `repository` (_object_) ReferenceChatter The folder external repository. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `type` (_string_) Record type, `folder`. _Available in: v32.0_ _Filter group: Small_ * `url` (_string (url)_) Connect REST API URL to this folder. _Available in: v32.0_ _Filter group: Small_ ### ConnectFolderItemTypeEnumContenthub The type of folder item: `folder` or `file`. _Available in: v32.0_ _Filter group: Small_ Type: `string`. Allowed values: `File`, `Folder`. ### FilesConnectStreamSupportEnum Support for content streaming. _Available in: v35.0_ _Filter group: Small_ Type: `string`. Allowed values: `ContentStreamAllowed`, `ContentStreamNotAllowed`, `ContentStreamRequired`. ### FilesConnectFieldDefinition Field definition for the item type. * `displayName` (_string_) Label or caption for the field. _Available in: v35.0_ _Filter group: Small_ * `isMandatory` (_boolean_) Specifies whether this field is mandatory for the item type. _Available in: v35.0_ _Filter group: Small_ * `maxLength` (_integer_) The maximum length of the value of the field. _Available in: v35.0_ _Filter group: Small_ * `name` (_string_) Name of the field. _Available in: v35.0_ _Filter group: Small_ * `type` (_object_) FilesConnectVariableTypeEnum Data type of the value of the field. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `FilesConnectVariableTypeEnum`. ### FilesConnectPermission A permission. * `directoryEntry` (_RepositoryGroupSummaryContenthub | RepositoryUserSummary_) The detailed information of a directory entry. _Available in: v35.0_ _Filter group: Medium_ One of: `RepositoryGroupSummaryContenthub`, `RepositoryUserSummary`. * `isUpdatable` (_boolean_) Specifies whether this permission can be updated. _Available in: v35.0_ _Filter group: Small_ * `rights` (_array of FilesConnectPermissionType_) A collection of permission types. _Available in: v35.0_ _Filter group: Medium_ ### FilesConnectPermissionInput A permission. * `directoryEntryId` (_string_, required) ID of the user or group. _Available in: v35.0_ * `permissionTypesIds` (_array of string_, required) List of IDs of the permission types. _Available in: v35.0_ ### FilesConnectPermissionType A permission type. * `id` (_string_) The internal ID of the permission type in the repository. _Available in: v35.0_ _Filter group: Medium_ * `label` (_string_) The label as returned by the repository. _Available in: v35.0_ _Filter group: Medium_ ### BatchResult Describes the result of an individual request in a batch request. * `result` (_any_) The result of this individual request. The type depends on the batch resource; for an error result it is an error message. * `statusCode` (_integer_) An HTTP status code indicating the status of this individual request in the batch. ### FilesConnectRepository Information about a Files Connect repository. * `authentication` (_object_) FilesConnectRepositoryAuthentication Repository authentication information. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepositoryAuthentication`. * `features` (_object_) FilesConnectRepositoryFeatures Repository features. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepositoryFeatures`. * `id` (_string_) 18-character ID of the external data source. _Available in: v32.0_ _Filter group: Small_ * `label` (_string_) Repository label. _Available in: v32.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) Reference If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `name` (_string_) Repository name. _Available in: v32.0_ _Filter group: Small_ * `providerType` (_object_) FilesConnectProviderType Repository provider type. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `FilesConnectProviderType`. * `rootFolderItemsUrl` (_string (url)_) URL to the repository root folder items, or `null` if the repository does not support browsing. _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) Type of record, `ContentHubRepository`. _Available in: v32.0_ _Filter group: Small_ * `url` (_string_) Connect REST API resource URL to the Files Connect repository. _Available in: v32.0_ _Filter group: Small_ ### ExternalFilePermissionInformation External file permissions information. * `externalFilePermissionTypes` (_array of FilesConnectPermissionType_) Available permission types for the parent folder of the external file, or `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Small_ * `externalFilePermissionsFailure` (_boolean_) `true` if the retrieval of external file information failed or if `includeExternalFilePermissionsInfo` is `false`; `false` otherwise. _Available in: v35.0_ _Filter group: Small_ * `externalFilePermissionsInfoFailureReason` (_string_) Explanation of the failure if a failure occurred and `includeExternalFilePermissionsInfo` is `true`; `null` otherwise. _Available in: v35.0_ _Filter group: Small_ * `externalFileSharingStatus` (_object_) ConnectExternalItemSharingTypeEnum Sharing status for the external file. Values are: * `DomainSharing` — File is shared with the domain. * `PrivateSharing` — File is private or shared only with individuals. * `PublicSharing` — File is publicly shared. Value is `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `ConnectExternalItemSharingTypeEnum`. * `repositoryPublicGroups` (_array of RepositoryGroupSummary_) Available public groups in the external repository or `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Small_ ### FileAsset An asset file. * `baseAssetUrl` (_string_) Base download URL of the asset. _Available in: v38.0_ _Filter group: Small_ * `baseUnauthenticatedAssetUrl` (_string (url)_) Base download URL of the asset for unauthenticated users if `isVisibleByExternalUsers` is `true`, otherwise `null`. _Available in: v43.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the asset. _Available in: v38.0_ _Filter group: Small_ * `isVisibleByExternalUsers` (_boolean_) Indicates whether unauthenticated users can see the asset file (`true`) or not (`false`). _Available in: v43.0_ _Filter group: Small_ * `masterLabel` (_string_) Label of the asset. _Available in: v38.0_ _Filter group: Small_ * `name` (_string_) Unique name of the asset. _Available in: v38.0_ _Filter group: Small_ * `namespacePrefix` (_string_) Namespace prefix of the package containing the asset. _Available in: v38.0_ _Filter group: Small_ * `type` (_string_) Type of asset. _Available in: v38.0_ _Filter group: Small_ ### ModerationFlags Moderation flags. * `flagCount` (_integer_) If the context user is a community moderator, the total number of flags on the post, comment, or file. If the context user isn’t a community moderator, value is `null`. Flags on files is available starting in version 30.0. _Available in: v29.0_ _Filter group: Small_ * `flagCountByReason` (_object_) Number of moderation flags categorized by reason. Values for String are: * `FlaggedByRule` — Moderation rule flagged the item. * `FlaggedBySystem` — Einstein flagged the item. * `FlaggedByUserAsInappropriate` — User flagged the item as inappropriate. * `FlaggedByUserAsSpam` — User flagged the item as spam. _Available in: v40.0_ _Filter group: Small_ Additional properties: `integer`. * `flaggedByMe` (_boolean_) Indicates whether the post, comment, or file was flagged by the context user ( `true` ) or not ( `false` ). Flags on files is available starting in version 30.0. _Available in: v29.0_ _Filter group: Small_ * `flags` (_object_) ModerationFlagsCollection Collection of flags. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ModerationFlagsCollection`. ### Motif The motif properties contain URLs for small, medium, and large icons that indicate the Salesforce record type. Common record types are files, users, and groups, but all record types have a set of motif icons. Custom object records use their tab style icon. All icons are available to unauthenticated users so that, for example, you can display the motif icons in an email. The motif can also contain the record type’s base color. The motif images are icons, not user uploaded images or photos. For example, every user has the same set of motif icons. Custom object records use their tab style icon, for example, the following custom object uses the “boat” tab style: `"motif": { "color": "8C004C", "largeIconUrl": "/img/icon/custom51_100/boat64.png", "mediumIconUrl": "/img/icon/custom51_100/boat32.png", "smallIconUrl": "/img/icon/custom51_100/boat16.png", "svgIconUrl": null },` Users use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/icon/profile64.png", "mediumIconUrl": "/img/icon/profile32.png", "smallIconUrl": "/img/icon/profile16.png", "svgIconUrl": null },` Groups use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/icon/groups64.png", "mediumIconUrl": "/img/icon/groups32.png", "smallIconUrl": "/img/icon/groups16.png" },` Files use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/content/content64.png", "mediumIconUrl": "/img/content/content32.png", "smallIconUrl": "/img/icon/files16.png", "svgIconUrl": null },` To view the icons in the previous examples, preface the URL with https:// `{instance_name}`. For example, https:// `{instance_name}` /img/icon/profile64.png. * `color` (_string_) A hex value representing the base color of the record type, or `null`. _Available in: v29.0_ _Filter group: Small_ * `largeIconUrl` (_string_) A large icon indicating the record type. _Available in: v27.0_ _Filter group: Small_ * `mediumIconUrl` (_string_) A medium icon indicating the record type. _Available in: v27.0_ _Filter group: Small_ * `smallIconUrl` (_string_) A small icon indicating the record type. _Available in: v27.0_ _Filter group: Small_ * `svgIconUrl` (_string_) An icon in SVG format indicating the record type, or `null` if the icon doesn’t exist. _Available in: v34.0_ _Filter group: Small_ ### UserSummary The User Summary response body is a subset of the User Detail response body. * `additionalLabel` (_string_) If one exists, an extra label for the user, for example, “Customer,” “Partner,” or “Acme Corporation.” _Available in: v30.0_ _Filter group: Small_ * `communityNickname` (_string_) User’s nickname in the site. _Available in: v32.0_ _Filter group: Medium_ * `companyName` (_string_) Name of the company. _Available in: v23.0_ _Filter group: Small_ * `displayName` (_string_) User’s name that is displayed in the site. If nicknames are enabled, the nickname is displayed. If nicknames aren’t enabled, the full name is displayed. _Available in: v32.0_ _Filter group: Small_ * `firstName` (_string_) User's first name. In version 39.0 and later, if nicknames are enabled, `firstName` is `null`. _Available in: v23.0_ _Filter group: Small_ * `id` (_string_) 18-character ID of the user. _Available in: v23.0_ _Filter group: Small_ * `isActive` (_boolean_) `true` if user is active, `false` otherwise. _Available in: v25.0_ _Filter group: Small_ * `isChatterGuest` (_boolean_) `true` if user is a Chatter customer, `false` otherwise In version 26.0 and later, user the `userType` property. _Available in: v23.0–26.0_ * `isInThisCommunity` (_boolean_) `true` if the user is in the same Experience Cloud site as the context user; `false` otherwise. Can be `false` for record feed @mentions on posts with the scope “All Users.” _Available in: v28.0_ _Filter group: Small_ * `lastName` (_string_) User's last name. In version 39.0 and later, if nicknames are enabled, `lastName` is `null`. _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating that the object is a user. The motif can also contain the object’s base color. The motif icon is not the user’s profile photo. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) Reference If the context user is following this user, contains information about the subscription, otherwise `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `name` (_string_) Locale-based concatenation of first and last names. In version 39.0 and later, if nicknames are enabled, `name` is the nickname. _Available in: v23.0_ _Filter group: Small_ * `outOfOffice` (_object_) OutOfOffice If one exists, extra out-of-office message for the user. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `OutOfOffice`. * `photo` (_object_) Photo Information about the user's photo. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `Photo`. * `reputation` (_object_) Reputation Reputation of the user in the site, which is determined by the number of points earned from events and actions performed in the site. _Available in: v32.0_ _Filter group: Big_ Includes all fields of `Reputation`. * `stamps` (_array of Stamp_) Collection of the user’s stamps. In version 44.0 and later, use SOQL to get a user’s stamps. _Available in: v39.0–43.0_ _Filter group: Small_ * `title` (_string_) Title of the user. _Available in: v23.0_ _Filter group: Small_ * `type` (_string_) Value is `User`. _Available in: v23.0_ _Filter group: Small_ * `url` (_string_) URL to the user's Chatter profile. _Available in: v23.0_ _Filter group: Small_ * `userType` (_string_) Type of user. Valid values are: * `ChatterGuest` —User is an external user in a private group. * `ChatterOnly` —User is a Chatter Free customer. * `Guest` —User is unauthenticated. * `Internal` —User is a standard org member. * `Portal` —User is an external user in an Experience Cloud site. * `System` —User is Chatter Expert or a system user. * `Undefined` —User is a user type that is a custom object. _Available in: v26.0_ _Filter group: Medium_ Allowed values: `ChatterGuest`, `ChatterOnly`, `Guest`, `Internal`, `Portal`, `System`, `Undefined`. ### ConnectFilePublishStatusEnum Specifies the publish status of a file. Type: `string`. Allowed values: `PendingAccess`, `PrivateAccess`, `PublicAccess`. ### ConnectFileSharingOptionEnum Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v36.0_ _Filter group: Medium_ Type: `string`. Allowed values: `Allowed`, `Restricted`. ### ConnectFileSharingPrivacyEnum Specifies the sharing privacy of a file. Type: `string`. Allowed values: `None`, `PrivateOnRecords`. ### ConnectFileSharingRoleEnum Sharing role of the file. One of these values: * `Admin` — Owner permission, but doesn’t own the file. * `Collaborator` — Viewer permission, and can edit, change permissions, and upload a new version of a file. * `Owner` — Collaborator permission, and can make a file private, and delete a file. * `Viewer` — Can view, download, and share a file. * `WorkspaceManaged` — Permission controlled by the library. _Available in: v29.0_ _Filter group: Medium_ Type: `string`. Allowed values: `Admin`, `Collaborator`, `Owner`, `Viewer`, `WorkspaceManaged`. ### TopicCollection Topic collection. * `currentPageUrl` (_string (url)_) Returns the current page of topics _Available in: v29.0_ _Filter group: Medium_ * `nextPageUrl` (_string (url)_) Returns the next page of topics. If there is no next page, returns the string “null” _Available in: v29.0_ _Filter group: Small_ * `topics` (_array of Topic_) Collection of topics _Available in: v24.0_ _Filter group: Small_ ### FileSummary Description of a file. For all rendition properties, note the following: For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. * `checksum` (_string_) MD5 checksum for the file. _Available in: v26.0_ _Filter group: Big_ * `contentHubRepository` (_object_) FilesConnectRepository External data source associated with this file, or `null` if it doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepository`. * `contentModifiedDate` (_string_) ISO 8601 format date string, for example, 2011-02-25T18:24:31.000Z. File-specific modified date, which is updated only for direct file operations, such as rename. Modifications to the file from outside of Salesforce can update this date. _Available in: v32.0_ _Filter group: Small_ * `contentSize` (_integer_) Size of the file in bytes. _Available in: v24.0_ _Filter group: Small_ * `contentUrl` (_string_) If the file is a link, returns the URL, otherwise the string `null`. _Available in: v24.0_ _Filter group: Small_ * `contentVersionId` (_string_) ID of the content version. _Available in: v62.0_ _Filter group: Small_ * `createdDate` (_string_) ISO 8601 date string when the file was created. _Available in: v41.0_ _Filter group: Small_ * `description` (_string_) Description of the file. _Available in: v24.0_ _Filter group: Medium_ * `downloadUrl` (_string_) URL to the file. _Available in: v26.0_ _Filter group: Small_ * `externalDocumentUrl` (_string_) External URL this file points to, or `null` if it doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ * `externalFilePermissionInformation` (_object_) ExternalFilePermissionInformation External file permission information, such as available groups, available permission types, and current sharing status, or `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Big_ Includes all fields of `ExternalFilePermissionInformation`. * `fileExtension` (_string_) Extension of the file. _Available in: v26.0_ _Filter group: Small_ * `fileType` (_string_) Type of file, such as PDF, PowerPoint. _Available in: v24.0_ _Filter group: Medium_ * `flashRenditionStatus` (_string_) Specifies if a flash preview version of the file has been rendered. Flash renditions were retired on July 16, 2021. _Available in: v24.0_ _Filter group: Big_ * `id` (_string_) 18-character ID of the file. _Available in: v24.0_ _Filter group: Small_ * `isArchived` (_boolean_) Specifies if the file is archived (`true`) or not (`false`). _Available in: v68.0_ _Filter group: Small_ * `isFileAsset` (_boolean_) Specifies whether the file is an asset. _Available in: v46.0_ _Filter group: Small_ * `isInMyFileSync` (_boolean_) `true` if the file is synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v26.0_ _Filter group: Medium_ * `isMajorVersion` (_boolean_) `true` if the file is a major version; `false` if the file is a minor version. Major versions can’t be replaced. _Available in: v31.0_ _Filter group: Medium_ * `mimeType` (_string_) MIME type of the file. _Available in: v26.0_ _Filter group: Medium_ * `moderationFlags` (_object_) ModerationFlags Flags for this file. Moderators can view and act on flagged items. If the `communityModeration` property of the Features response body is `false`, this property is `null`. _Available in: v30.0_ _Filter group: Big_ Includes all fields of `ModerationFlags`. * `modifiedDate` (_string_) ISO 8601 format date string, for example, 2011-02-25T18:24:31.000Z. Modifications to the file from within Salesforce update this date. _Available in: v24.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) Reference If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `name` (_string_) Name of the file. _Available in: v24.0_ _Filter group: Small_ * `origin` (_string_) Specifies the file source. Valid values are: * `Chatter` — file came from Chatter * `Content` — file came from content * `FileField` — file came from a record or other form _Available in: v24.0_ _Filter group: Big_ * `owner` (_object_) UserSummary Owner of the file. _Available in: v24.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `parentFolder` (_object_) Reference Reference to the parent folder. _Available in: v28.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `pdfRenditionStatus` (_string_) Specifies if a PDF preview version of the file has been rendered. _Available in: v24.0_ _Filter group: Big_ * `publishStatus` (_string_) Publish status of the file. One of these values: * `PendingAccess` —File is pending publishing. * `PrivateAccess` —File is private. * `PublicAccess` —File is public. _Available in: v29.0_ _Filter group: Small_ Allowed values: `PendingAccess`, `PrivateAccess`, `PublicAccess`. * `renditionUrl` (_string_) URL to the rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v26.0_ _Filter group: Medium_ * `renditionUrl240By180` (_string_) URL to the 240px by 180px rendition for the file, if available. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v29.0_ _Filter group: Medium_ * `renditionUrl720By480` (_string_) URL to the 720px by 480px rendition for the file, if available. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v29.0_ _Filter group: Medium_ * `repositoryFileId` (_string_) ID of the file in the external repository, or `null` if the file isn’t external. _Available in: v36.0_ _Filter group: Small_ * `repositoryFileUrl` (_string_) URL to the Connect REST API resource giving access to the external repository file properties, or `null` if this file doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ * `sharingOption` (_string_) Sharing option of the file. Values are: * `Allowed` —Resharing of the file is allowed. * `Restricted` —Resharing of the file is restricted. _Available in: v35.0_ _Filter group: Medium_ Allowed values: `Allowed`, `Restricted`. * `sharingPrivacy` (_string_) Sharing privacy of a file. Values are: * `None` —File is visible to anyone with record access. * `PrivateOnRecords` —File is private on records. _Available in: v41.0_ _Filter group: Medium_ Allowed values: `None`, `PrivateOnRecords`. * `sharingRole` (_string_) Sharing role of the file. One of these values: * `Admin` —Owner permission, but doesn’t own the file. * `Collaborator` —Viewer permission, and can edit, change permissions, and upload a new version of a file. * `Owner` —Collaborator permission, and can make a file private, and delete a file. * `Viewer` —Can view, download, and share a file. * `WorkspaceManaged` —Permission controlled by the library. _Available in: v29.0_ _Filter group: Medium_ Allowed values: `Admin`, `Collaborator`, `Owner`, `Viewer`, `WorkspaceManaged`. * `systemModstamp` (_string_) ISO 8601 date string indicating when a user or any automated system process, such as a trigger, updated the file. _Available in: v41.0_ _Filter group: Small_ * `textPreview` (_string_) Text preview of the file if available; `null` otherwise. _Available in: v30.0_ _Filter group: Big_ * `thumb120By90RenditionStatus` (_string_) Specifies the rendering status of the 120 x 90 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v24.0_ _Filter group: Small_ * `thumb240By180RenditionStatus` (_string_) Specifies the rendering status of the 240 x 180 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v24.0_ _Filter group: Small_ * `thumb720By480RenditionStatus` (_string_) Specifies the rendering status of the 720 x 480 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v24.0_ _Filter group: Small_ * `title` (_string_) Title of the file. _Available in: v24.0_ _Filter group: Small_ * `type` (_string_) _Available in: v24.0_ _Filter group: Small_ * `url` (_string_) URL to the file. _Available in: v24.0_ _Filter group: Small_ * `versionNumber` (_string_) Version number of the file. _Available in: v24.0_ _Filter group: Medium_ ### FileShare Description of a file share. * `entity` (_Group | RecordSummary | UserSummary_) Returns information about the user, record, or group the file is shared with. Value is one of the following: * Group * Record Summary * User Summary _Available in: v36.0_ One of: `Group`, `RecordSummary`, `UserSummary`. * `sharingType` (_string_) Permission level of sharing. Values are: * `C` —collaborator * `I` —sharing permission is determined by location. This generally occurs when the sharing permission is not set on the file, but on the library instead. This value is also used when the context user is the same as owner of the file. * `N` —no access * `V` —viewer _Available in: v24.0_ _Filter group: Small_ ### FileShareInput Specifies an entity to share a file with along with its sharing type (e.g., "V" for Viewer or "C" for Collaborator). * `id` (_string_) User ID to share a file with _Available in: v30.0_ * `sharingType` (_string_) Either `C` for collaborator or `V` for viewer _Available in: v30.0_ ### ImageFileDetail Image file details. * `height` (_integer_) Image’s height in pixels. _Available in: v39.0_ _Filter group: Small_ * `imageFormat` (_string_) Image’s format. _Available in: v39.0_ _Filter group: Small_ * `orientation` (_string_) Image’s EXIF orientation value, if present. _Available in: v39.0_ _Filter group: Small_ * `width` (_integer_) Image’s width in pixels. _Available in: v39.0_ _Filter group: Small_ ### ConnectFilePreviewFormatEnum The format of the preview. Values are: * `Audio` — Preview format is MP3. * `Jpg` — Preview format is JPG. * `Pdf` — Preview format is PDF. * `Svg` — Preview format is compressed SVG. * `Thumbnail` — Preview format is 240 x 180 PNG. * `ThumbnailBig` — Preview format is 720 x 480 PNG. * `ThumbnailTiny` — Preview format is 120 x 90 PNG. * `Video` — Preview format is MP4. _Available in: v35.0_ _Filter group: Small_ Type: `string`. Allowed values: `Audio`, `Jpg`, `Pdf`, `Svg`, `Thumbnail`, `ThumbnailBig`, `ThumbnailTiny`, `Video`. ### ConnectFilePreviewStatusEnum The availability status of the preview. Values are: * `Available` — Preview is available. * `InProgress` — Preview is being processed. * `NotAvailable` — Preview is unavailable. * `NotScheduled` — Generation of the preview isn’t scheduled yet. _Available in: v35.0_ _Filter group: Small_ Type: `string`. Allowed values: `Available`, `InProgress`, `NotAvailable`, `NotScheduled`. ### FolderPath A folder path. * `folderId` (_string (Id)_) ID of the folder. _Available in: v40.0_ _Filter group: Small_ * `folderName` (_string_) Name of the folder, or `null` for the root. _Available in: v40.0_ _Filter group: Small_ ### ConnectContenHubAuthenticationProtocolEnumContenthub Authentication protocol used for the repository. Values are: * `NoAuthentication` —Repository doesn’t require authentication. * `Oauth` —Repository uses OAuth authentication protocol. * `Password` —Repository uses user name and password authentication protocol. _Available in: v40.0_ _Filter group: Small_ Type: `string`. Allowed values: `NoAuthentication`, `Oauth`, `Password`. ### FilesConnectGroupTypeEnumContenthub Type of group. One of these values: * `Everybody`: Group is public to everybody. * `EverybodyInDomain`: Group is public to everybody in the same domain. * `Unknown`: Group type is unknown. Type: `string`. Allowed values: `Everybody`, `EverybodyInDomain`, `Unknown`. ### ConnectDirectoryEntryTypeEnumContenthub The type of entry. Value is `GroupEntry`. _Available in: v35.0_ _Filter group: Medium_ Type: `string`. Allowed values: `GroupEntry`, `UserEntry`. ### ConnectExternalItemSharingTypeEnumContenthub Sharing status for the external file. Values are: * `DomainSharing` —File is shared with the domain. * `PrivateSharing` —File is private or shared only with individuals. * `PublicSharing` —File is publicly shared. Value is `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Small_ Type: `string`. Allowed values: `DomainSharing`, `PrivateSharing`, `PublicSharing`. ### FilesConnectVariableTypeEnum Data type of the value of the field. _Available in: v35.0_ _Filter group: Small_ Type: `string`. Allowed values: `BooleanType`, `DateTimeType`, `DecimalType`, `HtmlType`, `IdType`, `IntegerType`, `StringType`, `UriType`, `XmlType`. ### FilesConnectRepositoryAuthentication Authentication information for a repository. * `authFlowUrl` (_string_) Depends on the `authProtocol`. * `NoAuthentication` — `null`. * `Oauth` — URL to start the OAuth flow. * `Password` — URL to the authentication settings for external systems. _Available in: v40.0_ _Filter group: Small_ * `authProtocol` (_object_) ConnectContenHubAuthenticationProtocolEnum Authentication protocol used for the repository. Values are: * `NoAuthentication` — Repository doesn’t require authentication. * `Oauth` — Repository uses OAuth authentication protocol. * `Password` — Repository uses user name and password authentication protocol. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ConnectContenHubAuthenticationProtocolEnum`. * `userHasAuthSettings` (_boolean_) Specifies whether the user has credentials or the administrator configured the external data source to use the same set of credentials for every user (`true`). Otherwise, `false`. _Available in: v40.0_ _Filter group: Small_ ### ConnectExternalItemSharingTypeEnum Sharing status for the external file. Values are: * `DomainSharing` — File is shared with the domain. * `PrivateSharing` — File is private or shared only with individuals. * `PublicSharing` — File is publicly shared. Value is `null` for non-external files or when `includeExternalFilePermissionsInfo` is `false`. _Available in: v35.0_ _Filter group: Small_ Type: `string`. Allowed values: `DomainSharing`, `PrivateSharing`, `PublicSharing`. ### RepositoryGroupSummary Detailed description of a group entry. * `domain` (_string_) Domain of the group. _Available in: v35.0_ _Filter group: Medium_ * `email` (_string_) Email of the group. _Available in: v35.0_ _Filter group: Small_ * `groupType` (_object_) FilesConnectGroupTypeEnum Type of group. Values are: * `Everybody` — Group is public to everybody. * `EverybodyInDomain` — Group is public to everybody in the same domain. * `Unknown` — Group type is unknown. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `FilesConnectGroupTypeEnum`. * `id` (_string_) ID of the group. _Available in: v35.0_ _Filter group: Small_ * `name` (_string_) Name of the group. _Available in: v35.0_ _Filter group: Medium_ * `type` (_string_) The type of entry. Value is `GroupEntry`. _Available in: v35.0_ _Filter group: Medium_ Allowed values: `GroupEntry`, `UserEntry`. Example: `GroupEntry`. ### ModerationFlagsCollection Collection of flags on a feed item, comment, or file. * `currentPageToken` (_string_) Token identifying the current page. _Available in: v40.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v40.0_ _Filter group: Small_ * `flags` (_array of ModerationFlagItem_) List of flag details. _Available in: v40.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ * `pageSize` (_integer_) Number of items per page. _Available in: v40.0_ _Filter group: Small_ ### OutOfOffice User's out-of-office message. * `message` (_string_) Out-of-office message for the user. _Available in: v40.0_ _Filter group: Small_ ### Photo Photo. * `fullEmailPhotoUrl` (_string (url)_) A temporary URL to the large profile picture that expires after 30 days. This URL is available to unauthenticated users. _Available in: v27.0_ _Filter group: Medium_ * `largePhotoUrl` (_string (url)_) URL to the large profile picture. The default width is 200 pixels, while the length is scaled so the original image proportions are maintained. If a user hasn’t uploaded a photo, this URL points to a default photo. If the user hasn’t uploaded a photo and the request header included X-Connect-Theme: Salesforce1, this URL points to a default photo based on a theme that the admin selected for the org. _Available in: v23.0_ _Filter group: Medium_ * `mediumPhotoUrl` (_string (url)_) URL to the medium profile picture. The default width is 160 pixels, and the height is scaled so the original image proportions are maintained. If a user hasn’t uploaded a photo, this URL points to a default photo. If the user hasn’t uploaded a photo and the request header included X-Connect-Theme: Salesforce1, this URL points to a default photo based on a theme that the admin selected for the org. _Available in: v37.0_ _Filter group: Small_ * `photoVersionId` (_string (Id)_) 18-character ID to that version of the photo. _Available in: v24.0_ _Filter group: Small_ * `smallPhotoUrl` (_string (url)_) URL to the small profile picture. The default size is 64x64 pixels. If a user hasn’t uploaded a photo, this URL points to a default photo. If the user hasn’t uploaded a photo and the request header included X-Connect-Theme: Salesforce1, this URL points to a default photo based on a theme that the admin selected for the org. _Available in: v23.0_ _Filter group: Small_ * `standardEmailPhotoUrl` (_string (url)_) A temporary URL to the small profile picture that expires after 30 days. This URL is available to unauthenticated users. _Available in: v27.0_ _Filter group: Small_ * `url` (_string (url)_) URL to a resource that returns a Photo response body: for example, `/services/data/v67.0/chatter/users/005D0000001LL8OIAW/photo`. _Available in: v27.0_ _Filter group: Small_ ### Reputation Reputation for a user. * `reputationLevel` (_object_) ReputationLevel User’s reputation level. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ReputationLevel`. * `reputationPoints` (_number (double)_) User's reputation points, which can be earned by performing different activities. _Available in: v32.0_ _Filter group: Small_ * `url` (_string (url)_) Connect REST API URL to the reputation. _Available in: v32.0_ _Filter group: Small_ ### Stamp A user stamp. * `description` (_string_) Description of the stamp. _Available in: v39.0–43.0_ _Filter group: Small_ * `id` (_string_) ID of the stamp. _Available in: v39.0–43.0_ _Filter group: Small_ * `imageUrl` (_string_) Image URL of the stamp. _Available in: v39.0–43.0_ _Filter group: Small_ * `label` (_string_) Label of the stamp. _Available in: v39.0–43.0_ _Filter group: Small_ ### Topic Topic. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z _Available in: v28.0_ _Filter group: Big_ * `description` (_string_) Description of the topic _Available in: v28.0_ _Filter group: Big_ * `id` (_string (Id)_) 18-character ID of the topic _Available in: v28.0_ _Filter group: Small_ * `images` (_object_) TopicImages Images associated with the topic _Available in: v32.0_ _Filter group: Medium_ Includes all fields of `TopicImages`. * `isBeingDeleted` (_boolean_) `true` if the topic is currently being deleted; `false` otherwise. After the topic is deleted, when attempting to retrieve the topic, the response is 404: Not Found. _Available in: v33.0_ _Filter group: Small_ * `name` (_string_) Name of the topic _Available in: v28.0_ _Filter group: Small_ * `nonLocalizedName` (_string_) Non-localized name of the topic _Available in: v36.0_ _Filter group: Medium_ * `talkingAbout` (_integer_) Number of people talking about this topic over the last two months, based on factors such as topic additions and comments on posts with the topic _Available in: v28.0_ _Filter group: Medium_ * `url` (_string (url)_) URL to the topic detail page _Available in: v29.0_ _Filter group: Small_ ### Group Chatter group. * `additionalLabel` (_string_) An extra label for the group, for example, “Archived,” “Private,” or “Private With Customers.” If there isn’t an extra label, the value is `null`. _Available in: v30.0_ _Filter group: Small_ * `announcement` (_object_) Announcement An announcement for the group. _Available in: v31.0_ _Filter group: Big_ Includes all fields of `Announcement`. * `bannerPhoto` (_object_) BannerPhoto The banner photo for the group. _Available in: v36.0_ _Filter group: Big_ Includes all fields of `BannerPhoto`. * `canHaveChatterGuests` (_boolean_) `true` if this group allows Chatter customers, `false` otherwise. _Available in: v23.0_ _Filter group: Small_ * `community` (_object_) Reference Information about the Experience Cloud site. Returns `null` if the group exists in the default site or if digital experiences isn’t enabled. _Available in: v26.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `description` (_string_) Text-only description of the group. _Available in: v23.0_ _Filter group: Big_ * `emailToChatterAddress` (_string_) Group’s email address for posting to this group by email. Returns `null` if Chatter emails and posting to Chatter by email aren’t both enabled in your organization. _Available in: v30.0_ _Filter group: Medium_ * `fileCount` (_integer_) Number of files posted to this group. The `fileCount` property is in the Group Detail response body _Available in: v24.0–27.0_ _Filter group: Big_ * `id` (_string_) 18-character ID of the group. _Available in: v23.0_ _Filter group: Small_ * `isArchived` (_boolean_) Specifies whether the group is archived (`true`) or not (`false`). _Available in: v29.0_ _Filter group: Big_ * `isAutoArchiveDisabled` (_boolean_) Specifies whether automatic archiving is disabled for the group (`true`) or not (`false`). _Available in: v29.0_ _Filter group: Big_ * `isBroadcast` (_boolean_) Specifies whether the group is a broadcast group (`true`) or not (`false`). In a broadcast group, only group owners and managers can post to the group. _Available in: v36.0_ _Filter group: Big_ * `lastFeedElementPostDate` (_string_) Date of the most recent feed element posted to the group in ISO 8601 format. _Available in: v31.0_ _Filter group: Big_ * `lastFeedItemPostDate` (_string_) Date of the most recent feed item posted to the group in ISO 8601 format. After API version 30.0, use `lastFeedElementPostDate`. _Available in: v24.0–30.0_ _Filter group: Big_ * `memberCount` (_integer_) Total number of group members. _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `myRole` (_string_) _Available in: v23.0_ _Filter group: Small_ Allowed values: `GroupManager`, `GroupOwner`, `NotAMember`, `NotAMemberPrivateRequested`, `StandardMember`. * `mySubscription` (_object_) Reference If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `name` (_string_) Name of the group. _Available in: v23.0_ _Filter group: Small_ * `owner` (_object_) UserSummary Information about the owner of the group. _Available in: v24.0_ _Filter group: Medium_ Includes all fields of `UserSummary`. * `photo` (_object_) Photo Information about the group photo. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `Photo`. * `type` (_string_) Value is `CollaborationGroup`. _Available in: v23.0_ _Filter group: Small_ * `url` (_string_) Relative URL string to the group. _Available in: v23.0_ _Filter group: Small_ * `visibility` (_string_) Values are: * `PrivateAccess` —Only members of the group can see posts to this group. * `PublicAccess` —All users within the Experience Cloud site can see posts to this group. * `Unlisted` —Reserved for future use. _Available in: v23.0_ _Filter group: Small_ Allowed values: `PrivateAccess`, `PublicAccess`, `UnlistedAccess`. ### RecordSummary Record summary. * `entityLabel` (_object_) EntityLabel Label of the record’s entity. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `EntityLabel`. * `id` (_string_) 18-character ID of the record. _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) Reference If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `name` (_string_) The localized name . _Available in: v23.0_ _Filter group: Small_ * `type` (_string_) Type of record, such as `CustomObject` or `ContentDocument`. _Available in: v23.0_ _Filter group: Small_ * `url` (_string_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ ### ConnectContenHubAuthenticationProtocolEnum Authentication protocol used for the repository. Values are: * `NoAuthentication` — Repository doesn’t require authentication. * `Oauth` — Repository uses OAuth authentication protocol. * `Password` — Repository uses user name and password authentication protocol. _Available in: v40.0_ _Filter group: Small_ Type: `string`. Allowed values: `NoAuthentication`, `Oauth`, `Password`. ### FilesConnectGroupTypeEnum The detailed information of a directory entry. _Available in: v35.0_ _Filter group: Medium_ Type: `string`. Allowed values: `Everybody`, `EverybodyInDomain`, `Unknown`. ### ModerationFlagItem Flag details on a feed item, comment, or file. * `createdBy` (_string_) ID of the user who flagged the item. _Available in: v40.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Date when the item was flagged. Format is ISO 8601. _Available in: v40.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the moderation flag. _Available in: v40.0_ _Filter group: Small_ * `moderationType` (_object_) ConnectNetworkModerationTypeEnum Type of moderation flag. Values are: * `FlagAsInappropriate` — Flag for inappropriate content. * `FlagAsSpam` — Flag for spam. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ConnectNetworkModerationTypeEnum`. * `note` (_string_) Note from user who flagged the item. _Available in: v40.0_ _Filter group: Small_ * `visibility` (_object_) ConnectNetworkModerationVisibilityEnum Visibility behavior of a flag for various user types. Values are: * `ModeratorsOnly` — The flag is visible only to users with moderation permissions on the flagged element or item. * `SelfAndModerators` — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ConnectNetworkModerationVisibilityEnum`. ### ReputationLevel Reputation level for a user. * `levelImageUrl` (_string (url)_) URL to the reputation level image. _Available in: v32.0_ _Filter group: Small_ * `levelName` (_string_) Name of the reputation level. _Available in: v32.0_ _Filter group: Small_ * `levelNumber` (_integer_) Reputation level number, which is the numerical rank of the level, with the lowest level at 1. Administrators define the reputation level point ranges. _Available in: v32.0_ _Filter group: Small_ ### TopicImages Images associated with a topic. * `coverImageUrl` (_string (url)_) URL to a topic’s cover image, which appears on the topic page. Both topics and managed topics can have cover images. _Available in: v32.0_ _Filter group: Small_ * `featuredImageUrl` (_string (url)_) URL to a managed topic’s featured image, which appears wherever you feature it, for example, on your Experience Cloud site home page. _Available in: v32.0_ _Filter group: Small_ ### Announcement An announcement. * `expirationDate` (_string (date-time)_) Date time in ISO 8601 format. The Salesforce UI displays an announcement until 11:59 p.m. on this date unless another announcement is posted first. The Salesforce UI ignores the time value in the `expirationDate`. However, you can use the time value to create your own display logic in your own UI. _Available in: v31.0_ _Filter group: Small_ * `feedElement` (_object_) FeedItem The feed element that contains the body of the announcement and its associated comments, likes, and so on. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `FeedItem`. * `id` (_string (Id)_) 18-character ID of the announcement. _Available in: v31.0_ _Filter group: Small_ * `isArchived` (_boolean_) Specifies whether the announcement is archived. _Available in: v36.0_ _Filter group: Small_ * `sendEmails` (_boolean_) Specifies whether the announcement is sent as an email to all group members. _Available in: v36.0_ _Filter group: Medium_ * `url` (_string (url)_) The URL to the announcement. _Available in: v33.0_ _Filter group: Small_ ### BannerPhoto A banner photo. * `bannerPhotoUrl` (_string (url)_) URL to the banner photo in a large format. This URL is available only to authenticated users. _Available in: v36.0_ _Filter group: Medium_ * `bannerPhotoVersionId` (_string (Id)_) 18-character version ID of the banner photo. _Available in: v36.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the banner photo. _Available in: v36.0_ _Filter group: Small_ ### EntityLabel An entity's label. * `label` (_string_) Localized singular label of the entity. _Available in: v40.0_ _Filter group: Small_ * `labelPlural` (_string_) Localized plural label of the entity. _Available in: v40.0_ _Filter group: Small_ ### ConnectNetworkModerationTypeEnum Type of moderation flag. Values are: * `FlagAsInappropriate` — Flag for inappropriate content. * `FlagAsSpam` — Flag for spam. _Available in: v40.0_ _Filter group: Small_ Type: `string`. Allowed values: `FlagAsInappropriate`, `FlagAsSpam`. ### ConnectNetworkModerationVisibilityEnum Visibility behavior of a flag for various user types. Values are: * `ModeratorsOnly` — The flag is visible only to users with moderation permissions on the flagged element or item. * `SelfAndModerators` — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item. _Available in: v40.0_ _Filter group: Small_ Type: `string`. Allowed values: `ModeratorsOnly`, `SelfAndModerators`. ### FeedItem A feed is made up of feed elements. A feed item is a type of feed element. * `actor` (_object_) AbstractActor The entity that created the feed item. Values are: * Record Summary —if a record (23.0) * User Summary —if a user (23.0) * Unauthenticated User —if a Chatter customer (24.0) If the actor is a user, a User Summary response body is returned, not a Record Summary of type user. _Filter group: Small_ Includes all fields of `AbstractActor`. * `attachment` (_string_) Depends on the `type` value of the attachment. Values include: * `Approval` — Feed Item Attachment: Approval (v27.0–31.0) * `BasicTemplate` — Feed Item Attachment: Basic Template (v27.0–31.0) * `Canvas` — Feed Item Attachment: Canvas Template (v29.0–31.0) * `CaseComment` — Feed Item Attachment: Case Comment (v24.0–31.0) * `Content` — Feed Item Attachment: Content or `null` if the content is unavailable (v23.0–31.0) * `DashboardComponent` — Feed Item Attachment: Dashboard (v24.0–31.0) * `EmailMessage` — Feed Item Attachment: Email Message (v29.0–31.0) * `Link` — Feed Item Attachment: Link (v23.0–31.0) * `Poll` — Feed Item Attachment: Poll (v26.0–31.0) * `RecordSnapshot` — Feed Item Attachment: Record Snapshot (v29.0–31.0) * `TrackedChange` — Feed Item Attachment: Tracked Change (v29.0–31.0) **Important**: As of API version 32.0, use the `capabilities` property. _Filter group: Medium_ * `body` (_object_) FeedItemBody Information about the feed element. _Available in: v22.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `canShare` (_boolean_) Indicates whether the feed item can be shared. If a feed item has multiple file attachments and at least one attachment has been deleted or is inaccessible, the feed item can’t be shared. The `canShare` value is incorrectly set to `true` in these cases. **Important**: As of API version 39.0, use the `isSharable` property. _Available in: v27.0–38.0_ _Filter group: Medium_ * `capabilities` (_object_) FeedElementCapabilitySet A container for all capabilities that can be included with a feed element. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedElementCapabilitySet`. * `clientInfo` (_object_) ClientInfo Information about the client app used to authenticate the connection. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ClientInfo`. * `comments` (_object_) CommentPage Comments for this feed item. **Important**: As of API version 32.0, use the `capabilities.comments.page` property. _Available in: v23.0–31.0_ _Filter group: Small_ Includes all fields of `CommentPage`. * `createdDate` (_string_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z _Available in: v23.0_ _Filter group: Small_ * `currentUserLike` (_object_) Reference **Note**: This property is no longer available as of version 24.0. Use the `myLike` property instead. A reference to a like object if applicable, `null` otherwise. _Available in: v23.0–24.0_ Includes all fields of `ReferenceChatter`. * `event` (_boolean_) `true` if feed item created due to an event change, `false` otherwise. _Available in: v23.0_ _Filter group: Medium_ * `feedElementType` (_object_) ConnectFeedElementTypeEnum Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element. One of these values: * `Bundle` — A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values. * `FeedItem` — A feed item has a single parent and is scoped to oneExperience Cloud site or across all Experience Cloud sites. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values. * `Recommendation` — A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user. _Available in: v31.0_ Example: `FeedItem`. Includes all fields of `ConnectFeedElementTypeEnum`. Example: `FeedItem`. * `hasVerifiedComment` (_boolean_) `true` if the feed item has a verified comment, otherwise `false`. _Available in: v41.0_ _Filter group: Small_ * `header` (_object_) FeedItemBody The header is the title of the post. This property contains renderable plain text for all the segments of the message. If a client doesn't know how to render a feed element type, it should render this text. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedItemBody`. * `id` (_string_) 18-character ID of the feed item. _Available in: v23.0_ _Filter group: Small_ * `isBookmarkedByCurrentUser` (_boolean_) `true` if the context user has bookmarked this feed item, `false` otherwise. **Important**: As of API version 32.0, use the `capabilities.bookmarks.isBookmarkedByCurrentUser` property. _Available in: v24.0–31.0_ _Filter group: Medium_ * `isDeleteRestricted` (_boolean_) Returns `true` if the context user can’t delete a feed item. If it returns `false`, possibly the context users can delete the feed item. _Available in: v25.0_ _Filter group: Medium_ * `isLikedByCurrentUser` (_boolean_) `true` if the context user has liked this feed item, `false` otherwise. As of API version 32.0, use the `capabilities.chatterLikes.isLikedByCurrentUser` property. _Available in: v23.0–31.0_ _Filter group: Medium_ * `isSharable` (_boolean_) Indicates whether the feed item can be shared. _Available in: v39.0_ _Filter group: Medium_ * `likes` (_object_) LikePage Likes for this feed item, **Important**: As of API version 32.0, use the `capabilities.chatterLikes.page` property. _Available in: v23.0–31.0_ _Filter group: Medium_ Includes all fields of `LikePage`. * `likesMessage` (_object_) LikeMessageBody A message body that describes who likes the feed item. As of API version 32.0, use the `capabilities.chatterLikes.likesMessage` property. _Available in: v27.0–31.0_ _Filter group: Small_ Includes all fields of `LikeMessageBody`. * `moderationFlags` (_object_) ModerationFlags Flags for this feed item. Moderators can view and act on flagged items. If the `communityModeration` property of the Features response body is `false`, this property is `null`. **Important**: As of API version 32.0, use the `capabilities.moderation.moderationFlags` property. _Available in: v29.0–31.0_ _Filter group: Big_ Includes all fields of `ModerationFlags`. * `modifiedDate` (_string_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v23.0_ _Filter group: Small_ * `myLike` (_object_) Reference If the context user has liked the comment, this property is a reference to the specific like, `null` otherwise. **Important**: As of API version 32.0, use the `capabilities.chatterLikes.myLike` property. _Available in: v23.0–31.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `originalFeedItem` (_object_) Reference A reference to the original feed item if this feed item is a shared feed item, `null` otherwise. _Available in: v24.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `originalFeedItemActor` (_object_) AbstractActor Value depends on type of original feed item. Values are: * Record Summary –if original feed item is a record * User Summary –if original feed item is a user * Unauthenticated User —if original feed item is from a Chatter customer * `null` if this feed item is not a shared feed item _Available in: v24.0_ _Filter group: Medium_ Includes all fields of `AbstractActor`. * `parent` (_object_) AbstractIdable Value depends on type of parent. Values are: * File Summary—if parent is a file * Group—if parent is a group * Record Summary—if parent is a record * User Summary—if parent is a user **Note**: If the parent is a user, a User Summary response body is returned, not a Record Summary of type user. The same applies for both groups and files. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `AbstractIdable`. * `photoUrl` (_string (url)_) URL of the photo associated with the feed item. _Available in: v23.0_ _Filter group: Medium_ * `preamble` (_string_) The preamble is the title of the post. This property contains renderable plain text for all the segments of the message, for example, “App Builders - Pam Jones”. In API versions to 28.0, use the `/body/text` property as the default case for rendering text. In API versions 29.0–30.0, use the `/preamble/text` property as the default case for rendering text. In API versions 31.0 and later, use the `/header/text` property as the default case for rendering text. _Available in: v27.0–30.0_ _Filter group: Medium_ * `relativeCreatedDate` (_string_) Created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.” . _Available in: v28.0_ _Filter group: Small_ * `topics` (_object_) FeedItemTopics Topics for this feed item. **Important**: As of API version 32.0, use the `capabilities.topics.items` property. _Available in: v28.0–31.0_ _Filter group: Medium_ Includes all fields of `FeedItemTopics`. * `type` (_object_) ConnectFeedItemTypeEnum The `type` property always returns all types, regardless of API version. However, not all types are valid with all API versions. **Important**: As of API version 32.0, use the `capabilities` property to determine what can be done with a feed item. See [Feeds and Feed Elements](/docs/platform/connect-rest-api/guide/features_feeds_feed_elements#capabilities). Values are: * `ActivityEvent` — Feed item generated in Case Feed when an event or task associated with a parent record with a feed enabled is created or updated. * `AdvancedTextPost` — A feed item with advanced text formatting, such as a group announcement post. * `ApprovalPost` — Feed item with an approval capability. Approvers can act on the feed item parent. * `AttachArticleEvent` — Feed item generated when an article is attached to a case in Case Feed. * `BasicTemplateFeedItem` — Feed item with an enhanced link capability. * `CallLogPost` — Feed item generated when a call log is saved to a case in Case Feed. * `CanvasPost` — Feed item generated by a canvas app in the publisher or from Connect REST API or Connect in Apex. The post itself is a link to a canvas app. * `CaseCommentPost` — Feed item generated when a case comment is saved in Case Feed. * `ChangeStatusPost` — Feed item generated when the status of a case is changed in Case Feed. * `ChatTranscriptionPost` — Feed item generated in Case Feed when a Live Agent chat transcript is saved to a case. * `CollaborationGroupCreated` — Feed item generated when a new public group is created. Contains a link to the new group. * `CollaborationGroupUnarchived` — Deprecated. Feed item generated when an archived group is activated. * `ContentPost` — Feed item with a content capability. * `CreateRecordEvent` — Feed item that describes a record created in the publisher. * `DashboardComponentAlert` — Feed item with a dashboard alert. * `DashboardComponentSnapshot` — Feed item with a dashboard component snapshot capability. * `EmailMessageEvent` — Feed item generated when an email is sent from a case in Case Feed. * `FacebookPost` — Deprecated. Feed item generated when a Facebook post is created from a case in Case Feed. * `LinkPost` — Feed item with a link capability. * `MilestoneEvent` — Feed item generated when a case milestone is either completed or reaches a violation status. Contains a link to the case milestone. * `PollPost` — Feed item with a poll capability. Viewers of the feed item are allowed to vote on the options in the poll. * `ProfileSkillPost` — Feed item generated when a skill is added to a user’s profile. * `QuestionPost` — Feed item generated when a question is asked. As of API version 33.0, a feed item of this type can have a content capability and a link capability. * `ReplyPost` — Feed item generated by a Chatter Answers reply. * `RypplePost` — Feed item generated when a user posts thanks. * `SocialPost` — Feed item generated when a social post is created from a case in Case Feed. * `TextPost` — Feed item containing text only. * `TrackedChange` — Feed item created when one or more fields on a record have been changed. * `UserStatus` — Deprecated. A user's post to their own profile. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `ConnectFeedItemTypeEnum`. * `url` (_string_) URL to this feed item. _Available in: v23.0_ _Filter group: Small_ * `visibility` (_object_) ConnectFeedItemVisibilityEnum Who can see this feed item. Values are: * `InternalUsers` — If digital experiences is enabled, only members of the default, internal site can see the feed item. * `AllUsers` — If digital experiences is enabled, all members of the site can see the feed item. _Available in: v26.0_ _Filter group: Small_ Includes all fields of `ConnectFeedItemVisibilityEnum`. ### AbstractActor Describing a person or thing that can act or be acted on in the organization. May or may not correspond to an actual record in the organization, as some actors, such as certain system users, are synthetic in nature. * `name` (_string_) Repository name. _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) A fixed type name for this object. Check this value to determine the shape of a response body. _Available in: v23.0_ _Filter group: Small_ ### FeedItemBody Chatter feed item body. * `isRichText` (_boolean_) Indicates if the body is rich text. _Available in: v35.0_ _Filter group: Small_ * `messageSegments` (_array of MessageSegment_) Collection of message segments, based on type. Segments can be one or more of the following: * Message Segment: Entity Link * Message Segment: Field Change * Message Segment: Field Change Name * Message Segment: Field Change Value * Message Segment: Hashtag * Message Segment: Inline Image (version 35.0 and later) * Message Segment: Link * Message Segment: Markup Begin (version 35.0 and later) * Message Segment: Markup End (version 35.0 and later) * Message Segment: Mention * Message Segment: More Changes * Message Segment: Text The collection of message segments could contain message segment types introduced in later API versions. All message segment types are guaranteed to have text and type properties that are available in version 23.0 and later. If a client encounters an unknown message segment type, it can render the text value as a fallback. _Available in: v23.0_ _Filter group: Medium_ * `text` (_string_) Display-ready text of the message. Use this text if you don’t want to process the message segments. _Available in: v23.0_ _Filter group: Small_ ### FeedElementCapabilitySet A container for all capabilities that can be included with a feed element. If a capability value is null, that indicates that the capability can not exist on that feed element. If the capability exists but contains null values, then the feed element may have that capability's feature, but that it has not yet been applied. For example, a feed element with a null associated actions capability indicates that no actions may be added to that feed element, whereas an empty associated actions capability means that the feed element may have actions, but none have been provided. Note, that in REST, this output is treated in a special way: null values are not included in the output (effectively making this a traditional JSON map). * `approval` (_object_) ApprovalCapability If a feed element has this capability, it includes information about an approval. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ApprovalCapability`. * `associatedActions` (_object_) AssociatedActionsCapability If a feed element has this capability, it has platform actions associated with it. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `AssociatedActionsCapability`. * `banner` (_object_) BannerCapability If this feed element has this capability, it has a banner motif and style. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `BannerCapability`. * `bookmarks` (_object_) BookmarksCapability If a feed element has this capability, the context user can bookmark it. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `BookmarksCapability`. * `bundle` (_object_) AbstractBundleCapability If a feed element has this capability, the feed element may be a group of other feed elements condensed into one. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `AbstractBundleCapability`. * `callCollaboration` (_object_) CallCollaborationCapability If a feed element has this capability, it has a recording comment. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `CallCollaborationCapability`. * `canvas` (_object_) CanvasCapability If a feed element has this capability, it renders a canvas app. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `CanvasCapability`. * `caseComment` (_object_) CaseCommentCapability If a feed element has this capability, it has a case comment on the case feed. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `CaseCommentCapability`. * `chatterLikes` (_object_) ChatterLikesCapability If a feed element has this capability, the context user can like it. Exposes information about existing likes. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `ChatterLikesCapability`. * `close` (_object_) CloseCapability If a feed element has this capability, users with permission can close it. _Available in: v43.0_ _Filter group: Small_ Includes all fields of `CloseCapability`. * `comments` (_object_) CommentsCapability If a feed element or comment has this capability, the context user can add a comment. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `CommentsCapability`. * `dashboardComponentSnapshot` (_object_) DashboardComponentSnapshotCapability If a feed element has this capability, it has a dashboard component snapshot. A snapshot is a static image of a dashboard component at a specific point in time. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `DashboardComponentSnapshotCapability`. * `directMessage` (_object_) DirectMessageCapability If a feed element has this capability, it’s a direct message. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `DirectMessageCapability`. * `edit` (_object_) EditCapability If a feed element has this capability, users who have permission can edit it. _Available in: v34.0_ _Filter group: Small_ Includes all fields of `EditCapability`. * `emailMessage` (_object_) EmailMessageCapability If a feed element has this capability, it has an email message from a case. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `EmailMessageCapability`. * `enhancedLink` (_object_) EnhancedLinkCapability If a feed element has this capability, it has a link that may contain supplemental information like an icon, a title, and a description. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `EnhancedLinkCapability`. * `extensions` (_object_) ExtensionsCapability If a feed element has this capability, it has one or more extension attachments. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ExtensionsCapability`. * `feedEntityShare` (_object_) FeedEntityShareCapability If a feed element or comment has this capability, a feed entity is shared with it. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `FeedEntityShareCapability`. * `files` (_object_) MultipleContentCapability If a feed element has this capability, it has one or more file attachments. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `MultipleContentCapability`. * `interactions` (_object_) InteractionsCapability If a feed element has this capability, it has information about user interactions. _Available in: v37.0_ _Filter group: Small_ Includes all fields of `InteractionsCapability`. * `link` (_object_) LinkCapability If a feed element has this capability, it has a link. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `LinkCapability`. * `mediaReferences` (_object_) MediaReferenceCapability If a feed element has this capability, it has one or more media references. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `MediaReferenceCapability`. * `moderation` (_object_) ModerationCapability If a feed element has this capability, users in the Experience Cloud site can flag the feed element for moderation. This response body also includes information about the flagged content. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `ModerationCapability`. * `mute` (_object_) MuteCapability If a feed element has this capability, users can mute it. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `MuteCapability`. * `origin` (_object_) OriginCapability If a feed element has this capability, it was created by a feed action. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `OriginCapability`. * `pin` (_object_) PinCapability If a feed element has this capability, users who have permission can pin it to a feed. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `PinCapability`. * `poll` (_object_) PollCapability If a feed element has this capability, the feed element can include a poll for voting. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `PollCapability`. * `questionAndAnswers` (_object_) QuestionAndAnswersCapability If a feed element has this capability, it has a question and comments on the feed element are answers to the question. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `QuestionAndAnswersCapability`. * `readBy` (_object_) ReadByCapability If a feed element has this capability, the context user can mark it as read. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `ReadByCapability`. * `recommendations` (_object_) RecommendationsCapability If a feed element has this capability, it has a recommendation. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `RecommendationsCapability`. * `recordSnapshot` (_object_) RecordSnapshotCapability If a feed element has this capability, it contains all the snapshotted fields of a record for a single create record event. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `RecordSnapshotCapability`. * `socialPost` (_object_) SocialPostCapability If a feed element has this capability, it can interact with a social post on a social network. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `SocialPostCapability`. * `status` (_object_) StatusCapability If a feed post or comment has this capability, it has a status that determines its visibility. _Available in: v37.0_ _Filter group: Small_ Includes all fields of `StatusCapability`. * `topics` (_object_) TopicsCapability If a feed element has this capability, the context user can add topics to it. Topics help users organize and discover conversations. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `TopicsCapability`. * `trackedChanges` (_object_) TrackedChangesCapability If a feed element has this capability, it contains all changes to a record for a single tracked change event. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `TrackedChangesCapability`. * `upDownVote` (_object_) UpDownVoteCapability If a feed post or comment has this capability, users can upvote or downvote it. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `UpDownVoteCapability`. ### ClientInfo Client information. * `applicationName` (_string_) Name of app used for authentication. _Available in: v23.0_ _Filter group: Small_ * `applicationUrl` (_string (url)_) URL to the app used for authentication _Available in: v23.0_ _Filter group: Small_ ### CommentPage A page of comments. * `comments` (_array of Comment_) Collection of comments. **Important**: Use the `items` property as of version 32.0. _Available in: v23.0–31.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token identifying the current page. _Available in: v37.0_ _Filter group: Medium_ * `currentPageUrl` (_string_) URL to the current page of comments, that is, the most recent comments. The default is 25 comments per page. _Available in: v23.0_ _Filter group: Medium_ * `items` (_array of Comment_) Collection of comments. _Available in: v32.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v37.0_ _Filter group: Small_ * `nextPageUrl` (_string_) URL to the next page of comments, that is, older comments. The default is 25 comments per page. If you want to read more of the comments in search results, all the comments in the thread are refreshed, not just the ones that match the search term. Avoid using `nextPageUrl` until the comments are refreshed. _Available in: v23.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token identifying the previous page, or `null` if there isn’t a previous page. _Available in: v44.0_ _Filter group: Small_ * `previousPageUrl` (_string_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v44.0_ _Filter group: Small_ * `total` (_integer_) Total number of published comments across all pages for the parent feed item. _Available in: v23.0_ _Filter group: Small_ ### ConnectFeedElementTypeEnum The type of feed element this input represents. The only valid value is `FeedItem`. Required when creating a feed item (POST). Optional when updating a feed item (PATCH) _Available in: v31.0_ Type: `string`. Allowed values: `Bundle`, `FeedItem`, `Recommendation`. ### LikePage Page of Chatter likes. * `currentPageToken` (_string_) Token identifying the current page. _Available in: v37.0_ _Filter group: Medium_ * `currentPageUrl` (_string_) URL to the current page of likes. _Available in: v23.0_ _Filter group: Medium_ * `items` (_array of Like_) Collection of likes. _Available in: v32.0_ _Filter group: Small_ * `likes` (_array of Like_) Collection of likes. **Important**: As of API version 32.0, use the `items` property. _Available in: v23.0–31.0_ _Filter group: Small_ * `myLike` (_object_) Reference **Note**: This field is no longer available as of version 24.0. Either returns a reference to the specific like or returns `null`. _Available in: v23.0–24.0_ Includes all fields of `ReferenceChatter`. * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v37.0_ _Filter group: Small_ * `nextPageUrl` (_string_) URL to the next page of likes. _Available in: v23.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token identifying the previous page, or `null` if there isn’t a previous page. _Available in: v37.0_ _Filter group: Medium_ * `previousPageUrl` (_string_) URL to the previous page of likes. _Available in: v23.0_ _Filter group: Medium_ * `total` (_integer_) Total number of likes for the item. _Available in: v23.0_ _Filter group: Small_ ### LikeMessageBody Chatter like message body. * `messageSegments` (_array of MessageSegment_) Collection of message segments, based on type. Segments can be one or more of the following: * Message Segment: Entity Link * Message Segment: Resource Link * Message Segment: Text _Available in: v27.0_ _Filter group: Medium_ * `text` (_string_) Text summary of the users who like the feed item or comment. For example, “You like this.” or “Renee Moreau, Gordon Johnson, and Pam Jones like this.” _Available in: v27.0_ _Filter group: Small_ ### AbstractIdable Describing a person or thing that can act or be acted on in the organization. Corresponds directly to an actual record in the organization with an addressible ID. * `id` (_string (Id)_) 18-character ID of the object _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) Reference If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `name` (_string_) Repository name. _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) A fixed type name for this object. Check this value to determine the shape of a response body. _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) The Connect REST API URL resource for this object. _Available in: v23.0_ _Filter group: Small_ ### FeedItemTopics Feed item topics. **Important**: This response body isn’t available in version 32.0 and later. In version 32.0 and later, Topics Capability is used. * `canAssignTopics` (_boolean_) `true` if a topic can be assigned to the feed item, `false` otherwise _Available in: v28.0–31.0_ _Filter group: Small_ * `topics` (_array of Topic_) Collection of topics _Available in: v28.0–31.0_ _Filter group: Small_ ### ConnectFeedItemTypeEnum Specifies the type of a feed item. Type: `string`. Allowed values: `ActivityEvent`, `AdvancedTextPost`, `AnnouncementPost`, `ApprovalPost`, `AttachArticleEvent`, `AttachExternalDocumentEvent`, `BasicTemplateFeedItem`, `CallLogPost`, `CanvasPost`, `CaseCommentPost`, `ChangeStatusPost`, `ChatTranscriptPost`, `CollaborationGroupCreated`, `CollaborationGroupUnarchived`, `ContentPost`, `CreateRecordEvent`, `DashboardComponentAlert`, `DashboardComponentSnapshot`, `EmailMessageEvent`, `FacebookPost`, `LinkPost`, `MilestoneEvent`, `PollPost`, `ProfileSkillPost`, `QuestionPost`, `ReplyPost`, `RypplePost`, `SocialPost`, `TestItem`, `TextPost`, `TrackedChange`, `UserStatus`. ### ConnectFeedItemVisibilityEnum Specifies the type of users who can see a feed item. Type: `string`. Allowed values: `AllUsers`, `InternalUsers`. ### MessageSegment Superclass of all message segment representations. * `text` (_string_) Empty string, `""`, for segments of this type. _Available in: v35.0_ _Filter group: Small_ * `type` (_ConnectMessageSegmentTypeEnum_) ### ApprovalCapability If a feed element has this capability, it includes information about an approval. * `id` (_string (Id)_) The work item ID. The work item ID is `null` if there isn’t a pending work item associated with the approval record. _Available in: v32.0_ _Filter group: Small_ * `postTemplateFields` (_array of ApprovalPostTemplateField_) The details of the approval post template field. _Available in: v32.0_ _Filter group: Small_ * `processInstanceStepId` (_string (Id)_) The process instance step ID. The associated record represents one step in an approval process. _Available in: v32.0_ _Filter group: Small_ * `status` (_object_) ConnectWorkflowProcessStatusEnum The status of the approval. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ConnectWorkflowProcessStatusEnum`. ### AssociatedActionsCapability If a feed element has this capability, it has platform actions associated with it. * `platformActionGroups` (_array of PlatformActionGroup_) The platform action groups associated with a feed element. Platform action groups are returned in the order specified in the Associated Actions Capability Input request body. _Available in: v33.0_ _Filter group: Medium_ ### BannerCapability If this feed element has this capability, it has a banner motif and style. * `motif` (_object_) Motif A banner motif. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `Motif`. * `style` (_object_) ConnectBannerStyleEnum Decorates a feed item with a color and set of icons. * `Announcement` — An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `ConnectBannerStyleEnum`. ### BookmarksCapability If a feed element has this capability, the context user can bookmark it. * `isBookmarkedByCurrentUser` (_boolean_) Indicates whether the feed element has been bookmarked by the context user (`true`) or not (`false`). _Available in: v32.0_ _Filter group: Small_ ### AbstractBundleCapability Existence of this capability on a Feed Element means the Feed Element may be a group of other Feed Elements condensed into one. The type of nesting depends on the bundle type. Discriminator: `bundleType` selects the concrete type. Mapping: `GenericBundle` → `GenericBundleCapability`, `TrackedChanges` → `TrackedChangeBundleCapability`. * `bundleType` (_object_) ConnectBundleTypeEnum Type of bundle. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `ConnectBundleTypeEnum`. * `page` (_object_) FeedElementCollection A collection of feed elements. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `FeedElementCollection`. * `totalElements` (_integer_) The total number of feed elements that this bundle aggregates. _Available in: v31.0_ _Filter group: Small_ ### CallCollaborationCapability If a feed element has this capability, it has a recording comment. * `commentEndTime` (_integer_) End time of the comment on the media player, in seconds. _Available in: v51.0_ _Filter group: Small_ * `commentStartTime` (_integer_) Start time of the comment on the media player, in seconds. _Available in: v51.0_ _Filter group: Small_ ### CanvasCapability If a feed element has this capability, it renders a canvas app. * `description` (_string_) A description of the canvas app. The maximum size is 255 characters. _Available in: v32.0_ _Filter group: Small_ * `developerName` (_string_) The API name (developer name) of the client app. _Available in: v32.0_ _Filter group: Small_ * `height` (_string_) The height of the canvas app in pixels. _Available in: v32.0_ _Filter group: Small_ * `icon` (_object_) Icon The icon for the canvas app. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `Icon`. * `namespacePrefix` (_string_) A unique namespace prefix for the canvas app. _Available in: v32.0_ _Filter group: Small_ * `parameters` (_string_) JSON parameters passed to the canvas app. _Available in: v32.0_ _Filter group: Small_ * `thumbnailUrl` (_string (url)_) A thumbnail URL to a preview image. The maximum thumbnail size is 120 pixels by 120 pixels. _Available in: v32.0_ _Filter group: Small_ * `title` (_string_) A title for the canvas link. _Available in: v32.0_ _Filter group: Small_ ### CaseCommentCapability If a feed element has this capability, it has a case comment on the case feed. * `actorType` (_object_) ConnectCaseActorTypeEnum Specifies the type of user who made the comment. * `Customer` — if a Chatter customer made the comment * `CustomerService` — if a service representative made the comment _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ConnectCaseActorTypeEnum`. * `createdBy` (_object_) UserDetail Information about the user who created the comment. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `UserDetail`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z. _Available in: v32.0_ _Filter group: Small_ * `eventType` (_object_) ConnectCaseCommentEventTypeEnum Specifies an event type for a comment in the case feed. * `NewInternal` — A case comment that has newly been marked Internal Only. * `NewPublished` — A newly published case comment. * `NewPublishedByCustomer` — A case comment by a customer that was newly published. * `PublishExisting` — An existing case comment that was republished. * `PublishExistingByCustomer` — An existing case comment by a customer that was republished. * `UnpublishExistingByCustomer` — An existing case comment by a customer that was unpublished. * `UnpublishExsiting` — An existing case comment that was unpublished. Unfortunately, this typo is in the code, not the documentation. Use this spelling in your code. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ConnectCaseCommentEventTypeEnum`. * `id` (_string (Id)_) 18-character ID of case comment. _Available in: v32.0_ _Filter group: Small_ * `published` (_boolean_) Specifies whether the comment has been published. _Available in: v32.0_ _Filter group: Small_ * `text` (_string_) Text of the case comment. _Available in: v32.0_ _Filter group: Small_ ### ChatterLikesCapability If a feed element has this capability, the context user can like it. Exposes information about existing likes. * `isLikedByCurrentUser` (_boolean_) Indicates whether the feed element is liked by the context user (`true`) or not (`false`). _Available in: v32.0_ _Filter group: Small_ * `likesMessage` (_object_) LikeMessageBody A message body that describes who likes the feed element. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `LikeMessageBody`. * `myLike` (_object_) Reference If the context user has liked the feed element, this property is a reference to the specific like, `null` otherwise. _Available in: v32.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `page` (_object_) LikePage Likes information for this feed element. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `LikePage`. ### CloseCapability If a feed element has this capability, users with permission can close it. Users can’t edit (specifically the feed item body or title), comment on, or delete a closed feed element. If the closed feed element is a poll, users can’t vote on it. Users can’t edit (specifically the comment body) or delete a comment on a closed feed element or select or remove it as best answer. Admins and moderators can edit and delete closed feed elements and comments on closed feed elements. Admins and moderators can select or remove the best answer status on comments on closed feed elements. * `canContextUserUpdateIsClosed` (_boolean_) Specifies whether the context user has permission to set the feed element to closed (`true`) or not (`false`). _Available in: v43.0_ _Filter group: Small_ * `isClosed` (_boolean_) Specifies whether the feed element is closed (`true`) or not (`false`). _Available in: v43.0_ _Filter group: Small_ ### CommentsCapability If a feed element or comment has this capability, the context user can add a comment. * `page` (_object_) CommentPage The comments information for this feed element or comment. Threaded comments are supported in version 44.0 and later. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `CommentPage`. ### DashboardComponentSnapshotCapability If a feed element has this capability, it has a dashboard component snapshot. A snapshot is a static image of a dashboard component at a specific point in time. * `dashboardComponentSnapshot` (_object_) DashboardComponentSnapshot The dashboard component snapshot. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `DashboardComponentSnapshot`. ### DirectMessageCapability If a feed element has this capability, it’s a direct message. * `memberChanges` (_object_) DirectMessageMembershipActivityCollection Member activities of the direct message, with the most recent activity first. _Available in: v40.0_ _Filter group: Big_ Includes all fields of `DirectMessageMembershipActivityCollection`. * `members` (_object_) DirectMessageMemberCollection Members included in the direct message. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `DirectMessageMemberCollection`. * `originalMembers` (_object_) DirectMessageMemberCollection Original members of the direct message. _Available in: v40.0_ _Filter group: Big_ Includes all fields of `DirectMessageMemberCollection`. * `subject` (_string_) Subject of the direct message. _Available in: v39.0_ _Filter group: Small_ ### EditCapability If a feed element or comment has this capability, it can be edited by users who have permission. * `isEditableByMeUrl` (_string (url)_) The URL to check if the context user is able to edit this feed element or comment. _Available in: v34.0_ _Filter group: Medium_ * `isEditRestricted` (_boolean_) Specifies whether editing this feed element or comment is restricted. If `true`, the context user can’t edit this feed element or comment. If `false`, the context user may or may not have permission to edit this feed element or comment. To determine if a feed element or comment is editable by the context user, use the Feed Elements, Editability or Comment Capability, Editability resource. _Available in: v34.0_ _Filter group: Small_ * `lastEditedBy` (_object_) UserDetail Who last edited this feed element or comment. _Available in: v34.0_ _Filter group: Small_ Includes all fields of `UserDetail`. * `lastEditedDate` (_string (date-time)_) The most recent edit date of this feed element or comment. Format is ISO 8601. _Available in: v34.0_ _Filter group: Small_ * `latestRevision` (_integer_) The most recent revision of this feed element or comment. _Available in: v34.0_ _Filter group: Small_ * `relativeLastEditedDate` (_string_) Relative last edited date, for example, “2h ago.” _Available in: v34.0_ _Filter group: Small_ ### EmailMessageCapability If a feed element has this capability, it has an email message from a case. * `attachments` (_array of EmailAttachment_) Attachments in the email message. _Available in: v36.0_ _Filter group: Big_ * `automationType` (_object_) ConnectEmailMessageAutomationTypeEnum Automation type of the email message. Values are: * `aiAssisted` — The email message was created with the assistance of AI. * `aiAutomated` — The email message was created automatically by AI. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ConnectEmailMessageAutomationTypeEnum`. * `bccAddresses` (_array of EmailAddress_) BCC addresses for the email message. _Available in: v36.0_ _Filter group: Small_ * `body` (_string_) Body of the email message. _Available in: v36.0_ _Filter group: Big_ * `ccAddresses` (_array of EmailAddress_) CC addresses for the email message. _Available in: v36.0_ _Filter group: Small_ * `direction` (_object_) ConnectEmailMessageDirectionEnum Direction of the email message. Values are: * `Inbound` — An inbound message (sent by a customer). * `Outbound` — An outbound message (sent to a customer by a support agent). _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ConnectEmailMessageDirectionEnum`. * `emailMessageId` (_string_) ID of the email message. _Available in: v32.0_ _Filter group: Small_ * `emailMessageSize` (_string_) Size of a case’s email message HTML body. * `Large` — `UseLargeHtmlBody` permission is set, HTML body exceeds 131K characters, and HTML email display is enabled. * `Normal` — Email message doesn’t meet the `Large` criteria. _Available in: v66.0_ _Filter group: Small_ * `emailSize` (_object_) ConnectEmailMessageSizeEnum Size of a case’s email message HTML body. Values are: * `Large` — `UseLargeHtmlBody` permission is set, HTML body exceeds 131K characters, and HTML email display is enabled. * `Normal` — Email message doesn’t meet the `Large` criteria. _Available in: v66.0_ _Filter group: Small_ Includes all fields of `ConnectEmailMessageSizeEnum`. * `fromAddress` (_object_) EmailAddress From address for the email message. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `EmailAddress`. * `htmlExpandEmailThread` (_integer_) Start location of previous email thread. _Available in: v47.0_ _Filter group: Small_ * `isRichText` (_boolean_) Indicates whether the body of the email message is in rich text format. _Available in: v36.0_ _Filter group: Small_ * `status` (_object_) ConnectEmailMessageStatusEnum Status of an email message on a case. _Available in: v47.0_ _Filter group: Small_ Includes all fields of `ConnectEmailMessageStatusEnum`. * `subject` (_string_) Subject of the email message. _Available in: v32.0_ _Filter group: Small_ * `textBody` (_string_) Body of the email message. **Important**: In version 36.0 and later, use the `body` property. _Available in: v32.0–35.0_ _Filter group: Big_ * `toAddresses` (_array of EmailAddress_) To addresses of the email message. _Available in: v32.0_ _Filter group: Small_ * `totalAttachments` (_integer_) Total number of attachments in the email message. _Available in: v38.0_ _Filter group: Small_ ### EnhancedLinkCapability If a feed element has this capability, it has a link that may contain supplemental information like an icon, a title, and a description. * `description` (_string_) A description with a 500 character limit. _Available in: v32.0_ _Filter group: Small_ * `icon` (_object_) Icon An icon. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `Icon`. * `linkRecordId` (_string (Id)_) An ID associated with the link if the link URL refers to a Salesforce record. _Available in: v32.0_ _Filter group: Small_ * `linkUrl` (_string (url)_) A link URL to a detail page if available content can’t display inline. _Available in: v32.0_ _Filter group: Small_ * `title` (_string_) A title to a detail page. _Available in: v32.0_ _Filter group: Small_ ### ExtensionsCapability If a feed element has this capability, it has one or more extensions associated with it. * `items` (_array of Extension_) Collection of extensions. _Available in: v40.0_ _Filter group: Small_ ### FeedEntityShareCapability If a feed element or comment has this capability, a feed entity is shared with it. * `feedEntity` (_FeedItemSummary | FeedEntityNotAvailableSummary_) The summary of the feed entity that is shared with the feed element or comment. One of these response bodies: * Feed Item Summary * Feed Entity Not Available Summary _Available in: v39.0_ _Filter group: Small_ One of: `FeedItemSummary`, `FeedEntityNotAvailableSummary`. ### MultipleContentCapability If a feed element has this capability, it has one or more file attachments. * `items` (_array of Content_) Collection of files. _Available in: v36.0_ _Filter group: Small_ ### InteractionsCapability If a feed element has this capability, it has information about user interactions. * `count` (_integer (int64)_) The number of individual views, likes, and comments on a feed post. This count appears in the UI under the feed post as the number of views, for example, “5 views.” _Available in: v37.0_ _Filter group: Small_ ### LinkCapability If a feed element has this capability, it has a link. * `url` (_string (url)_) Link URL. The URL can be to an external site. _Available in: v32.0_ _Filter group: Small_ * `urlName` (_string_) Description of the link. _Available in: v32.0_ _Filter group: Small_ ### MediaReferenceCapability If a feed element has this capability, it has one or more media references. * `media` (_array of MediaReference_) Collection of media references. _Available in: v41.0_ _Filter group: Small_ ### ModerationCapability If a feed element has this capability, users in the Experience Cloud site can flag the feed element for moderation. This response body also includes information about the flagged content. * `moderationFlags` (_object_) ModerationFlags Flags for this feed element. Moderators can view and take action on flagged items. _Available in: v31.0_ _Filter group: Big_ Includes all fields of `ModerationFlags`. ### MuteCapability If a feed element has this capability, users can mute it. Muted feed elements are visible in the muted feed, and invisible in all other feeds that respect mute. * `isMutedByMe` (_boolean_) Indicates whether the context user muted the feed element. _Available in: v35.0_ _Filter group: Small_ ### OriginCapability If a feed element has this capability, it was created by a feed action. * `actor` (_object_) UserSummary The user who executed the feed action. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `originRecord` (_object_) Reference A reference to the feed element containing the feed action. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. ### PinCapability If a feed element has this capability, users who have permission can pin it to a feed. * `isPinnableByMe` (_boolean_) Specifies whether the context user can pin or unpin the entity to the feed (`true`) or not (`false`). _Available in: v41.0_ _Filter group: Small_ * `isPinned` (_boolean_) Specifies whether the entity is pinned (`true`) or not pinned (`false`) to the feed. _Available in: v41.0_ _Filter group: Small_ ### PollCapability If a feed element has this capability, the feed element can include a poll for voting. * `choices` (_array of FeedPollChoice_) Collection of poll choices that make up the poll. _Available in: v32.0_ _Filter group: Small_ * `myChoiceId` (_string (Id)_) 18-character ID of the poll choice that the context user has voted for in this poll. Returns `null` if the context user has not voted. _Available in: v32.0_ _Filter group: Small_ * `totalVoteCount` (_string_) Total number of votes cast on the feed poll element. _Available in: v32.0_ _Filter group: Small_ ### QuestionAndAnswersCapability If a feed element has this capability, it has a question and comments on the feed element are answers to the question. * `bestAnswer` (_object_) Comment Comment selected as the best answer for the question. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `Comment`. * `bestAnswerSelectedBy` (_object_) UserSummary User who selected the best answer for the question. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `canCurrentUserSelectOrRemoveBestAnswer` (_boolean_) Indicates whether the context user can select or remove a best answer (`true`) or not (`false`). _Available in: v32.0_ _Filter group: Small_ * `candidateAnswers` (_object_) CandidateAnswersStatus Status of candidate answers for the question. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `CandidateAnswersStatus`. * `escalatedCase` (_object_) Reference If a question post is escalated, this is the case to which it was escalated. _Available in: v33.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `questionTitle` (_string_) Title for the question. _Available in: v32.0_ _Filter group: Small_ ### ReadByCapability If a feed element has this capability, the context user can mark it as read. * `isReadByMe` (_boolean_) Specifies whether the feed element has been read (`true`) or not (`false`) by the context user. _Available in: v40.0_ _Filter group: Small_ * `lastReadDateByMe` (_string (date-time)_) Last date when the feed element was marked read for the context user in ISO 8601 format. Otherwise, `null`. _Available in: v40.0_ _Filter group: Small_ * `page` (_object_) ReadByCollection First page of information about who read the feed element and when. _Available in: v40.0_ _Filter group: Big_ Includes all fields of `ReadByCollection`. ### RecommendationsCapability If a feed element has this capability, it has a recommendation. * `items` (_array of EntityRecommendation_) A collection of recommendations. _Available in: v32.0_ _Filter group: Small_ ### RecordSnapshotCapability If a feed element has this capability, it contains all the snapshotted fields of a record for a single create record event. * `recordView` (_object_) RecordView A record representation that includes metadata and data so you can display the record easily. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `RecordView`. ### SocialPostCapability If a feed element has this capability, it can interact with a social post on a social network. * `author` (_object_) SocialAccount Social account that authored the social post. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `SocialAccount`. * `content` (_string_) Content body of the social post. _Available in: v36.0_ _Filter group: Medium_ * `deletedBy` (_object_) UserSummary User who deleted the social post. _Available in: v38.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `hiddenBy` (_object_) UserSummary User who hid the social post. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `icon` (_object_) Icon Icon of the social network. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `Icon`. * `id` (_string_) ID associated with the social post Salesforce record. _Available in: v36.0_ _Filter group: Small_ * `isOutbound` (_boolean_) If `true`, the social post originated from the Salesforce application. _Available in: v36.0_ _Filter group: Small_ * `likedBy` (_string_) External social account who liked the social post. _Available in: v40.0_ _Filter group: Small_ * `messageType` (_object_) ConnectSocialPostMessageTypeEnum Message type of the social post. _Available in: v38.0_ _Filter group: Small_ Includes all fields of `ConnectSocialPostMessageTypeEnum`. * `name` (_string_) Title or heading of the social post. _Available in: v36.0_ _Filter group: Small_ * `postUrl` (_string (url)_) External URL to the social post on the social network. _Available in: v36.0_ _Filter group: Small_ * `provider` (_object_) ConnectSocialNetworkProviderEnum Social network that this social post belongs to. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `ConnectSocialNetworkProviderEnum`. * `recipient` (_object_) SocialAccount Social account that is the recipient of the social post. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `SocialAccount`. * `recipientId` (_string_) ID of the recipient of the social post. _Available in: v38.0_ _Filter group: Small_ * `reviewScale` (_number (double)_) Review scale of the social post. _Available in: v40.0_ _Filter group: Small_ * `reviewScore` (_number (double)_) Review score of the social post. _Available in: v40.0_ _Filter group: Small_ * `status` (_object_) SocialPostStatus Status of the social post. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `SocialPostStatus`. ### StatusCapability If a feed post or comment has this capability, it has a status that determines its visibility. * `feedEntityStatus` (_object_) ConnectFeedEntityStatusEnum Status of the feed post or comment. Values are: * `Draft` — The feed post isn’t published but is visible to the author and users with Modify All Data or View All Data permission. Comments can’t be drafts. * `Isolated` — The feed post or comment is isolated, and only admins can see it. * `PendingReview` — The feed post or comment isn’t approved yet and therefore isn’t published or visible. * `Published` — The feed post or comment is approved and visible. _Available in: v37.0_ _Filter group: Small_ Includes all fields of `ConnectFeedEntityStatusEnum`. * `isApprovableByMe` (_boolean_) Specifies whether the context user can change the status of the feed post or comment. _Available in: v37.0_ _Filter group: Small_ ### TopicsCapability If a feed element has this capability, the context user can add topics to it. Topics help users organize and discover conversations. * `canAssignTopics` (_boolean_) `true` if a topic can be assigned to the feed element, `false` otherwise. _Available in: v32.0_ _Filter group: Small_ * `items` (_array of Topic_) A collection of topics associated with this feed element. _Available in: v32.0_ _Filter group: Small_ ### TrackedChangesCapability If a feed element has this capability, it contains all changes to a record for a single tracked change event. * `changes` (_array of FeedTrackedChange_) Collection of feed tracked changes. _Available in: v32.0_ _Filter group: Small_ ### UpDownVoteCapability If a feed post or comment has this capability, users can upvote or downvote it. * `downVoteCount` (_integer (int64)_) Number of downvotes. _Available in: v41.0_ _Filter group: Small_ * `myVote` (_object_) ConnectUpDownVoteValueEnum Specifies the context user’s vote. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `ConnectUpDownVoteValueEnum`. * `upVoteCount` (_integer (int64)_) Number of upvotes. _Available in: v41.0_ _Filter group: Small_ ### Comment A comment. * `body` (_object_) FeedItemBody Message body for the comment. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `capabilities` (_object_) CommentCapabilities Capabilities associated with the comment. _Available in: v32.0_ _Filter group: Medium_ Includes all fields of `CommentCapabilities`. * `clientInfo` (_object_) ClientInfo Information about the client app used to authenticate the connection. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ClientInfo`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v23.0_ _Filter group: Small_ * `feedElement` (_object_) Reference Feed element on which the comment is posted. _Available in: v32.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `id` (_string (Id)_) 18-character ID of the comment. _Available in: v23.0_ _Filter group: Small_ * `isDeleteRestricted` (_boolean_) Returns `true` if the context user can’t delete the comment. If it returns `false`, possibly the context user can delete the comment. _Available in: v25.0_ _Filter group: Medium_ * `likes` (_object_) LikePage Page of likes associated with the comment. This property has no information for comments on direct messages. _Available in: v24.0_ _Filter group: Medium_ Includes all fields of `LikePage`. * `likesMessage` (_object_) LikeMessageBody Message body that describes who likes the comment. This property is `null` for comments on direct messages. _Available in: v27.0_ _Filter group: Medium_ Includes all fields of `LikeMessageBody`. * `moderationFlags` (_object_) ModerationFlags Flags for this comment. Moderators can view and act on flagged items. If the `communityModeration` property of the Features response body is `false`, this property is `null`. Includes all fields of `ModerationFlags`. * `myLike` (_object_) Reference If the context user liked the comment, returns a reference to that like or returns `null`. This property is `null` for comments on direct messages. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `parent` (_object_) Reference Information about the parent of the feed-item associated with this comment. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `ReferenceChatter`. * `relativeCreatedDate` (_string_) Created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.” _Available in: v28.0_ _Filter group: Medium_ * `threadLevel` (_integer_) Level of nesting for a comment. 0 indicates a standard comment with a parent post. 1 indicates a threaded comment with a parent comment and a parent post. 2 indicates a threaded comment with two parent comments and a parent post. The UI is limited to these three levels. _Available in: v44.0_ _Filter group: Small_ * `threadParentId` (_string (Id)_) ID of the parent comment for a threaded comment. _Available in: v44.0_ _Filter group: Small_ * `type` (_object_) ConnectCommentTypeEnum Indicates the type of comment. Valid values are: * `ContentComment` — the comment contains an attachment * `TextComment` — the comment contains only text _Available in: v24.0_ _Filter group: Small_ Includes all fields of `ConnectCommentTypeEnum`. * `url` (_string (url)_) URL to this comment. _Available in: v23.0_ _Filter group: Small_ * `user` (_object_) UserSummary Information about the comment author. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `attachment` (_string_) If the comment does not contain an attachment or if the attachment, returns `null`. Otherwise, returns Feed Item Attachment: Content . **Important**: As of version 32.0, use the `capabilities` property. _Available in: v24.0–31.0_ _Filter group: Medium_ * `feedItem` (_object_) Reference Feed item on which the comment is posted. **Important**: As of version 32.0, use the `feedElement` property. _Available in: v23.0–31.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `isDeletable` (_boolean_) **Note**: This property is no longer available as of version 25.0. Use the `isDeleteRestricted` property instead. Specifies if the context user can delete the comment. _Available in: v23.0–24.0_ ### Like Chatter like. * `id` (_string (Id)_) 18-character ID of the like _Available in: v23.0_ _Filter group: Small_ * `likedItem` (_object_) Reference A reference to the liked comment or feed element _Available in: v27.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `url` (_string (url)_) URL to this like _Available in: v23.0_ _Filter group: Small_ * `user` (_object_) UserSummary Information about the user who liked this comment or feed element _Available in: v23.0_ _Filter group: Small_ Includes all fields of `UserSummary`. ### ConnectMessageSegmentTypeEnum Feed items may have complex information within the post and is therefore broken into rich segments each containing complex information stored in the feed body. Specifies the type of segment and the additional information within. Type: `string`. Allowed values: `EntityLink`, `FieldChange`, `FieldChangeName`, `FieldChangeValue`, `Hashtag`, `InlineImage`, `Link`, `MarkupBegin`, `MarkupEnd`, `Mention`, `MoreChanges`, `ResourceLink`, `Text`. ### ApprovalPostTemplateField Description of an approval post template field. * `displayName` (_string_) The field name _Available in: v28.0_ _Filter group: Small_ * `displayValue` (_string_) The field value or `null` if the field is set to `null`. _Available in: v28.0_ _Filter group: Small_ * `record` (_object_) Reference A record ID If no record exists or if the reference is `null`, this value is `null`. _Available in: v28.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. ### ConnectWorkflowProcessStatusEnum Status of the workflow associated with an approval post feed item attachment. Type: `string`. Allowed values: `Approved`, `Fault`, `Held`, `NoResponse`, `Pending`, `Reassigned`, `Rejected`, `Removed`, `Started`. ### PlatformActionGroup A platform action group instance with state appropriate for the context user. Action link groups are one type of platform action group and are therefore represented as platform action group response bodies. * `category` (_object_) ConnectPlatformActionGroupCategoryEnum Indicates the priority and relative locations of platform actions. Values are: * `Primary` — The action link group is displayed in the body of the feed element. * `Overflow` — The action link group is displayed in the overflow menu of the feed element. _Available in: v33.0_ _Filter group: Medium_ Includes all fields of `ConnectPlatformActionGroupCategoryEnum`. * `id` (_string_) An 18-character ID or an opaque string ID for the platform action group. If the Platform Action `type` is `QuickAction` and the `subtype` is `Create`, this value is `null`. _Available in: v33.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v33.0_ _Filter group: Small_ * `platformActions` (_array of PlatformAction_) The platform action instances for this group. Within an action link group, action links are displayed in the order listed in the `actionLinks` property of the Action Link Group Definition Input request body. Within a feed item, action link groups are displayed in the order specified in the `actionLinkGroupIds` property of the Associated Actions Capability Input request body. _Available in: v33.0_ _Filter group: Medium_ * `url` (_string (url)_) Connect REST API resource URL for the platform action group. If the Platform Action `type` is `QuickAction` and the `subtype` is `Create`, this value is `null`. _Available in: v33.0_ _Filter group: Small_ ### ConnectBannerStyleEnum A Banner is used to decorate a Feed Element at presentation time and consists of a color and set of icons. Type: `string`. Allowed values: `Announcement`. ### ConnectBundleTypeEnum Defines a sub-type for the Bundle capability. Type: `string`. Allowed values: `GenericBundle`, `TrackedChanges`. ### FeedElementCollection Container of feed-elements URL and isModified resource URL for a feed. * `currentPageToken` (_string_) Token identifying the current page. _Available in: v37.0_ _Filter group: Medium_ * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v31.0_ _Filter group: Medium_ * `elements` (_array of AbstractFeedElement_) Collection of feed elements. A feed element can be any of these: * Generic Feed Element * Feed Item _Available in: v31.0_ _Filter group: Small_ * `isModifiedToken` (_string_) An opaque polling token that describes when a news feed was last modified. Use this as the value in the `{since}` request parameter of the `/chatter/feeds/news/me/feed-elements/is-modified` resource. This feature is available through a Feed Polling pilot program. This pilot program is closed and not accepting new participants. _Available in: v31.0_ _Filter group: Medium_ * `isModifiedUrl` (_string (url)_) Connect REST API URL with a `{since}` request parameter that contains an opaque token that describes when the feed was last modified. Returns `null` if the feed isn’t a news feed. Use this URL to poll a news feed for updates. This feature is available through a Feed Polling pilot program. This pilot program is closed and not accepting new participants. _Available in: v31.0_ _Filter group: Medium_ * `nextPageToken` (_string_) Page token to access the next page of feed elements. * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v31.0_ _Filter group: Small_ * `updatesToken` (_string_) Token to use in an `{updatedSince}` parameter, or `null` if not available. An opaque polling token that describes when a news feed was last modified. Use this token as the value in the `{updatedSince}` request parameter of the `/chatter/feeds/news/me/feed-elements` resource. _Available in: v31.0_ _Filter group: Big_ * `updatesUrl` (_string (url)_) A resource with the feed elements updated since the feed was refreshed. Value is `null` if the feed doesn’t support updates polling. _Available in: v31.0_ _Filter group: Big_ ### Icon Icon. * `height` (_integer_) The height of the icon, in pixels _Available in: v27.0_ _Filter group: Small_ * `url` (_string (url)_) The URL of the icon. This URL is available to unauthenticated users. The URL doesn’t expire. _Available in: v27.0_ _Filter group: Small_ * `width` (_integer_) The width of the icon, in pixels _Available in: v27.0_ _Filter group: Small_ ### ConnectCaseActorTypeEnum Specifies the type of user who made a case comment. Type: `string`. Allowed values: `Customer`, `CustomerService`. ### UserDetail User detail. If the context user doesn’t have permission to see a property, the property is set to `null`. * `aboutMe` (_string_) Text from user's profile. _Available in: v23.0_ _Filter group: Big_ * `additionalLabel` (_string_) If one exists, an extra label for the user, for example, “Customer,” “Partner,” or “Acme Corporation.” _Available in: v30.0_ _Filter group: Small_ * `address` (_object_) Address User’s address. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `Address`. * `bannerPhoto` (_object_) BannerPhoto User’s banner photo. _Available in: v36.0_ _Filter group: Big_ Includes all fields of `BannerPhoto`. * `chatterActivity` (_object_) ChatterActivity Chatter activity statistics. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `ChatterActivity`. * `chatterInfluence` (_object_) ChatterInfluence User’s influence rank. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `ChatterInfluence`. * `communityNickname` (_string_) User’s nickname in the site. _Available in: v32.0_ _Filter group: Medium_ * `companyName` (_string_) Company name. _Available in: v23.0_ _Filter group: Small_ * `currentStatus` (_object_) UserStatus User's current status. _Available in: v23.0–25.0_ Includes all fields of `UserStatus`. * `displayName` (_string_) User’s name that is displayed in the site. If nicknames are enabled, the nickname is displayed. If nicknames aren’t enabled, the full name is displayed. _Available in: v32.0_ _Filter group: Small_ * `email` (_string_) User's email address. _Available in: v23.0_ _Filter group: Medium_ * `firstName` (_string_) User's first name. In version 39.0 and later, if nicknames are enabled, `firstName` is `null`. _Available in: v23.0_ _Filter group: Small_ * `followersCount` (_integer_) Number of users following this user. _Available in: v23.0_ _Filter group: Big_ * `followingCounts` (_object_) FollowingCounts Information about items the user is following. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `FollowingCounts`. * `groupCount` (_integer_) Number of groups user is following. _Available in: v23.0_ _Filter group: Big_ * `hasChatter` (_boolean_) `true` if user has access to Chatter; `false` otherwise. _Available in: v31.0_ _Filter group: Small_ * `id` (_string_) 18-character ID of the user. _Available in: v23.0_ _Filter group: Small_ * `isActive` (_boolean_) `true` if user is active, `false` otherwise. _Available in: v23.0_ _Filter group: Small_ * `isChatterGuest` (_boolean_) `true` if user is a Chatter customer, `false` otherwise. In version 26.0 and later, use the `userType` property. _Available in: v23.0–25.0_ * `isInThisCommunity` (_boolean_) `true` if the user is in the same Experience Cloud site as the context user; `false` otherwise. Can be `false` for record feed @mentions on posts with the scope “All Users.” _Available in: v28.0_ _Filter group: Small_ * `lastName` (_string_) User's last name. In version 39.0 and later, if nicknames are enabled, `lastName` is `null`. _Available in: v23.0_ _Filter group: Small_ * `managerId` (_string (Id)_) 18-character ID of the user’s manager. _Available in: v23.0_ _Filter group: Big_ * `managerName` (_string_) Locale-based concatenation of manager's first and last names. _Available in: v23.0_ _Filter group: Big_ * `motif` (_object_) Motif Small, medium, and large icons indicating that the object is a user. The motif can also contain the object’s base color. The motif icon is not the user’s profile picture. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) Reference If the context user is following this user, contains information about the subscription, otherwise `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `name` (_string_) Locale-based concatenation of first and last names. In version 39.0 and later, if nicknames are enabled, `name` is the nickname. _Available in: v23.0_ _Filter group: Small_ * `outOfOffice` (_object_) OutOfOffice If one exists, extra out-of-office message for the user. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `OutOfOffice`. * `phoneNumbers` (_array of PhoneNumber_) Collection of user's phone numbers. _Available in: v23.0_ _Filter group: Big_ * `photo` (_object_) Photo Information about the user's photos. _Available in: v23.0_ _Filter group: Small_ Includes all fields of `Photo`. * `reputation` (_object_) Reputation Reputation of the user in the site, which is determined by the number of points earned from events and actions performed in the site. _Available in: v32.0_ _Filter group: Big_ Includes all fields of `Reputation`. * `stamps` (_array of Stamp_) Collection of the user’s stamps. In version 44.0 and later, use SOQL to get a user’s stamps. _Available in: v39.0–43.0_ _Filter group: Small_ * `thanksReceived` (_integer_) Number of thanks the user has received. _Available in: v29.0_ _Filter group: Big_ * `title` (_string_) Title of the user. _Available in: v23.0_ _Filter group: Small_ * `type` (_string_) Value is `User`. _Available in: v23.0_ _Filter group: Small_ * `url` (_string_) URL to the user's Chatter profile. _Available in: v23.0_ _Filter group: Small_ * `username` (_string_) User name of the user, such as [Admin@mycompany.com](mailto:Admin@mycompany.com) . _Available in: v24.0_ _Filter group: Small_ * `userType` (_string_) Type of user. Valid values are: * `ChatterGuest` —User is an external user in a private group. * `ChatterOnly` —User is a Chatter Free customer. * `Guest` —User is unauthenticated. * `Internal` —User is a standard org member. * `Portal` —User is an external user in an Experience Cloud site. * `System` —User is Chatter Expert or a system user. * `Undefined` —User is a user type that is a custom object. _Available in: v26.0_ _Filter group: Medium_ Allowed values: `ChatterGuest`, `ChatterOnly`, `Guest`, `Internal`, `Portal`, `System`, `Undefined`. ### ConnectCaseCommentEventTypeEnum Specifies the event type of a Case's case comment. Type: `string`. Allowed values: `NewInternal`, `NewPublished`, `NewPublishedByCustomer`, `PublishExisting`, `PublishExistingByCustomer`, `UnpublishExistingByCustomer`, `UnpublishExsiting`. ### DashboardComponentSnapshot Represents both dashboard component snapshots and alerts you receive when a dashboard component value crosses a threshold. * `componentId` (_string (Id)_) 18-character ID of the dashboard component. _Available in: v32.0_ _Filter group: Small_ * `componentName` (_string_) The dashboard component name. _Available in: v32.0_ _Filter group: Small_ * `dashboardBodyText` (_string_) Display this text next to the actor in the feed element.Use this text in place of the default body text. _Available in: v32.0_ _Filter group: Small_ * `dashboardId` (_string (Id)_) 18-character ID of the dashboard. _Available in: v32.0_ _Filter group: Small_ * `dashboardName` (_string_) The name of the dashboard. _Available in: v32.0_ _Filter group: Small_ * `fullSizeImageUrl` (_string (url)_) The source URL to retrieve the full-size image of a snapshot. Access this URL with OAuth credentials. _Available in: v32.0_ _Filter group: Small_ * `lastRefreshDate` (_string (date-time)_) ISO 8601 date specifying when this dashboard component was last refreshed. _Available in: v32.0_ _Filter group: Small_ * `lastRefreshDateDisplayText` (_string_) Display text for the last refresh date, for example, “Last Refreshed on October 31, 2013.” _Available in: v32.0_ _Filter group: Small_ * `runningUser` (_object_) UserSummary The running user of the dashboard at the time the snapshot was posted. This value may be `null`. Each dashboard has a running user, whose security settings determine which data to display in a dashboard. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `thumbnailUrl` (_string (url)_) The source URL to retrieve the thumbnail image of a snapshot. Access this URL with OAuth credentials. _Available in: v32.0_ _Filter group: Small_ ### DirectMessageMembershipActivityCollection A collection of direct message member activities. * `activities` (_array of DirectMessageMembershipActivity_) Collection of direct message member activities. _Available in: v40.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token identifying the current page. _Available in: v40.0_ _Filter group: Medium_ * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v40.0_ _Filter group: Medium_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ ### DirectMessageMemberCollection A collection of direct message members. * `currentPageToken` (_string_) Page token to access the current page of direct message members. _Available in: v39.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the current page of direct message members. _Available in: v39.0_ _Filter group: Small_ * `nextPageToken` (_string_) Page token to access the next page of direct message members. _Available in: v39.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of direct message members. _Available in: v39.0_ _Filter group: Small_ * `users` (_array of UserSummary_) Collection of direct message members. _Available in: v39.0_ _Filter group: Small_ ### EmailAttachment An email attachment in an email message. * `attachment` (_object_) RecordSummary Record summary of the attachment. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `RecordSummary`. * `contentType` (_string_) Type of attachment. _Available in: v36.0_ _Filter group: Small_ * `fileName` (_string_) Name of the attachment. _Available in: v36.0_ _Filter group: Small_ ### ConnectEmailMessageAutomationTypeEnum If a feed element has this capability, it has an email message from a case. _Available in: v32.0_ _Filter group: Small_ Type: `string`. Allowed values: `AiAssisted`, `AiAutomated`. ### EmailAddress An email address for an email message sent from a case record in Case Feed. * `displayName` (_string_) Display name for an email address _Available in: v29.0_ _Filter group: Small_ * `emailAddress` (_string_) Email address _Available in: v29.0_ _Filter group: Small_ * `relatedRecord` (_object_) RecordSummary The summary of a related record, for example, a contact or user summary. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `RecordSummary`. ### ConnectEmailMessageDirectionEnum Specifies the direction of a Case's email message. Type: `string`. Allowed values: `Inbound`, `Outbound`. ### ConnectEmailMessageSizeEnum Specifies the size category of a Case's email message HTML body. Type: `string`. Allowed values: `Large`, `Normal`. ### ConnectEmailMessageStatusEnum Specifies the status of a Case's email message. Type: `string`. Allowed values: `DraftStatus`, `ForwardedStatus`, `NewStatus`, `ReadStatus`, `RepliedStatus`, `SentStatus`. ### Extension An extension. * `alternativeRepresentation` (_object_) Alternative Alternative representation of the extension. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `Alternative`. * `attachmentId` (_string_) Attachment ID of the extension. _Available in: v41.0_ _Filter group: Small_ * `extensionId` (_string_) ID of the extension. _Available in: v40.0_ _Filter group: Small_ * `payload` (_string_) Payload associated with the extension. _Available in: v40.0_ _Filter group: Small_ * `payloadVersion` (_string_) Payload version that identifies the structure of the payload associated with the extension. _Available in: v40.0_ _Filter group: Small_ ### FeedItemSummary Representation for a single feed item summary. * `actor` (_object_) AbstractActor Entity that created the feed entity. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `AbstractActor`. * `body` (_object_) FeedItemBody Information about the feed entity. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `capabilities` (_object_) FeedElementCapabilitySet The capabilities of the feed item. _Available in: v39.0_ _Filter group: Medium_ Includes all fields of `FeedElementCapabilitySet`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z, when the entity was created. _Available in: v39.0_ _Filter group: Small_ * `feedElementType` (_string_) Type of feed entity. * `Bundle` —A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values. * `FeedItem` —A feed item has a single parent and is scoped to oneExperience Cloud site or across all Experience Cloud sites. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values. * `Recommendation` —A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user. _Available in: v39.0_ _Filter group: Small_ Allowed values: `Bundle`, `FeedItem`, `Recommendation`. * `header` (_object_) MessageBody The header of the feed item. _Available in: v39.0_ _Filter group: Medium_ Includes all fields of `MessageBody`. * `id` (_string (Id)_) 18-character ID of the feed entity. _Available in: v39.0_ _Filter group: Small_ * `isEntityAvailable` (_boolean_) Specifies whether the entity is available. If `false`, either the user doesn’t have access to the entity or the entity was deleted. _Available in: v39.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z, when the feed item was last modified. _Available in: v39.0_ _Filter group: Small_ * `originalFeedItem` (_object_) Reference A reference to the original feed item, for a shared feed item. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `originalFeedItemActor` (_object_) AbstractActor The actor of the original feed item, for a shared feed item. _Available in: v39.0_ _Filter group: Medium_ Includes all fields of `AbstractActor`. * `parent` (_object_) AbstractIdable Parent of the feed entity. _Available in: v39.0_ _Filter group: Medium_ Includes all fields of `AbstractIdable`. * `photoUrl` (_string (url)_) URL of the photo associated with the feed item. _Available in: v39.0_ _Filter group: Medium_ * `relativeCreatedDate` (_string_) Relative created date, for example, “2h ago.” _Available in: v39.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the feed entity. _Available in: v39.0_ _Filter group: Small_ * `visibility` (_object_) ConnectFeedItemVisibilityEnum The visibility of the feed item. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `ConnectFeedItemVisibilityEnum`. ### FeedEntityNotAvailableSummary Representation when the feed entity is not available. The `isEntityAvailable` property is `false` and all other properties are null. * `actor` (_object_) AbstractActor _Available in: v39.0_ _Filter group: Small_ Includes all fields of `AbstractActor`. * `body` (_object_) FeedItemBody Information about the feed entity. _Available in: v39.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z, when the entity was created. _Available in: v39.0_ _Filter group: Small_ * `feedElementType` (_string_) _Available in: v39.0_ _Filter group: Small_ Allowed values: `Bundle`, `FeedItem`, `Recommendation`. * `id` (_string (Id)_) 18-character ID of the feed entity. _Available in: v39.0_ _Filter group: Small_ * `isEntityAvailable` (_boolean_) The value is `false` because the user doesn’t have access to the entity or the entity was deleted. _Available in: v39.0_ _Filter group: Small_ * `parent` (_object_) AbstractIdable _Available in: v39.0_ _Filter group: Medium_ Includes all fields of `AbstractIdable`. * `relativeCreatedDate` (_string_) Relative created date, for example, “2h ago.” _Available in: v39.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the feed entity. _Available in: v39.0_ _Filter group: Small_ ### Content A file attached to a feed item. * `checksum` (_string_) MD5 checksum for the file. _Available in: v36.0_ _Filter group: Small_ * `contentHubRepository` (_object_) FilesConnectRepository External data source associated with this file, or `null` if it doesn’t point to an external file. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepository`. * `contentUrl` (_string (url)_) URL of the content for links and Google docs. _Available in: v36.0_ _Filter group: Small_ * `description` (_string_) Description of the attachment. _Available in: v36.0_ _Filter group: Small_ * `downloadUrl` (_string (url)_) URL to the content. _Available in: v36.0_ _Filter group: Small_ * `externalDocumentUrl` (_string (url)_) External URL this file points to, or `null` if it doesn’t point to an external file. _Available in: v36.0_ _Filter group: Small_ * `fileExtension` (_string_) Extension of the file. _Available in: v36.0_ _Filter group: Small_ * `fileSize` (_string_) Size of the file in bytes. If size can’t be determined, returns `unknown`. _Available in: v36.0_ _Filter group: Small_ * `fileType` (_string_) Type of file, such as PDF. _Available in: v36.0_ _Filter group: Small_ * `hasPdfPreview` (_boolean_) `true` if the file has a PDF preview available, `false` otherwise. _Available in: v36.0_ _Filter group: Medium_ * `id` (_string (Id)_) 18-character ID of the content. _Available in: v36.0_ _Filter group: Small_ * `imageDetails` (_object_) ImageFileDetail Image details, or `null` if the file isn’t an image. _Available in: v40.0_ _Filter group: Big_ Includes all fields of `ImageFileDetail`. * `isInMyFileSync` (_boolean_) `true` if the file is synced with Salesforce Files Sync. Salesforce Files Sync was retired on May 25, 2018. _Available in: v36.0_ _Filter group: Small_ * `mimeType` (_string_) MIME type of the file. _Available in: v36.0_ _Filter group: Small_ * `renditionUrl` (_string (url)_) URL to the rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v36.0_ _Filter group: Small_ * `renditionUrl240By180` (_string (url)_) URL to the 240 x 180 pixel rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v36.0_ _Filter group: Small_ * `renditionUrl720By480` (_string (url)_) URL to the 720 x 480 pixel rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. _Available in: v36.0_ _Filter group: Small_ * `repositoryFileId` (_string_) ID of the file in the external repository, or `null` if the file isn’t external. _Available in: v36.0_ _Filter group: Small_ * `repositoryFileUrl` (_string (url)_) URL to the Connect REST API resource giving access to the external repository file properties, or `null` if this file doesn’t point to an external file. _Available in: v36.0_ _Filter group: Small_ * `sharingOption` (_object_) ConnectFileSharingOptionEnum Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v36.0_ _Filter group: Medium_ Includes all fields of `ConnectFileSharingOptionEnum`. * `textPreview` (_string_) Text preview of the file if available; `null` otherwise. _Available in: v36.0_ _Filter group: Big_ * `thumb120By90RenditionStatus` (_string_) Specifies the rendering status of the 120 x 90 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v36.0_ _Filter group: Medium_ * `thumb240By180RenditionStatus` (_string_) Specifies the rendering status of the 240 x 180 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v36.0_ _Filter group: Medium_ * `thumb720By480RenditionStatus` (_string_) Specifies the rendering status of the 720 x 480 preview image of the file. One of these values: * `Processing` — Image is being rendered. * `Failed` — Rendering process failed. * `Success` — Rendering process was successful. * `Na` — Rendering is not available for this image. _Available in: v36.0_ _Filter group: Medium_ * `title` (_string_) Title of the file. _Available in: v36.0_ _Filter group: Small_ * `versionId` (_string (Id)_) Version ID of the file. _Available in: v36.0_ _Filter group: Medium_ ### MediaReference A media reference. * `mediaUrl` (_string (url)_) URL to stream or download the media. _Available in: v41.0_ _Filter group: Small_ * `thumbnailUrl` (_string (url)_) If one exists, URL of the media’s thumbnail. _Available in: v41.0_ _Filter group: Small_ ### FeedPollChoice Feed poll choice. * `id` (_string (Id)_) 18-character ID of the poll choice _Available in: v26.0_ _Filter group: Small_ * `position` (_integer_) The location in the poll where this poll choice exists. The first poll choice starts at 1. _Available in: v26.0_ _Filter group: Small_ * `text` (_string_) Label text associated with the poll choice _Available in: v26.0_ _Filter group: Small_ * `voteCount` (_integer_) Total number of votes for this poll choice _Available in: v26.0_ _Filter group: Small_ * `voteCountRatio` (_number (double)_) The ratio of total number of votes for this poll choice to all votes cast in the poll. Multiply the ratio by 100 to get the percentage of votes cast for this poll choice. _Available in: v26.0_ _Filter group: Small_ ### CandidateAnswersStatus The status of candidate answers on a feed element. * `hasCandidateAnswers` (_boolean_) Indicates whether candidate answers are available for a question. _Available in: v41.0_ _Filter group: Small_ * `hasCandidateAnswersPublished` (_boolean_) Indicates whether any candidate answers are published. _Available in: v41.0_ _Filter group: Small_ * `hasCandidateAnswersRated` (_boolean_) Indicates whether any candidate answers are rated. _Available in: v41.0_ _Filter group: Small_ ### ReadByCollection A collection of information about who read the feed element and when. * `currentPageToken` (_string_) Token identifying the current page. _Available in: v40.0_ _Filter group: Medium_ * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. The default is 25 items per page. _Available in: v40.0_ _Filter group: Medium_ * `items` (_array of ReadBy_) Collection of read-by information, including users and when they last read the feed element. _Available in: v40.0_ _Filter group: Big_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v40.0_ _Filter group: Small_ * `previousPageToken` (_string_) Reserved for future use. _Available in: v40.0_ _Filter group: Medium_ * `previousPageUrl` (_string (url)_) Reserved for future use. _Available in: v40.0_ _Filter group: Medium_ * `total` (_integer_) Total number of users who read the feed element. This count appears in the UI under feed posts in private and unlisted Chatter groups as the “seen by” number, for example, “Seen by 48.” _Available in: v40.0_ _Filter group: Small_ ### EntityRecommendation Representation of a single recommendation object that is a Salesforce record with an ID. * `action` (_object_) ConnectRecommendationActionEnum Specifies the action to take on the recommendation. Values are: * `follow` (v23.0) * `join` (v23.0) * `view` (v25.0) _Available in: v23.0_ _Filter group: Small_ Includes all fields of `ConnectRecommendationActionEnum`. * `actOnUrl` (_string (url)_) For user, file, group, topic, and record entity types, use this Connect REST URL with a POST request to follow the recommended user, file, topic, or record, or join the recommended group. For recommended object entity types, such as custom recommendations, use the `actionUrl` property of the response body to take action on the recommendation. _Available in: v23.0_ _Filter group: Small_ * `entity` (_object_) AbstractActor The entity with which the receiver is recommended to take action. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `AbstractActor`. * `explanation` (_object_) RecExplanationSummary The recommendation explanation. _Available in: v23.0_ _Filter group: Big_ Includes all fields of `RecExplanationSummary`. * `platformActionGroup` (_PlatformActionGroup_) * `recommendationType` (_ConnectRecommendationTypeEnum_) * `url` (_string (url)_) Url to the connect resource for the recommendation. ### RecordView A view of any record in the org, including a custom object record. This object is used if a specialized object, such as User or ChatterGroup, isn’t available for the record type. Contains data and metadata so you can render a record with one response. * `id` (_string_) 18-character ID of the object _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) Motif Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `Motif`. * `mySubscription` (_object_) Reference If the context user is following this file, this contains information about the subscription, otherwise returns `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `name` (_string_) The localized name _Available in: v29.0_ _Filter group: Small_ * `relatedListDefinitions` (_array of ListViewDefinition_) Related list definitions (metadata) for this object. These list definitions don’t include the related list data. _Available in: v29.0_ _Filter group: Medium_ * `sections` (_array of RecordViewSection_) List of record view sections. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) A fixed type name for this object. Check this value to determine the shape of a response body. _Available in: v23.0_ _Filter group: Small_ * `url` (_string_) The Connect REST API URL resource for this object. _Available in: v23.0_ _Filter group: Small_ ### SocialAccount A social account on a social network. * `externalSocialAccountId` (_string_) ID of the external social account, if available. _Available in: v38.0_ _Filter group: Small_ * `handle` (_string_) Social handle, screen name, or alias that identifies this account. _Available in: v36.0_ _Filter group: Small_ * `name` (_string_) Name of the account as defined by the account's owner. _Available in: v36.0_ _Filter group: Small_ * `profileUrl` (_string (url)_) URL to the account's profile. _Available in: v36.0_ _Filter group: Small_ * `socialPersonaId` (_string_) ID of the social persona account, if the external social account ID isn’t available. _Available in: v39.0_ _Filter group: Small_ ### ConnectSocialPostMessageTypeEnum The message type of a social post. Type: `string`. Allowed values: `Comment`, `Direct`, `Post`, `PrivateMessage`, `Reply`, `Retweet`, `Tweet`. ### ConnectSocialNetworkProviderEnum The social network provider. Type: `string`. Allowed values: `Facebook`, `GooglePlus`, `Instagram`, `InstagramBusiness`, `KakaoTalk`, `Kik`, `Line`, `LinkedIn`, `Messenger`, `Other`, `Pinterest`, `QQ`, `Rypple`, `SMS`, `SinaWeibo`, `Snapchat`, `Telegram`, `Twitter`, `VKontakte`, `WeChat`, `WhatsApp`, `YouTube`. ### SocialPostStatus The status of a social post. * `message` (_string_) Status message. _Available in: v36.0_ _Filter group: Small_ * `type` (_object_) ConnectSocialPostStatusTypeEnum Status type. _Available in: v36.0_ _Filter group: Small_ Includes all fields of `ConnectSocialPostStatusTypeEnum`. ### ConnectFeedEntityStatusEnum Describes the status of a feed item Type: `string`. Allowed values: `Draft`, `Isolated`, `PendingReview`, `Published`. ### FeedTrackedChange Feed tracked change. * `fieldName` (_string_) The name of the field that was updated. _Available in: v29.0_ _Filter group: Small_ * `newValue` (_string_) The new value of the field or `null` if the field length is long or empty. _Available in: v29.0_ _Filter group: Small_ * `oldValue` (_string_) The old value of the field or `null` if the field length is long or empty. _Available in: v29.0_ _Filter group: Small_ ### ConnectUpDownVoteValueEnum Type of vote for a feed element or comment. _Available in: v42.0_ _Filter group: Small_ Type: `string`. Allowed values: `Down`, `None`, `Up`. ### CommentCapabilities A container for all capabilities that can be included with a comment. * `comments` (_object_) CommentsCapability If a comment has this capability, it has threaded comments. _Available in: v44.0_ _Filter group: Small_ Includes all fields of `CommentsCapability`. * `content` (_object_) ContentCapability Content, such as a file attachment, associated with this comment. Most Content Capability properties are null if the content has been deleted from the feed element or if the access has changed to private. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ContentCapability`. * `edit` (_object_) EditCapability If a comment has this capability, users who have permission can edit it. _Available in: v34.0_ _Filter group: Small_ Includes all fields of `EditCapability`. * `feedEntityShare` (_object_) FeedEntityShareCapability If a comment has this capability, a feed entity is shared with it. _Available in: v42.0_ _Filter group: Small_ Includes all fields of `FeedEntityShareCapability`. * `record` (_object_) RecordCapability If a comment has this capability, it has a record attachment. _Available in: v42.0_ _Filter group: Small_ Includes all fields of `RecordCapability`. * `status` (_object_) StatusCapability If a comment has this capability, it has a status that determines its visibility. _Available in: v38.0_ _Filter group: Small_ Includes all fields of `StatusCapability`. * `upDownVote` (_object_) UpDownVoteCapability If a comment has this capability, users can upvote or downvote it. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `UpDownVoteCapability`. * `verified` (_object_) VerifiedCapability If a comment has this capability, users with permission can mark it as verified or unverified. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `VerifiedCapability`. ### ConnectCommentTypeEnum Indicates the type of comment. Valid values are: * `ContentComment` — the comment contains an attachment * `TextComment` — the comment contains only text _Available in: v24.0_ _Filter group: Small_ Type: `string`. Allowed values: `ContentComment`, `TextComment`. ### ConnectPlatformActionGroupCategoryEnum Indicates the priority and relative locations of platform actions. Values are: * `Primary` — The action link group is displayed in the body of the feed element. * `Overflow` — The action link group is displayed in the overflow menu of the feed element. _Available in: v33.0_ _Filter group: Medium_ Type: `string`. Allowed values: `Overflow`, `Primary`. ### PlatformAction A platform action instance with state information for the context user. Action links are one type of platform action and are therefore represented as platform action response bodies. * `actionUrl` (_string (url)_) For action links of `subtype` `Ui` or `Download`, direct the user to download or visit the UI from this link. Salesforce issues a Javascript redirect for the link in this format: `/action-link-redirect/{communityId}/{actionLinkId}?_bearer={bearerToken}`. For `Api` and `ApiAsync` action links and for all platform actions, this value is `null`. Salesforce handles the callout to `Api` or and `ApiAsync` action links. To call an `Api` or an `ApiAsync` action link, you can also make a PATCH request to the /connect/action-links/actionLinkId resource and set `status` to `PendingStatus`. _Available in: v33.0_ _Filter group: Medium_ * `apiName` (_string_) The API name. This value may be `null`. _Available in: v33.0_ _Filter group: Medium_ * `confirmationMessage` (_string_) If this action requires a confirmation and has a status of `NewStatus`, this is a default localized message that should be shown to an end user prior to invoking the action. Otherwise, this is `null`. _Available in: v33.0_ _Filter group: Medium_ * `createdRecords` (_array of RecordSummary_) The collection of records that this action created after it was invoked by the context user. This collection is empty if the action hasn’t been performed yet by the context user or if the action doesn’t create a record. Only records created by the context user are shown. _Available in: v33.0_ _Filter group: Medium_ * `executingUser` (_object_) UserSummary User who initiated execution of the platform action. _Available in: v33.0_ _Filter group: Medium_ Includes all fields of `UserSummary`. * `groupDefault` (_boolean_) `true` if this platform action is the default or primary platform action in the platform action group; `false` otherwise. There can be only one default platform action per platform action group. _Available in: v33.0_ _Filter group: Small_ * `iconUrl` (_string (url)_) The URL of the icon for the platform action. This value may be `null`. _Available in: v33.0_ _Filter group: Medium_ * `id` (_string_) The ID of the platform action. If the `type` is `QuickAction` and the `subtype` is `Create`, this value is `null`. _Available in: v33.0_ _Filter group: Small_ * `label` (_string_) The localized label for this platform action. _Available in: v33.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z _Available in: v33.0_ _Filter group: Small_ * `platformActionGroup` (_object_) Reference A reference to the platform action group containing this platform action. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `status` (_object_) ConnectPlatformActionStatusEnum The execution status of the platform action. Values are: * `FailedStatus` — The action link execution failed. * `NewStatus` — The action link is ready to be executed. Available for `Download` and `Ui` action links only. * `PendingStatus` — The action link is executing. Choosing this value triggers the API call for `Api` and `ApiAsync` action links. * `SuccessfulStatus` — The action link executed successfully. For action links only, you can update the `status` by making a PATCH request to the `/connect/action-links/{actionLinkId}` resource. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `ConnectPlatformActionStatusEnum`. * `subtype` (_string_) The subtype of a platform action or `null`. If the `type` property is `ActionLink`, possible values are: * `Api` — The action link calls a synchronous API at the action URL. Salesforce sets the status to `SuccessfulStatus` or `FailedStatus` based on the HTTP status code returned by your server. * `ApiAsync` — The action link calls an asynchronous API at the action URL. The action remains in a `PendingStatus` state until a third party makes a request to `/connect/action-links/{actionLinkId}` to set the status to `SuccessfulStatus` or `FailedStatus` when the asynchronous operation is complete. * `Download` — The action link downloads a file from the action URL. * `Ui` — The action link takes the user to a web page at the action URL. _Available in: v33.0_ _Filter group: Small_ * `type` (_object_) ConnectPlatformActionTypeEnum The type of platform action. 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 UI. * `CustomButton` — When clicked, opens a URL or a Visualforce page in a window or executes JavaScript. * `ProductivityAction` — Productivity actions are predefined and attached to a limited set of objects. Productivity actions include Send Email, Call, Map, View Website, and Read News. Except for the Call action, you can’t edit productivity actions. * `QuickAction` — A global or object-specific action. * `StandardButton` — A predefined Salesforce button such as New, Edit, or Delete. _Available in: v33.0_ _Filter group: Small_ Includes all fields of `ConnectPlatformActionTypeEnum`. * `url` (_string (url)_) Connect REST API resource URL for the platform action. If the `type` is `QuickAction` and the `subtype` is `Create`, this value is `null`. _Available in: v33.0_ _Filter group: Small_ ### AbstractFeedElement Since a Feed now contains more than Feed Items, let Feed Elements be the abstract object that all things in the Feed extend. Feed Items and Bundles are each Feed Elements. All Feed Elements have shared properties: id, feedElementType, body, and capabilities. Discriminator: `feedElementType` selects the concrete type. Mapping: `FeedItem` → `FeedItem`, `Bundle` → `FeedElement`, `Recommendation` → `FeedElement`. * `body` (_object_) FeedItemBody Information about the feed element. _Available in: v22.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `capabilities` (_object_) FeedElementCapabilitySet A container for all capabilities that can be included with a feed element. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedElementCapabilitySet`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z _Available in: v23.0_ _Filter group: Small_ * `feedElementType` (_object_) ConnectFeedElementTypeEnum Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element. One of these values: * `Bundle` — A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values. * `FeedItem` — A feed item has a single parent and is scoped to oneExperience Cloud site or across all Experience Cloud sites. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values. * `Recommendation` — A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user. _Available in: v31.0_ Includes all fields of `ConnectFeedElementTypeEnum`. * `header` (_object_) FeedItemBody The header is the title of the post. This property contains renderable plain text for all the segments of the message. If a client doesn't know how to render a feed element type, it should render this text. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedItemBody`. * `id` (_string (Id)_) 18-character ID of the feed item. _Available in: v23.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v23.0_ _Filter group: Small_ * `parent` (_object_) AbstractIdable The parent of the feed element. _Available in: v28.0_ _Filter group: Medium_ Includes all fields of `AbstractIdable`. * `relativeCreatedDate` (_string_) Created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.” . _Available in: v28.0_ _Filter group: Small_ * `url` (_string (url)_) URL to this feed item. _Available in: v23.0_ _Filter group: Small_ ### Address Address input representation for a payment method, payment intent, or card payment method. * `city` (_string_) City _Available in: v49.0_ * `country` (_string_) Country, specified using the ISO country code. _Available in: v49.0_ * `formattedAddress` (_string_) Address formatted by locale _Available in: v25.0_ _Filter group: Small_ * `state` (_string_) State _Available in: v49.0_ * `street` (_string_) Street _Available in: v49.0_ * `zip` (_string_) Zip or postal code _Available in: v23.0_ _Filter group: Small_ * `companyName` (_string_) Company name _Available in: v49.0_ * `postalCode` (_string_) Postal code _Available in: v49.0_ ### ChatterActivity Chatter activity, such as the number of posts and comments made, and comments, likes, and upvotes received, for a user. * `commentCount` (_integer_) Total number of comments in the org or site made by the user. _Available in: v23.0_ _Filter group: Small_ * `commentReceivedCount` (_integer_) Total number of comments in the org or site received by the user. _Available in: v23.0_ _Filter group: Small_ * `likeReceivedCount` (_integer_) Total number of likes and upvotes (in version 45.0 and later) on posts and comments in the org or site received by the user. _Available in: v23.0_ _Filter group: Small_ * `postCount` (_integer_) Total number of posts in the org or site made by the user. _Available in: v23.0_ _Filter group: Small_ ### ChatterInfluence Chatter influence. * `percentile` (_string_) Percentile value for the user’s influence rank within the org or Experience Cloud site. _Available in: v24.0_ _Filter group: Small_ * `rank` (_integer_) Number indicating the user’s influence rank, relative to all other users within the org or Experience Cloud site. _Available in: v24.0_ _Filter group: Small_ ### UserStatus User status. * `body` (_object_) FeedBody Body of the post _Available in: v23.0–25.0_ _Filter group: Small_ Includes all fields of `FeedBody`. * `parentId` (_string (Id)_) 18-character ID _Available in: v23.0–25.0_ _Filter group: Small_ * `url` (_string (url)_) URL to this user status post _Available in: v23.0–25.0_ _Filter group: Small_ ### FollowingCounts Chatter following counts. * `people` (_integer_) Number of people the user is following _Available in: v23.0_ _Filter group: Small_ * `records` (_integer_) Number of records the user is following Topics are a type of record that can be followed as of version 29.0. _Available in: v23.0_ _Filter group: Small_ * `total` (_integer_) Total number of items the user is following _Available in: v23.0_ _Filter group: Small_ ### PhoneNumber A phone number. * `label` (_string_) Localized string indicating the phone type _Available in: v30.0_ _Filter group: Small_ * `phoneNumber` (_string_) Phone number _Available in: v27.0_ _Filter group: Small_ * `phoneType` (_string_) Phone type. One of these values: * `Fax` * `Mobile` * `Work` These values are not localized. _Available in: v30.0_ _Filter group: Small_ * `number` (_string_) This property is not available after version 26.0. Use the `phoneNumber` property instead. Phone number _Available in: v23.0–26.0_ * `type` (_string_) This property is not available after version 29.0. Use the `phoneType` property instead. Values are: * `Fax` * `Mobile` * `Work` _Available in: v23.0–29.0_ _Filter group: Small_ ### DirectMessageMembershipActivity Direct message membership activity. * `activityDate` (_string (date-time)_) Direct message member activity date. Format is ISO 8601. _Available in: v40.0_ _Filter group: Small_ * `actor` (_object_) UserSummary User who changed the direct message membership. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `membersAdded` (_object_) DirectMessageMemberCollection Members added to the direct message as part of the activity. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `DirectMessageMemberCollection`. * `membersRemoved` (_object_) DirectMessageMemberCollection Members removed from the direct message as part of the activity. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `DirectMessageMemberCollection`. ### Alternative Alternative representation for an extension on a feed element. * `textRepresentation` (_string_) Text representation of the extension. _Available in: v40.0_ _Filter group: Small_ * `thumbnailUrl` (_string_) Thumbnail URL to the extension. _Available in: v40.0_ _Filter group: Small_ * `title` (_string_) Title of the extension. _Available in: v40.0_ _Filter group: Small_ ### MessageBody Representation for a structured text item. * `isRichText` (_boolean_) Whether this is a rich text body. * `messageSegments` (_array of MessageSegment_) Collection of message segments, based on type. The segment types you may encounter will depend on the body type. * `text` (_string_) Unformatted text of the message. This can be an easy summary to use if you don't want to process the message segments. ### ReadBy Information about who read the feed element and when. * `lastReadDateByUser` (_string (date-time)_) When the user last read the feed element in ISO 8601 format. _Available in: v40.0_ _Filter group: Small_ * `user` (_object_) UserSummary Information about the user who read the feed element. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `UserSummary`. ### ConnectRecommendationActionEnum Specifies the type of action to take from a recommendation. Type: `string`. Allowed values: `follow`, `join`, `view`. ### RecExplanationSummary Explanation for a system-generated recommendations of Chatter actions for the logged-in user. * `detailsUrl` (_string (url)_) URL for explanation details. If the recommendation doesn’t have a detailed explanation, the string “null”. * `summary` (_string_) Explanation of recommendation. * `type` (_ConnectRecommendationExplanationEnum_) ### ConnectRecommendationTypeEnum Specifies the type of record that is the subject of a recommendation. Type: `string`. Allowed values: `apps`, `articles`, `custom`, `files`, `groups`, `records`, `topics`, `users`. ### ListViewDefinition Related list structure or a search list structure on a record view. There’s no data in the list. * `columns` (_array of ListViewColumn_) The columns of fields shown in this list view. _Available in: v29.0_ _Filter group: Big_ * `label` (_string_) The localized label of this list view. _Available in: v29.0_ _Filter group: Small_ * `objectType` (_object_) ListViewObject The definition of the type of the objects in this list view. _Available in: v29.0_ _Filter group: Medium_ Includes all fields of `ListViewObject`. * `rowLimit` (_integer_) The maximum number of objects per page in this list view. To view all objects in this related list, page through the data in pages no larger than this size. To build a SOQL statement from this describe, the SOQL statement must include a LIMIT value equal to this value or an error is thrown on execution. _Available in: v29.0_ _Filter group: Medium_ * `sortColumns` (_array of ListViewSort_) The columns in which to sort this list view. The sort columns are given in the order of their priority (for example, primary sort, secondary sort, and so on). _Available in: v29.0_ _Filter group: Medium_ ### RecordViewSection Section of record fields and values on a record detail. * `columnCount` (_integer_) Number of columns to use to lay out the fields in a record section. _Available in: v29.0_ _Filter group: Small_ * `columnOrder` (_string_) Order of the fields to use in the `fields` property to lay out the fields in a record section. * `LeftRight` — Fields are rendered from left to right. * `TopDown` — Fields are rendered from the top down. _Available in: v29.0_ _Filter group: Small_ * `fields` (_array of RecordField | Blank | Compound | Currency | Date | Percent | Picklist | Reference | ReferenceWithDate_) Fields and values for the record contained in this section. A collection of these response bodies: * Record Field * Record Field: Blank * Record Field: Compound * Record Field: Currency * Record Field: Date * Record Field: Percent * Record Field: Picklist * Record Field: Reference * Record Field: Reference with Date _Available in: v29.0_ _Filter group: Small_ * `heading` (_string_) Localized label to display when rendering this section of fields. _Available in: v29.0_ _Filter group: Small_ * `isCollapsible` (_boolean_) Indicates whether the section can be collapsed to hide all the fields (`true`) or not (`false`). _Available in: v29.0_ _Filter group: Small_ ### ConnectSocialPostStatusTypeEnum Status type. _Available in: v36.0_ _Filter group: Small_ Type: `string`. Allowed values: `ApprovalPending`, `ApprovalRecalled`, `ApprovalRejected`, `Deleted`, `Failed`, `Hidden`, `Pending`, `Replied`, `Sent`, `Unknown`. ### ContentCapability If a comment has this capability, it has a file attachment. For files attached to a feed post (instead of a comment) in version 36.0 and later, use Files Capability. If content is deleted from a feed element after it’s posted or if the access to the content is changed to private, the Content Capability exists, however most of its properties are null. * `checksum` (_string_) MD5 checksum for the file. _Available in: v32.0_ _Filter group: Small_ * `contentHubRepository` (_object_) FilesConnectRepository The external data source associated with this file, or `null` if it doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `FilesConnectRepository`. * `contentUrl` (_string (url)_) URL of the content for links and Google docs. _Available in: v32.0_ _Filter group: Small_ * `description` (_string_) Description of the attachment. _Available in: v32.0_ _Filter group: Small_ * `downloadUrl` (_string (url)_) URL to the content. _Available in: v32.0_ _Filter group: Small_ * `externalDocumentUrl` (_string (url)_) The external URL this file points to, or `null` if it does not point to an external file. _Available in: v32.0_ _Filter group: Small_ * `fileExtension` (_string_) Extension of the file. _Available in: v32.0_ _Filter group: Small_ * `fileSize` (_string_) Size of the file in bytes. If size cannot be determined, returns `Unknown`. _Available in: v32.0_ _Filter group: Small_ * `fileType` (_string_) Type of file. _Available in: v32.0_ _Filter group: Small_ * `hasPdfPreview` (_boolean_) `true` if the file has a PDF preview available, `false` otherwise. _Available in: v32.0_ _Filter group: Medium_ * `id` (_string (Id)_) 18-character ID of the content. _Available in: v32.0_ _Filter group: Small_ * `isInMyFileSync` (_boolean_) `true` if the file is synced with Salesforce Files Sync; `false` otherwise. Salesforce Files Sync was retired on May 25, 2018. _Available in: v32.0_ _Filter group: Small_ * `mimeType` (_string_) MIME type of the file. _Available in: v32.0_ _Filter group: Small_ * `renditionUrl` (_string (url)_) URL to the rendition resource for the file. Renditions are processed asynchronously and may not be available immediately after the file has been uploaded. _Available in: v32.0_ _Filter group: Small_ * `renditionUrl240By180` (_string (url)_) URL to the 240x180 size rendition resource for the file. Renditions are processed asynchronously and may not be available immediately after the file has been uploaded. _Available in: v32.0_ _Filter group: Small_ * `renditionUrl720By480` (_string (url)_) URL to the 720x480 size rendition resource for the file. Renditions are processed asynchronously and may not be available immediately after the file has been uploaded. _Available in: v32.0_ _Filter group: Small_ * `repositoryFileId` (_string_) ID of the file in the external repository, or `null` if the file isn’t external. _Available in: v36.0_ _Filter group: Small_ * `repositoryFileUrl` (_string (url)_) The URL of the Connect REST API resource giving access to the external repository file properties, or `null` if this file doesn’t point to an external file. _Available in: v32.0_ _Filter group: Small_ * `sharingOption` (_object_) ConnectFileSharingOptionEnum Sharing option of the file. Values are: * `Allowed` — Resharing of the file is allowed. * `Restricted` — Resharing of the file is restricted. _Available in: v35.0_ _Filter group: Medium_ Includes all fields of `ConnectFileSharingOptionEnum`. * `textPreview` (_string_) Text preview of the file if available, `null` otherwise. The maximum number of characters is 200. _Available in: v32.0_ _Filter group: Big_ * `thumb120By90RenditionStatus` (_string_) The status of the rendering of the 120x90 pixel sized preview image of the file. Should be either Processing, Failed, Success, or Na if unavailable. _Available in: v32.0_ _Filter group: Medium_ * `thumb240By180RenditionStatus` (_string_) The status of the rendering of the 240x180 pixel sized preview image of the file. Should be either Processing, Failed, Success, or Na if unavailable. _Available in: v32.0_ _Filter group: Medium_ * `thumb720By480RenditionStatus` (_string_) The status of the rendering of the 720x480 pixel sized preview image of the file. Should be either Processing, Failed, Success, or Na if unavailable. _Available in: v32.0_ _Filter group: Medium_ * `title` (_string_) Title of the file. _Available in: v32.0_ _Filter group: Small_ * `versionId` (_string (Id)_) Version ID of the file. _Available in: v32.0_ _Filter group: Medium_ ### RecordCapability If a comment has this capability, it has a record attachment. * `recordId` (_string_) ID of the record. _Available in: v42.0_ _Filter group: Small_ * `url` (_string_) URL to the record. _Available in: v42.0_ _Filter group: Small_ ### VerifiedCapability If a comment has this capability, users with permission can mark it as verified or unverified. * `isVerifiableByMe` (_boolean_) Specifies whether the context user has permission to mark comments as verified or unverified (`true`) or not (`false`). _Available in: v41.0_ _Filter group: Small_ * `isVerified` (_boolean_) Specifies whether the comment is marked as verified (`true`) or not (`false`). _Available in: v41.0_ _Filter group: Small_ * `isVerifiedByAnonymized` (_boolean_) Specifies whether the comment is marked as verified by an anonymous user (`true`) or not (`false`). If the comment has never been marked as verified or unverified, `null`. Also `null` if the context user doesn’t have permission to mark comments as verified or unverified. _Available in: v43.0_ _Filter group: Small_ * `lastVerifiedByUser` (_object_) UserSummary User who last marked the comment as verified or unverified, otherwise `null`. Also `null` if the context user doesn’t have permission to mark comments as verified or unverified. _Available in: v41.0_ _Filter group: Small_ Includes all fields of `UserSummary`. * `lastVerifiedDate` (_string (date-time)_) ISO 8601 date string. Date when the comment was last marked as verified or unverified, otherwise `null`. Also `null` if the context user doesn’t have permission to mark comments as verified or unverified. _Available in: v41.0_ _Filter group: Small_ ### ConnectPlatformActionStatusEnum The execution status of the platform action. Values are: * `FailedStatus` — The action link execution failed. * `NewStatus` — The action link is ready to be executed. Available for `Download` and `Ui` action links only. * `PendingStatus` — The action link is executing. Choosing this value triggers the API call for `Api` and `ApiAsync` action links. * `SuccessfulStatus` — The action link executed successfully. For action links only, you can update the `status` by making a PATCH request to the `/connect/action-links/{actionLinkId}` resource. _Available in: v33.0_ _Filter group: Small_ Type: `string`. Allowed values: `FailedStatus`, `NewStatus`, `PendingStatus`, `SuccessfulStatus`. ### ConnectPlatformActionTypeEnum The type of platform action. 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 UI. * `CustomButton` — When clicked, opens a URL or a Visualforce page in a window or executes JavaScript. * `ProductivityAction` — Productivity actions are predefined and attached to a limited set of objects. Productivity actions include Send Email, Call, Map, View Website, and Read News. Except for the Call action, you can’t edit productivity actions. * `QuickAction` — A global or object-specific action. * `StandardButton` — A predefined Salesforce button such as New, Edit, or Delete. _Available in: v33.0_ _Filter group: Small_ Type: `string`. Allowed values: `ActionLink`, `CustomButton`, `ProductivityAction`, `QuickAction`, `StandardButton`. ### FeedBody Information about the feed item. * `isRichText` (_boolean_) Whether this is a rich text body. * `messageSegments` (_array of MessageSegment_) Collection of message segments, based on type. The segment types you may encounter will depend on the body type. * `text` (_string_) Unformatted text of the message. This can be an easy summary to use if you don't want to process the message segments. ### ConnectRecommendationExplanationEnum Indicates the reason-type for a suggested recommendation. Type: `string`. Allowed values: `ArticleHasRelatedContent`, `ArticleViewedTogether`, `ArticleViewedTogetherWithViewers`, `Custom`, `FilePopular`, `FileViewedTogether`, `FollowedTogetherWithFollowees`, `GroupMembersFollowed`, `GroupNew`, `GroupPopular`, `ItemViewedTogether`, `PopularApp`, `RecordOwned`, `RecordParentOfFollowed`, `RecordViewed`, `TopicFollowedTogether`, `TopicFollowedTogetherWithFollowees`, `TopicPopularFollowed`, `TopicPopularLiked`, `UserDirectReport`, `UserFollowedTogether`, `UserFollowsSameUsers`, `UserManager`, `UserNew`, `UserPeer`, `UserPopular`, `UserViewingSameRecords`. ### ListViewColumn Single column of a record’s related list. Describes how to lay out the column; doesn’t contain the column’s data. * `dataType` (_string_) The object type for this column’s field. This is the object type used in REST API and SOAP API. _Available in: v29.0_ _Filter group: Medium_ * `fieldId` (_string_) The fully qualified API field ID, for example, `Contact.Name`. _Available in: v29.0_ _Filter group: Big_ * `label` (_string_) The localized label of this column. _Available in: v29.0_ _Filter group: Small_ * `name` (_string_) The short name of the API field, for example, `Name`. _Available in: v29.0_ _Filter group: Medium_ ### ListViewObject Type of record displayed in the rows of a related list. * `fieldId` (_string_) The API field ID that refers to the parent record. For example, if an Account record has a related list of Contact records, then in the Contact related list definition on the Account this value might be `"Account"`. _Available in: v29.0_ _Filter group: Big_ * `type` (_string_) The object type name for this object. This is the object type used in REST API and SOAP API. _Available in: v29.0_ _Filter group: Small_ ### ListViewSort Ordinal of a sort order in a related list. * `column` (_string_) The field ID on the related list column to sort. _Available in: v29.0_ _Filter group: Small_ * `order` (_object_) ConnectSortOrderEnum The order in which to sort the column. One of these values: * `Ascending` — Items are in ascending alphabetical order (A-Z). * `Descending` — Items are in descending alphabetical order (Z-A). * `MostRecentlyViewed` — Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams. _Available in: v29.0_ _Filter group: Small_ Includes all fields of `ConnectSortOrderEnum`. ### RecordField Generic record field containing a label and text value. * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) Valid values are: * `Boolean` * `Email` * `Number` * `Phone` * `Text` _Available in: v29.0_ _Filter group: Small_ ### Blank Record field displayed as a place holder in a grid of fields. * `type` (_string_) _Available in: v29.0_ _Filter group: Small_ ### Compound Record field that is a composite of subfields. * `fields` (_array of RecordField | Blank | Compound | Currency | Date | Percent | Picklist | Reference | ReferenceWithDate_) Collection of subfields that make up the compound field. A collection of these response bodies: * Record Field * Record Field: Blank * Record Field: Compound * Record Field: Currency * Record Field: Date * Record Field: Percent * Record Field: Picklist * Record Field: Reference * Record Field: Reference with Date _Available in: v29.0_ _Filter group: Big_ * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) Valid values are: * `Address` * `Compound` * `Location` * `Name` _Available in: v29.0_ _Filter group: Small_ ### Currency Record field containing a currency value. * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. Currency is formatted in the default currency of the organization. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) _Available in: v29.0_ _Filter group: Small_ ### Date Record field containing a date. * `dateValue` (_string_) Date that a machine can read. Format is ISO 8601. _Available in: v29.0_ _Filter group: Medium_ * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) Valid values are: * `Date` * `DateTime` * `Time` _Available in: v29.0_ _Filter group: Small_ ### Percent Record field containing a percentage value. * `value` (_number (double)_) Value of the percentage. _Available in: v29.0_ _Filter group: Medium_ * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) _Available in: v29.0_ _Filter group: Small_ ### Picklist Record field containing an enumerated value. * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) _Available in: v29.0_ _Filter group: Small_ ### Reference Record field containing a reference to another object. * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `reference` (_object_) Reference Object referenced by the record field. _Available in: v29.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) _Available in: v29.0_ _Filter group: Small_ ### ReferenceWithDate Record field containing a referenced object that acted at a specific time, for example, “Created By...”. * `dateValue` (_string_) Time at which the referenced object acted. Format is ISO 8601. _Available in: v29.0_ _Filter group: Medium_ * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `reference` (_object_) Reference Object referenced by the record field. _Available in: v29.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) Valid values are: * `CreatedBy` * `LastModifiedBy` _Available in: v29.0_ _Filter group: Small_ ### ConnectSortOrderEnum The order in which to sort the column. One of these values: * `Ascending` — Items are in ascending alphabetical order (A-Z). * `Descending` — Items are in descending alphabetical order (Z-A). * `MostRecentlyViewed` — Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams. _Available in: v29.0_ _Filter group: Small_ Type: `string`. Allowed values: `Ascending`, `Descending`, `MostRecentlyViewed`. ### AbstractRepositoryItem Description of a repository item. * `createdBy` (_string_) Name of user who created the folder. _Available in: v32.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Created date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `description` (_string_) Folder description. _Available in: v32.0_ _Filter group: Small_ * `id` (_string_) ID of the folder. _Available in: v32.0_ _Filter group: Small_ * `itemTypeUrl` (_string (url)_) URL to the item type information. _Available in: v35.0_ _Filter group: Small_ * `modifiedBy` (_string_) Name of user who last modified the folder. _Available in: v32.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) Last modified date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `motif` (_object_) MotifContenthub Motif of the folder. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `MotifContenthub`. * `name` (_string_) Name of the folder. _Available in: v32.0_ _Filter group: Small_ * `repository` (_object_) ReferenceChatter The folder external repository. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `type` (_string_) Record type, `folder`. _Available in: v32.0_ _Filter group: Small_ * `url` (_string (url)_) Connect REST API URL to this folder. _Available in: v32.0_ _Filter group: Small_ ### AbstractRepositoryFolder Description of a repository folder. * `createdBy` (_string_) Name of user who created the folder. _Available in: v32.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Created date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `description` (_string_) Folder description. _Available in: v32.0_ _Filter group: Small_ * `externalFolderUrl` (_string (url)_) Connect REST API URL to this folder in the external system. _Available in: v32.0_ _Filter group: Small_ * `folderItemsUrl` (_string (url)_) Connect REST API URL that lists the files and folders in this folder. _Available in: v32.0_ _Filter group: Small_ * `id` (_string_) ID of the folder. _Available in: v32.0_ _Filter group: Small_ * `itemTypeUrl` (_string (url)_) URL to the item type information. _Available in: v35.0_ _Filter group: Small_ * `modifiedBy` (_string_) Name of user who last modified the folder. _Available in: v32.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) Last modified date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `motif` (_object_) MotifContenthub Motif of the folder. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `MotifContenthub`. * `name` (_string_) Name of the folder. _Available in: v32.0_ _Filter group: Small_ * `path` (_string_) The absolute path of the folder in the external system. _Available in: v32.0_ _Filter group: Small_ * `repository` (_object_) ReferenceChatter The folder external repository. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `type` (_string_) Record type, `folder`. _Available in: v32.0_ _Filter group: Small_ * `url` (_string (url)_) Connect REST API URL to this folder. _Available in: v32.0_ _Filter group: Small_ ### AbstractFilesConnectItemType The details of an item type associated with a repository folder. * `contentStreamSupport` (_object_) FilesConnectStreamSupportEnum Support for content streaming. _Available in: v35.0_ _Filter group: Small_ Includes all fields of `FilesConnectStreamSupportEnum`. * `description` (_string_) Description of the item type. _Available in: v35.0_ _Filter group: Medium_ * `displayName` (_string_) Display name of the item type. _Available in: v35.0_ _Filter group: Small_ * `id` (_string_) ID of the item type. _Available in: v35.0_ _Filter group: Small_ * `isVersionable` (_boolean_) Indicates whether the item type can have versions. _Available in: v35.0_ _Filter group: Small_ * `url` (_string (url)_) URL to the detailed information of the item type. _Available in: v35.0_ _Filter group: Small_ ### AbstractRepositoryFile Description of a repository file. * `checkinComment` (_string_) Checkin comment of the file. _Available in: v32.0_ _Filter group: Small_ * `contentBody` (_string_) Text of the file’s content if available, otherwise `null`. _Available in: v43.0_ _Filter group: Big_ * `contentItemSize` (_number (int64)_) Length in bytes of the content of the file, including files that are larger than 2 GB. _Available in: v65.0_ _Filter group: Small_ * `contentSize` (_integer_) Length in bytes of the content of the file, for files that are smaller than 2 GB. _Available in: v32.0_ _Filter group: Small_ * `createdBy` (_string_) Name of user who created the folder. _Available in: v32.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Created date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `description` (_string_) Folder description. _Available in: v32.0_ _Filter group: Small_ * `downloadUrl` (_string (url)_) URL to the repository file content. _Available in: v32.0_ _Filter group: Small_ * `externalContentUrl` (_string (url)_) URL to this file’s content in the external system. _Available in: v32.0_ _Filter group: Small_ * `externalDocumentUrl` (_string (url)_) URL to this file in the external system. _Available in: v32.0_ _Filter group: Small_ * `externalFilePermissionInformation` (_object_) ExternalFilePermissionInformationContenthub External file permission information, such as available groups, available permission types, and current sharing status, or `null` when `includeExternalFilePermissionsInfo` is `false` . _Available in: v36.0_ _Filter group: Big_ Includes all fields of `ExternalFilePermissionInformationContenthub`. * `id` (_string_) ID of the folder. _Available in: v32.0_ _Filter group: Small_ * `itemTypeUrl` (_string (url)_) URL to the item type information. _Available in: v35.0_ _Filter group: Small_ * `mimeType` (_string_) Mime type of the file. _Available in: v32.0_ _Filter group: Small_ * `modifiedBy` (_string_) Name of user who last modified the folder. _Available in: v32.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) Last modified date of the folder in ISO 8601 format. _Available in: v32.0_ _Filter group: Small_ * `motif` (_object_) MotifContenthub Motif of the folder. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `MotifContenthub`. * `name` (_string_) Name of the folder. _Available in: v32.0_ _Filter group: Small_ * `previewsUrl` (_string (url)_) URL to the previews. _Available in: v36.0_ _Filter group: Small_ * `previewUrlThumbnail` (_string (url)_) URL to the thumbnail (240 x 180 PNG) preview. _Available in: v36.0_ _Filter group: Small_ * `previewUrlThumbnailBig` (_string (url)_) URL to the big thumbnail (720 x 480 PNG) preview. _Available in: v36.0_ _Filter group: Small_ * `previewUrlThumbnailTiny` (_string (url)_) URL to the tiny thumbnail (120 x 90 PNG) preview. _Available in: v36.0_ _Filter group: Small_ * `repository` (_object_) ReferenceChatter The folder external repository. _Available in: v32.0_ _Filter group: Small_ Includes all fields of `ReferenceChatter`. * `title` (_string_) Title of the file. _Available in: v32.0_ _Filter group: Small_ * `type` (_string_) Record type, `folder`. _Available in: v32.0_ _Filter group: Small_ * `url` (_string (url)_) Connect REST API URL to this folder. _Available in: v32.0_ _Filter group: Small_ * `versionId` (_string_) ID of the file version in the external system. _Available in: v32.0_ _Filter group: Small_ ### AbstractDirectoryEntrySummary Description of a directory entry with summary information. * `domain` (_string_) Domain of the group. _Available in: v35.0_ _Filter group: Medium_ * `email` (_string_) Email of the group. _Available in: v35.0_ _Filter group: Small_ * `id` (_string_) ID of the group. _Available in: v35.0_ _Filter group: Small_ * `type` (_object_) ConnectDirectoryEntryTypeEnum The type of entry. Value is `GroupEntry`. _Available in: v35.0_ _Filter group: Medium_ Includes all fields of `ConnectDirectoryEntryTypeEnumContenthub`. ### AbstractIdableContenthub Describing a person or thing that can act or be acted on in the organization. Corresponds directly to an actual record in the organization with an addressible ID. * `id` (_string (Id)_) 18-character ID of the record. _Available in: v23.0_ _Filter group: Small_ * `motif` (_object_) MotifContenthub Small, medium, and large icons indicating that the object is a user. The motif can also contain the object’s base color. The motif icon is not the user’s profile photo. _Available in: v27.0_ _Filter group: Small_ Includes all fields of `MotifContenthub`. * `mySubscription` (_object_) ReferenceChatter If the context user is following this user, contains information about the subscription, otherwise `null`. _Available in: v23.0_ _Filter group: Medium_ Includes all fields of `ReferenceChatter`. * `name` (_string_) Locale-based concatenation of first and last names. In version 39.0 and later, if nicknames are enabled, `name` is the nickname. _Available in: v23.0_ _Filter group: Small_ * `type` (_string_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) Relative URL to this record. _Available in: v23.0_ _Filter group: Small_ ### AbstractActorContenthub Describing a person or thing that can act or be acted on in the organization. May or may not correspond to an actual record in the organization, as some actors, such as certain system users, are synthetic in nature. * `name` (_string_) Locale-based concatenation of first and last names. In version 39.0 and later, if nicknames are enabled, `name` is the nickname. _Available in: v23.0_ _Filter group: Small_ * `type` (_string_) Type of record, such as `CustomObject` or `ContentDocument` . _Available in: v23.0_ _Filter group: Small_ ### ConnectGroupMembershipEnum _Available in: v23.0_ _Filter group: Small_ Type: `string`. Allowed values: `GroupManager`, `GroupOwner`, `NotAMember`, `NotAMemberPrivateRequested`, `StandardMember`. ### ConnectGroupVisibilityEnum Group visibility type. One of the following values: * `PrivateAccess` — Only members of the group can see posts to this group. * `PublicAccess` — All users within the Experience Cloud site can see posts to this group. * `Unlisted` — Reserved for future use. _Available in: v29.0_ Type: `string`. Allowed values: `PrivateAccess`, `PublicAccess`, `UnlistedAccess`. ### TrackedChangeBundleCapability If a feed element has this capability, it has a group of other feed elements aggregated into one feed element called a bundle. This type of bundle aggregates feed tracked changes. Bundled posts contain feed-tracked changes and are in record feeds only. * `bundleType` (_object_) ConnectBundleTypeEnum Type of bundle. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `ConnectBundleTypeEnum`. * `changes` (_array of FeedTrackedChange_) Collection of feed tracked changes. _Available in: v31.0_ _Filter group: Small_ * `page` (_object_) FeedElementCollection A collection of feed elements. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `FeedElementCollection`. * `totalElements` (_integer_) The total number of feed elements that this bundle aggregates. _Available in: v31.0_ _Filter group: Small_ ### ConnectUserTypeEnum If the record represented by this completion is a user, this value is the user type associated with that user; otherwise the value is `null`. Values are: * `ChatterGuest` — User is an external user in a private group. * `ChatterOnly` — User is a Chatter Free customer. * `Guest` — User is unauthenticated. * `Internal` — User is a standard org member. * `Portal` — User is an external user in an Experience Cloud site. * `System` — User is Chatter Expert or a system user. * `Undefined` — User is a user type that is a custom object. _Available in: v30.0_ _Filter group: Medium_ Type: `string`. Allowed values: `ChatterGuest`, `ChatterOnly`, `Guest`, `Internal`, `Portal`, `System`, `Undefined`. ### GenericBundleCapability If a feed element has this capability, the feed element may be a group of other feed elements condensed into one. Bundled posts contain feed-tracked changes and are in record feeds only. * `bundleType` (_object_) ConnectBundleTypeEnum Type of bundle. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `ConnectBundleTypeEnum`. * `page` (_object_) FeedElementCollection A collection of feed elements. _Available in: v31.0_ _Filter group: Small_ Includes all fields of `FeedElementCollection`. * `totalElements` (_integer_) The total number of feed elements that this bundle aggregates. _Available in: v31.0_ _Filter group: Small_ ### FeedElement A concrete instance of a generic Feed Element. Unless otherwise specified, a generic Feed Element can have shared properties: id, feedElementType, body, and capabilities. * `body` (_object_) FeedItemBody Information about the feed element. _Available in: v22.0_ _Filter group: Small_ Includes all fields of `FeedItemBody`. * `capabilities` (_object_, required) FeedElementCapabilitySet A container for all capabilities that can be included with a feed element. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedElementCapabilitySet`. * `createdDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z _Available in: v23.0_ _Filter group: Small_ * `feedElementType` (_object_) ConnectFeedElementTypeEnum Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element. One of these values: * `Bundle` — A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values. * `FeedItem` — A feed item has a single parent and is scoped to oneExperience Cloud site or across all Experience Cloud sites. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values. * `Recommendation` — A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user. _Available in: v31.0_ Includes all fields of `ConnectFeedElementTypeEnum`. * `header` (_object_, required) FeedItemBody The header is the title of the post. This property contains renderable plain text for all the segments of the message. If a client doesn't know how to render a feed element type, it should render this text. _Available in: v31.0_ _Filter group: Medium_ Includes all fields of `FeedItemBody`. * `id` (_string (Id)_, required) 18-character ID of the feed item. _Available in: v23.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z . _Available in: v23.0_ _Filter group: Small_ * `parent` (_object_, required) AbstractIdable The parent of the feed element. _Available in: v28.0_ _Filter group: Medium_ Includes all fields of `AbstractIdable`. * `relativeCreatedDate` (_string_) Created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.” . _Available in: v28.0_ _Filter group: Small_ * `url` (_string (url)_) URL to this feed item. _Available in: v23.0_ _Filter group: Small_ ### ConnectDirectoryEntryTypeEnum Specifies the type of directory entry. Type: `string`. Allowed values: `GroupEntry`, `UserEntry`. ### BatchResultItem Batch result item. * `result` (_string_) Dependent on the type of batch. Value could be one of the following: * Asset File for `/connect/file-assets/batch/{assetIds}` (v43.0) * Audience for `/connect/communities/{communityId}/personalization/audiences/batch/{audienceIds}` (v48.0) * Cart Item for `/commerce/webstores/{webstoreId}/carts/{cartId}/cart-items/batch` (v49.0) and `/commerce/webstores/{webstoreId}/carts/active/cart-items/batch` (v49.0) * Comment for `/chatter/comments/batch/{commentIds}` (v42.0) * Error Message (v23.0) * Feed Item for `/chatter/feed-elements/batch` (v32.0) and `/chatter/feed-elements/batch/{feedElementIds}` (v32.0) * File Summary for `/connect/files/batch/{fileIds}` (v26.0) * Group for `/chatter/groups/batch/{groupIds}` (v23.0) * Group Member for `/chatter/group-memberships/batch/{membershipIds}` (v27.0) * Motif for `/connect/motifs/batch/{idOrPrefixList}` (v27.0) * Read By Capability for `/chatter/feed-elements/batch/{feedElementIds}/capabilities/read-by` (v40.0) * Target for `/connect/communities/{communityId}/personalization/targets/batch/{targetIds}` (v47.0) * Topics People Are Knowledgeable About Collection for `/chatter/users/batch/{userIds}/knowledgeable-about-topics` (v36.0) * User Detail for `/chatter/users/batch/{userIds}` (v23.0) * For `/connect/batch`, the value can be any response body depending on the subrequest in the batch. (v28.0) _Filter group: Small_ * `statusCode` (_integer_) HTTP status code indicating the status of this individual request in the batch. _Available in: v23.0_ _Filter group: Small_