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

File Shares

指定されたファイルの共有先であるオブジェクトに関する情報を返します。オブジェクトはユーザ、グループ、またはレコードの場合があります。指定されたファイルをユーザと共有する場合にも使用できます。

リソース

1/connect/files/fileId/file-shares

1/connect/communities/communityId/files/fileId/file-shares

適用開始バージョン

36.0

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

Chatter が必要かどうか

いいえ

HTTP メソッド

GET、HEAD、POST

POST は、バージョン 30.0 以降で使用できます。

GET の要求パラメータ

バージョン 30.0 以降の場合、GET 要求で最初に返される共有は組織のレコード共有です。コミュニティの場合、最初に返される共有はネットワークレコード共有です。

名前	型	説明	必須か省略可能	適用開始バージョン
`page`	Integer	トピックのページを指定する 0 より大きい整数。��フォルト値は、0 です。	省略可能	24.0
`pageSize`	Integer	ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。デフォルト値は 25 です。	省略可能	24.0

POST のリクエストボディ

ルート XML タグ

<fileShares>

JSON の例

1{
2  "message": "I shared a document with you.",
3  "shares": [
4     { "id": "005D0000001Az4l", "sharingType": "V" },
5     { "id": "005D0000001B2ny", "sharingType": "C" }
6   ]
7}

プロパティ

名前	型	説明	使用可能なバージョン
`message`	String	受信者に送信される非公開のメッセージ本文。Salesforce コミュニティが有効な場合、非公開メッセージではなくメールが送信されます。	30.0
`shares`	Share Input[]	Share Input リクエストボディのコレクション。	30.0

POST の要求パラメータ

ファイルをユーザと共有するためのパラメータ

名前	型	説明	必須か省略可能	適用開始バージョン
`id(1–9)`	String	このファイルの共有先である最大 9 個のユーザ ID のリスト。このリストは、共有種別のリストと一致する必要があります。	必須	30.0
`message`	String	受信者に送信される非公開のメッセージ本文。Salesforce コミュニティが有効な場合、非公開メッセージではなくメールが送信されます。	省略可能	30.0
`sharingType(1–9)`	String	共有種別のリスト。コラボレータの場合は `C`、閲覧者の場合は `V` です。このリストは、ユーザ ID のリストと一致する必要があります。	必須	30.0

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

File Shares Page

POST の例

次の例では、要求パラメータを使用してファイルを 2 人のユーザと共有します。

1POST /connect/files/069D00000001JDU/file-shares?id1=005D0000001LL8O&id2=005D0000001QdEL&sharingType1=C&sharingType2=V

次は、同じ例にリクエストボディを使用しています。

1POST /connect/files/069D00000001JDU/file-shares
2
3{
4  "shares": [
5     { "id": "005D0000001LL8O", "sharingType": "C" },
6     { "id": "005D0000001QdEL", "sharingType": "V" }
7   ]
8}

Chatter REST API 開発者ガイド

File Shares