この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Folders のリソース

フォルダまたはフォルダの内容に関する情報。項目を変更したり、削除したり、フォルダに追加したりします。

使用可能なリソース:

リソース	説明
`/connect/folders/folderId`	指定されたフォルダに関する情報を取得します。フォルダの移動、名前の変更、および削除を行います。
`/connect/folders/folderId/items`	フォルダの内容に関する情報を取得します。フォルダへのファイルの追加や、フォルダの作成を行います。
`/connect/folders/folderId/folder-shares/link`	リンクとして共有されるフォルダ。フォルダの共有リンクの作成、アクセス、および削除を行います。

Folder Information

指定されたフォルダに関する情報を取得します。フォルダの移動、名前の変更、および削除を行います。フォルダを削除すると、そのフォルダ内のフォルダはすべて削除され、削除されたフォルダからすべてのファイルが削除されます。

リソース

1/connect/folders/folderId

root を folderId として使用できます。

メモ

適用開始バージョン

36.0

バージョン 30.0 ～ 35.0 では、Chatter が必要な /chatter/folders/folderId を使用します。

Chatter が必要かどうか

いいえ

HTTP メソッド

GET、HEAD、PATCH、DELETE

PATCH のリクエストボディ

Folder Input

PATCH の要求パラメータ

フォルダの移動

パラメータ	型	説明	必須か省略可能	使用可能なバージョン
`isInMyFileSync`	Boolean	フォルダおよびこのフォルダ内のすべてのフォルダが Salesforce Files Sync と同期されている場合は `true`、同期されていない場合は `false`。 Salesforce Files Sync は、2018 年 5 月 25 日に廃止されました。メモ	省略可能	33.0
`parentFolderId`	String	新しい親フォルダの ID。`null` の場合、フォルダは現在のフォルダから削除されます。指定された ID が `root` の場合、フォルダはユーザのフォルダ階層のルートに移動します。	必須	30.0

フォルダ名の変更

パラメータ	型	説明	必須か省略可能	使用可能なバージョン
`isInMyFileSync`	Boolean	フォルダおよびこのフォルダ内のすべてのフォルダが Salesforce Files Sync と同期されている場合は `true`、同期されていない場合は `false`。 Salesforce Files Sync は、2018 年 5 月 25 日に廃止されました。メモ	省略可能	33.0
`name`	String	フォルダの新しい名前	必須	30.0

GET および PATCH のレスポンスボディ

Folder

Folder Contents

フォルダの内容に関する情報を取得します。フォルダへのファイルの追加や、フォルダの作成を行います。

フォルダを作成するには、POST 要求でリクエストボディまたは要求パラメータを使用できます。

ファイルを作成するには、マルチパート/フォームデータの POST 要求のボディパートとして送信する必要があります。説明とタイトル情報を送信するには、マルチパート/フォームデータ要求の一部として JSON または XML リッチ入力ボディに含めます。または、説明、タイトル、および種別を要求パラメータで送信できます。「バイナリファイルのアップロード」を参照してください。ファイルを [ファイル] ホームにアップロードするには、/connect/files/users/me を使用します。

リソース

1/connect/folders/folderId/items

root を folderId として使用できます。

メモ

適用開始バージョン

36.0

バージョン 30.0 ～ 35.0 では、Chatter が必要な /chatter/folders/folderId/items を使用します。

Chatter が必要かどうか

いいえ

HTTP メソッド

GET と POST

GET の要求パラメータ

パラメータ	型	説明	必須か省略可能	使用可能なバージョン
`filter`	String	フォルダ内の項目の検索条件を指定します。	省略可能	33.0
`page`	Integer	項目のページを指定する整数。デフォルト値は 0 で、最初のページを返します。	省略可能	30.0
`pageSize`	Integer	ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。サイズを指定し��い場合、デフォルトは 25 です。	省略可能	30.0

GET のレスポンスボディ

Folder Item Page

POST のリクエストボディ

Folder Item Input

POST の要求パラメータ

フォルダへのファイルの追加

パラメータ	型	説明	必須か省略可能	使用可能なバージョン
`desc`	String	ファイルの説明	省略可能	30.0
`isInMyFileSync`	Boolean	フォルダおよびこのフォルダ内のすべてのフォルダが Salesforce Files Sync と同期されている場合は `true`、同期されていない場合は `false`。 Salesforce Files Sync は、2018 年 5 月 25 日に廃止されました。メモ	省略可能	33.0
`sharingOption`	String	ファイルの共有オプション。値は次のとおりです。 `Allowed` — ファイルの再共有が許可されます。 `Restricted` — ファイルの再共有が禁止されます。	省略可能	35.0
`sharingPrivacy`	String	ファイルの共有プライバシー。値は次のとおりです。 `None` — ファイルはレコードアクセス権のある全員に表示されます。 `PrivateOnRecords` — ファイルはレコードで非公開になります。	省略可能	41.0
`title`	String	ファイルのタイトル	省略可能	30.0
`type`	String	項目の種別。ファイルをフォルダに追加するには、値を `File` にする必要があります。	必須	30.0

フォルダの作成

パラメータ	型	説明	必須か省略可能	使用可能なバージョン
`folderPath`	String	フォルダへのパス	必須	30.0
`isInMyFileSync`	Boolean	フォルダおよびこのフォルダ内のすべてのフォルダが Salesforce Files Sync と同期されている場合は `true`、同期されていない場合は `false`。 Salesforce Files Sync は、2018 年 5 月 25 日に廃止されました。メモ	省略可能	33.0
`type`	String	項目の種別。フォルダを作成するには、値を `Folder` にする必要があります。	必須	30.0

POST のレスポンスボディ

Folder Item

ファイルをフォルダに追加する例

1{
2   "file" :
3      {
4         "description" : "Yearly Report for Universal Containers Box Division",
5         "title" : "Yearly.txt"
6      },
7   "type" : "File"
8}

フォルダを作成する例

1{
2   "folder" :
3      {
4         "path" : "my_documents/my_folder"
5      },
6   "type" : "Folder"
7}

Connect REST API 開発者ガイド

Folders のリソース

Folder Information

Folder Contents