Connect REST API 開発者ガイド
j入力およびバイナリファイルのアップロードの例
入力での POST、PATCH、または PUT の使用
HTTP POST、PATCH、および PUT メソッドを使用して要求を行うとき、要求パラメーターまたはリクエストボディを使用できます。リクエストボディには、JSON または XML を含めることができます。リソース固有の要求パラメーターとリクエストボディを渡すと、要求パラメーターが無視されます。リソースに固有でない要求パラメーター (ベアラートークン URL 内のパラメーターや _HttpMethod パラメーターなど) はリクエストボディと共に処理されます。ベアラートークンパラメーターはそのまま使用します。パラメーターの追加や削除はしないでください。
要求パラメーターを使用して要求を送信するには、値 application/x-www-form-urlencoded を指定した Content-Type ヘッダー項目を使用します。
リクエストボディを使用して要求を送信するには、Content-Type ヘッダー項目と Accept ヘッダー項目に次のいずれかの値を使用します。
- application/json
- application/xml
バイナリファイルのアップロード
バイナリファイルは、2 GB (ヘッダーを含む) までアップロード可能で、外部リポジトリの場合は 75 MB までアップロード可能、会話を一括でアップロードする場合は 512 MB まで可能です。その際は、バイナリファイルをマルチパート/フォームデータ要求のボディパートとして送信します。コメントのテキストは、同じマルチパート/フォームデータ要求の JSON または XML リッチ入力ボディパートとして送信できます (ただし、投稿のテキストは送信できません)。または、その情報を要求パラメーターで送信するように選択することもできます。リッチ入力リクエストボディと要求パラメーターの両方を渡すと、要求パラメーターは無視されます。
同じコールで複数のバイナリファイルをアップロードするには、「Batch リソース」を参照してください。
マルチパート/フォームデータ要求を作成するには、要求のヘッダーで Content-Type HTTP ヘッダーを multipart/form-data に設定します。
HTTP ヘッダーについての詳細は、W3C フォームコンテンツタイプと、マルチパート/フォームデータインターネットメディアタイプが定義されている「RFC 2388」を参照してください。
次の表では、マルチパート/フォームデータ要求のリッチ入力ボディパートに必要な HTTP ヘッダーとパラメーターを説明します。
| リッチ入力ボディパートの HTTP ヘッダー | ヘッダー値とパラメーター | 説明 |
|---|---|---|
| Content-Disposition |
form-data; name="json" form-data; name="xml" |
投稿またはコメントのリクエストボディ。 JSON の場合は、name の値に "json" を使用します。 XML の場合は、name の値に "xml" を使用します。 |
| Content-Type |
application/json; charset=UTF-8 application/xml; charset=UTF-8 |
リクエストボディのデータ形式と文字セット。 JSON の場合、値は application/json にする���要があります。 XML の場合、値は application/xml にする必要があります。 |
次の表では、Web ブラウザーからのマルチパート/フォームデータ要求のリッチ入力ボディパートに必要な HTTP ヘッダーとパラメーターについて説明します。
| Web ブラウザーからのリッチ入力ボディパートの HTTP ヘッダー | ヘッダー値とパラメーター | 説明 |
|---|---|---|
| Content-Disposition | form-data; name="feedElement" | バイナリファイルを含むフィード要素を投稿するには、name の値を "feedElement" にする必要があります (バージョン 35.0 以前の場合)。 |
| form-data; name="comment" | バイナリファイルを含むコメントを投稿するには、name の値を "comment" にする必要があります。 | |
| form-data; name="photo" | 従業員、ユーザー、またはグループの写真をアップロードするには、name の値を "photo" にする必要があります。 | |
| form-data; name="file" | [ファイル] ホームまたは外部リポジトリにファイルをアップロードするには、name の値を "file" にする必要があります。 | |
| form-data; name="folderItem" | ファイルをフォルダーにアップロードするには、name の値を "folderItem" にする必要があります。 | |
| form-data; name="ManagedContentInputParam" | 管理コンテンツの一部をアップロードするには、name の値を "ManagedContentInputParam" にする必要があります。 | |
| form-data; name="ManagedContentVariantInputParam" | 管理コンテンツのバリエーションを更新するには、name の値を "ManagedContentVariantInputParam" にする必要があります。 |
次の表では、マルチパート/フォームデータ要求のバイナリアップロードボディパートに必要な HTTP ヘッダーとパラメーターを説明します。
| バイナリアップロードボディパートの HTTP ヘッダー | ヘッダー値とパラメーター | 説明 |
|---|---|---|
| Content-Disposition | form-data; name="feedElementFileUpload"; filename=string |
バイナリファイルを含むフィード要素を投稿するには、name の値を "feedElementFileUpload" にする必要があります (バージョン 35.0 以前の場合)。 バイナリファイルを含むコメントを投稿するには、name の値を "feedElementFileUpload" にする必要があります。 |
| form-data; name="fileUpload" filename=string | ユーザーまたはグループの写真をアップロードするには、name の値を "fileUpload" にする必要があります。 | |
| form-data; name="fileData" filename=string | [ファイル] ホームにファイルをアップロードする、または外部リポジトリにファイルをアップロードするには、name の値を "fileData" にする必要があります。 | |
| form-data; name="audioFileData" filename=string | オーディオファイルをアップロードするには、name の値を "audioFileData" にする必要があります。この値を使用する場合は、recordingURL または name を指定すると要求が失敗しますので指定しないでください。 | |
| form-data; name="contentData" filename=string | 管理コンテンツの一部をアップロードまたは管理コンテンツのバリエーションを更新するには、name の値を "contentData" にする必要があります。 | |
| Content-Type | application/octet-stream; charset=ISO-8859-1 | バイナリファイルのメディアタイプと文字セット。 |
バイナリファイルを含むフィード要素の投稿 (バージョン 35.0 以前)
バイナリファイルを含むフィード要素の一括投稿 (バージョン 35.0 以前)
バイナリファイルを含むコメントの投稿
バイナリファイルを含む複数のコメントの投稿
richInput プロパティには、各サブ要求のリクエストボディを含めます。
また、binaryPartName および binaryPartNameAlias プロパティには、バイナリパートに関する情報を含めます。