添付ファイル

添付ファイルリソースは、他のリソースとは異なり、エンティティデータとバイナリコンテンツの両方を表します。

概要

次の点に注意してください。

現在、添付ファイルはワークスペースコンテキストでのみサポートされています (エンティティメタデータが反映されているため)。
添付ファイルAPIは、ワークスペース内のすべての添付ファイルへの汎用アクセスを提供します。その結果、添付ファイルフィーチャーを持つエンティティごとに、添付ファイルエンティティにはエンティティへの参照フィールドがあります。
参照フィールド名は、次の規則に従います。

owner_<エンティティ名>

例:owner_test

添付エンティティには、1つの所有者エンティティのみへの参照が必要です。

サポートされているファイルタイプ

ALM Octaneは、標準設定で次のファイルタイプをサポートしています。

サポートされるファイルタイプをカスタマイズするには、ATTACHMENTS_FILE_EXTENSION_WHITE_LIST設定パラメーターを変更します。詳細については、設定パラメーターを参照してください。

REST APIは、ファイル拡張子がバイナリコンテンツ形式と一致することを確認します。拡張子とコンテンツ形式が一致しない場合、添付ファイルはアップロードされません。

一部のHTTPメソッドでは、リソースコレクションは他のコレクションエンティティと同じように動作し、バイナリコンテンツを含まない添付エンティティデータのみを表します。他のHTTPメソッドでは、バイナリコンテンツへの参照があります。

URI

添付ファイルは、ワークスペースのコンテキストにのみ関連します。

.../api/shared_spaces/<space_id>/workspaces/<workspace_id>/attachments

注: URIでパラメーターを指定するための構文については、変数と値を参照してください。

サポートされているHTTPリクエストメソッド

添付ファイルコレクションは、次のHTTPメソッドをサポートしています。

方法	説明
GET	添付ファイルまたは実際の添付ファイルに関するデータを取得します。
POST	コレクションに新しい添付ファイルを作成します。
PUT	添付ファイルに関する情報を更新します (バイナリデータではありません)。
DELETE	既存の添付ファイルを削除します。

注: 実際の添付ファイル (バイナリデータ) を更新するには、元の添付ファイルを削除して、新しい添付ファイルをPOSTします。

添付ファイルコレクションに対するアクション

添付ファイルインスタンスには、添付ファイルのエンティティデータとバイナリコンテンツの両方が含まれます。

サポートされているHTTPリクエストメソッド

アタッチメントインスタンスは、次のHTTPメソッドをサポートします。

方法	説明
GET	添付ファイルまたは実際の添付ファイルに関するデータを取得します。
POST	コレクションに新しい添付ファイルを作成します。
PUT	添付ファイルに関する情報を更新します (バイナリデータではありません)。添付ファイルのエンティティデータのみを更新できます。
DELETE	既存の添付ファイルを削除します。

注: 実際の添付ファイル (バイナリデータ) を更新するには、元の添付ファイルを削除し、コレクション内の新しい添付ファイルをPOSTします。

添付ファイルインスタンスに対するアクション

REST APIを介してメモフィールドに埋め込んだ画像は、UIに貼り付けた画像と同じように処理されます。画像は画像ファイルに変換されます。ファイルはファイルリポジトリに保存され、選択したメモフィールドから参照されます。

UIを介した添付ファイルのアップロードを管理する同じルールが、REST APIを介して投稿された画像に適用されます。

たとえば、コマンドは、MAX_ATTACHMENT_COUNT_PER_ENTITYなどの関連する構成パラメーターに対して検証されます。詳細については、設定パラメーターを参照してください。

参照情報: