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

Users Files, General

外部ファイルへの参照を含む、[ファイル] ホームへのファイルのアップロード、またはユーザが所有するファイルに関する情報の取得を行います。ユーザと共有されているファイル、ユーザがフォローしているファイル、一般的な組織ファイルは対象外です。

ファイルを [ファイル] ホームにアップロードすると、ファイルは非公開になり、ファイル所有者のみが使用できるようになります。

ファイルをアップロードするには、マルチパート/フォームデータ要求で送信します。ファイルの説明とタイトルをマルチパート/フォームデータ要求に JSON または XML リクエストボディとして含めることができます。情報を要求パラメータとして送信することもできます。マルチパート/フォームデータメッセージを作成する方法についての詳細は、「バイナリファイルのアップロード」を参照してください。

このリソースは、大量のデータを返すことができます。その場合は処理に多少時間がかかります。

重要

リソース

適用開始バージョン

36.0

バージョン 24.0 ～ 35.0 では、Chatter が必要な /chatter/users/userId/files および /connect/communities/communityId/chatter/users/userId/files を使用します。

Chatter が必要かどうか

いいえ

HTTP メソッド

GET、POST、または HEAD

POST のリクエストボディ

ファイルをアップロードするには、name="fileData" のマルチパート/フォームデータボディパートにそのバイナリファイルを含める必要があります。「バイナリファイルのアップロード」を参照してください。

ルート XML タグ

<fileInput>

ファイルを作成する JSON の例

外部ファイルへの参照を作成する JSON の例

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
`contentModifiedDate`	String	ファイル固有の最終更新日。クライアント側の更新日を設定するために使用できます。ISO 8601 形式で日付を指定します。	省略可能	32.0
`desc`	String	アップロードするファイルの説明。	省略可能	24.0
`includeExternalFilePermissionsInfo`	Boolean	ファイルを共有するかどうか、外部ファイルに対して使用可能な権限タイプなどの、権限情報を含めるかどうかを示します。このプロパティは、`/connect/files/users/userId` に対する POST 要求では使用できますが、`/connect/files/fileId` に対する POST 要求では使用できません。	省略可能	35.0
`isInMyFileSync`	Boolean	ファイルが Salesforce Files Sync と同期されている場合は `true`、同期されていない場合は `false`。 Salesforce Files Sync は、2018 年 5 月 25 日に廃止されました。メモ	省略可能	31.0
`isMajorVersion`	Boolean	ファイルがメジャーバージョンの場合は `true`、ファイルがマイナーバージョンの場合は `false`。メジャーバージョンを置き換えることはできません。	省略可能	31.0
`parentFolderId`	String	収容フォルダの ID。	省略可能	31.0
`repositoryFileId`	String	外部ファイルの ID。このプロパティは、`/connect/files/users/userId` に対する POST 要求では使用できますが、`/connect/files/fileId` に対する POST 要求では使用できません。 `repositoryFileId` を指定する場合は、`repositoryFileUri` を指定しないでください。	省略可能	32.0
`repositoryFileUri`	String	外部ファイルの URI (https://drive.google.com/file/d/0B7a_ei8brT1TMy1CQ0o5NmZQNEE/view など)。このプロパティは、`/connect/files/users/userId` に対する POST 要求では使用できますが、`/connect/files/fileId` に対する POST 要求では使用できません。 `repositoryFileUri` を指定する場合は、`repositoryFileId` を指定しないでください。	省略可能	39.0
`repositoryId`	String	外部データソースの ID。このプロパティは、`/connect/files/users/userId` に対する POST 要求では使用できますが、`/connect/files/fileId` に対する POST 要求では使用できません。	`repositoryFileId` が指定されている場合は必須。それ以外の場合は省略可能。	32.0
`reuseReference`	Boolean	外部ファイルに対して所有している参照を複製するのではなく、その最新バージョンを再利用するかどうかを指定します。このプロパティは、`/connect/files/users/userId` に対する POST 要求では使用できますが、`/connect/files/fileId` に対する POST 要求では使用できません。	省略可能	36.0
`sharingOption`	String	ファイルの共有オプション。値は次のとおりです。 `Allowed` — ファイルの再共有が許可されます。 `Restricted` — ファイルの再共有が禁止されます。	省略可能	35.0
`sharingPrivacy`	String	ファイルの共有プライバシー。値は次のとおりです。 `None` — ファイルはレコードアクセス権のある全員に表示されます。 `PrivateOnRecords` — ファイルはレコードで非公開になります。	省略可能	41.0
`title`	String	ファイルのタイトル。	省略可能	24.0

POST の要求パラメータ

名前	型	説明	必須か省略可能	使用可能なバージョン
`contentModifiedDate`	String	ファイル固有の最終更新日。クライアント側の更新日を設定するために使用できます。ISO 8601 形式で日付を指定します。	省略可能	32.0
`desc`	String	ファイルの説明	省略可能	24.0
`includeExternalFilePermissionsInfo`	Boolean	ファイルを共有するかどうか、外部ファイルに対して使用可能な権限タイプなどの、権限情報を含めるかどうかを示します。	省略可能	35.0
`isDataSync`	Boolean	自動クライアントが要求を生成します。	省略可能	31.0
`isInMyFileSync`	Boolean	ファイルが Salesforce Files Sync と同期されている場合は `true`、同期されていない場合は `false`。 Salesforce Files Sync は、2018 年 5 月 25 日に廃止されました。メモ	省略可能	31.0
`isMajorVersion`	Boolean	ファイルがメジャーバージョンの場合は `true`、ファイルがマイナーバージョンの場合は `false`。メジャーバージョンを置き換えることはできません。デフォルト値は、`false` です。	省略可能	31.0
`repositoryFileId`	String	外部ファイルの ID。	省略可能	32.0
`repositoryFileUri`	String	外部ファイルの URI (https://drive.google.com/file/d/0B7a_ei8brT1TMy1CQ0o5NmZQNEE/view など)。	省略可能	39.0
`repositoryId`	String	外部データソースの ID。	`repositoryFileId` が指定されている場合は必須。それ以外の場合は省略可能。	32.0
`reuseReference`	Boolean	外部ファイルに対して所有している参照を複製するのではなく、その最新バージョンを再利用するかどうかを指定します。	省略可能	36.0
`sharingOption`	String	ファイルの共有オプション。値は次のとおりです。 `Allowed` — ファイルの再共有が許可されます。 `Restricted` — ファイルの再共有が禁止されます。	省略可能	35.0
`sharingPrivacy`	String	ファイルの共有プライバシー。値は次のとおりです。 `None` — ファイルはレコードアクセス権のある全員に表示されます。 `PrivateOnRecords` — ファイルはレコードで非公開になります。	省略可能	41.0
`title`	String	ファイルのタイトル	省略可能	24.0

GET の要求パラメータ

パラメータ名	型	説明	適用開始バージョン
`page`	Integer	項目のページを指定する整数。デフォルト値は 0 で、最初のページを返します。	24.0
`pageSize`	Integer	ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。	24.0
`q`	String	結果を絞り込むクエリ文字列。文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。ワイルドカードについての詳細は、「ワイルドカード」を参照してください。	27.0

GET のレスポンスボディ

File Summary Page

POST のレスポンスボディ

File Summary

POST 要求の例

次の例では、ファイルを作成して Salesforce にアップロードします。この例は、マルチパート/フォームデータ要求のボディパートを示します。最初のボディパートは File Input リクエストボディです。2 つ目は、ファイルの内容です。詳細は、「バイナリファイルのアップロード」を参照してください。

Chatter REST API 開発者ガイド

Users Files, General