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

File Information

外部ファイルへの参照を含む、指定されたファイルに関する情報を取得します。外部ファイルへの参照を含む、既存のファイルの新バージョンをアップロードします。ファイルの名称変更、別のフォルダへの移動、ファイルの削除を行います。

既存のファイルの新しいバージョンをアップロードするには、POST 要求を実行します。新しいバージョンを、マルチパート/フォームデータ要求のバイナリパートとしてアップロードします。「バイナリファイルのアップロード」を参照してください。新しいファイルを [ファイル] ホームにアップロードするには、/connect/files/users/me を使用します。

リソース

1/connect/files/fileId

1/connect/communities/communityId/files/fileId

適用開始バージョン

36.0

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

Chatter が必要かどうか

いいえ

HTTP メソッド

GET、POST、PATCH、DELETE、または HEAD

POST、PATCH、および DELETE は、バージョン 26.0 以降で使用できます。

メモ

POST のリクエストボディ

SharePoint 2010 へのアップロードは、最大 3 MB です。

ルート XML タグ

<fileInput>

JSON

1{
2     "desc" : "Employee Survey Results",
3     "title" : "emp_surv_results"
4}

プロパティ

名前	型	説明	必須項目/省略可能	使用可能なバージョン
`contentModifiedDate`	Date	ファイル固有の最終更新日。クライアント側の更新日を設定するために使用できます。	省略可能	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`。	省略可能	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
`title`	String	ファイルのタイトル。	省略可能	24.0

POST の要求パラメータ

SharePoint 2010 へのアップロードは、最大 3 MB です。

名前	型	説明	使用可能なバージョン
`desc`	String	アップロードするファイルの説明。	26.0
`isDataSync`	Boolean	自動クライアントが要求を生成するかどうかを示します。	31.0
`isInMyFileSync`	Boolean	ファイルが Salesforce Files Sync と同期されている場合は `true`、同期されていない場合は `false`。	31.0
`isMajorVersion`	Boolean	ファイルがメジャーバージョンの場合は `true`、ファイルがマイナーバージョンの場合は `false`。メジャーバージョンを置き換えることはできません。	31.0
`sharingOption`	String	ファイルの共有オプション。値は次のとおりです。 `Allowed` — ファイルの再共有が許可されます。 `Restricted` — ファイルの再共有が禁止されます。	35.0
`title`	String	ファイルのタイトル。	26.0

GET の要求パラメータ

指定されたファイルに関する情報を取得します。

名前	型	説明	使用可能なバージョン
`versionNumber`	Integer	ファイルの既存のバージョン番号を指定します。指定されていない場合、最新のバージョンが返されます。	23.0

PATCH の要求パラメータ

ファイルのタイトルまたは同期状態の更新や、別のフォルダへのファイルの移動を行います。

名前	型	説明	使用可能なバージョン
`desc`	String	ファイルの新しい説明	32.0
`title`	String	ファイルの新しいタイトル	26.0
`isInMyFileSync`	Boolean	ファイルが Salesforce Files Sync と同期されている場合は `true`、同期されていない場合は `false`。	31.0
`parentFolderId`	String	収容フォルダの ID	31.0
`sharingOption`	String	ファイルの共有オプション。値は次のとおりです。 `Allowed` — ファイルの再共有が許可されます。 `Restricted` — ファイルの再共有が禁止されます。	35.0

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

File Detail

DELETE のレスポンスボディ

状況コード 204 を返します。

例

この PATCH 要求は、ファイルのタイトルを更新します。

1/connect/files/069D00000001FHF?title=A+New+Title

Chatter REST API 開発者ガイド

File Information