FileDownload

メソッドの要約

取得/scr/api/FileDownload

説明

プロセス、インスタンス、またはコメントに添付されているファイルをダウンロードするには、このメソッドを使用します。

リソース情報

要件	説明
応答フォーマット	アップロード時の形式と同じ形式の、ファイルの生データ。
認証が必要	はい。 ユーザーには少なくとも、ファイルが添付されているプロセス、インスタンス、または投稿へのアクセス権限が必要です。 まだ投稿されていない投稿や、まだ開始されていないインスタンスにファイルが添付されている場合、そのファイルは、それをアップロードしたユーザーのみがダウンロードできます。
OAuth 2 クライアント資格情報のサポート	はい (成果物レポート・カテゴリーを含むユーザー・サービス ID を使用)
指定時間内の数の制限	現在はなし

パラメーター

ファイルが添付されているオブジェクトを指定するため、ユーザーは次のいずれかのパラメーターを指定する必要があります。

• processId
• instanceId
• postId

ファイルの添付先が、まだ投稿されていない投稿や開始されていないインスタンスの場合、ユーザーは　postId や instanceId を指定する必要はありません。

名前	Location	説明	必須	タイプ
X-On-Behalf-Of	ヘッダー	ユーザー・コンテキスト。 値は、アカウントに含まれるユーザー名でなければなりません。 ユーザーは、アカウント内と、親スペースを指定した場合はその親スペース内でアクションを実行する権限を持っている必要があります。	サービスID OAuth の認証情報を使用する場合に必要です。 ユーザーサービスID OAuth の認証情報を使用する場合、不要です。	ストリング
fileItemId	照会	ダウンロードするファイル項目の ID。 このパラメーターは、FileUpload、ProcessData、WorkDetail、または AppDetail からの応答のプロパティーとして返されます。 FileUpload、WorkDetail、および AppDetail の場合、使用する値は id フィールドに含まれます。 ProcessData の場合、この値は files ディクショナリー内のキーに対応します。	はい	ストリング
instanceId	照会	ファイルの添付先のインスタンスの ID。	ダウンロードするファイルがインスタンスに添付されている場合は、はい。	ストリング
postId	照会	ファイルの添付先の投稿の ID。	ダウンロードするファイルが投稿に添付されている場合は、はい。	ストリング
processId	照会	添付ファイルのあるアクティビティーが含まれているプロセスの ID。	ダウンロードするファイルがプロセスに添付されている場合は、はい。	ストリング

応答

ファイルからのデータ。

入力例

• ユーザーサービスID OAuth 2 のクライアント認証情報を使用：

  curl -i -H "Authorization: Bearer access_token" 
      "https://your_server_url/scr/api/FileDownload?fileItemId=9042b"

• サービスID OAuth を使用して、2つのクライアント認証情報を利用します：

  curl -i -H "Authorization: Bearer access_token" 
      "https://your_server_url/scr/api/FileDownload?fileItemId=9042b"

• サービスID OAuth を使用し、ユーザーコンテキストを持つ2つのクライアント認証情報:

  curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" 
      "https://your_server_url/scr/api/FileDownload?fileItemId=9042b"

出力例

ファイル・データ

応答プロパティー

なし

応答メッセージ

HTTP コード	理由
400	要求が正しくありません。 詳しくは、応答本体を参照してください。
401	ユーザーには、要求を行う権限がありません。
403	ユーザーには、ファイルが添付されているプロセス、インスタンス、または投稿へのアクセス権限がありません。