FileUpload

プロセス・アクティビティーまたは作業項目に添付ファイルを追加するには、このリソースを使用します。

メソッドの要約

HTTP メソッド	パス	説明
POST	/scr/api/FileUpload	添付ファイルをプロセス・アクティビティーまたは作業項目に追加します。

POST /scr/api/FileUpload

説明: 添付ファイルをプロセス・アクティビティーまたは作業項目に追加するには、このメソッドを使用します。

リソース情報

要件	説明
応答フォーマット	JSON
認証が必要	はい。ユーザーには、ファイルの添付先となるプロセスに対する作成者権限が必要です。
OAuth 2 クライアント資格情報のサポート	はい (成果物オーサリング・カテゴリーを含むユーザー・サービス ID を使用)
指定時間内の数の制限	現在はなし

パラメーター

locationField、ancestorIdField、parentIdField、および fileData への入力は、標準のマルチパート・フォーム・データの形式で渡す必要があります。

名前	Location	説明	必須	タイプ
X-IBM-API-Version	ヘッダー	使用する API のバージョン。値は `20160630` でなければなりません。	いいえ	ストリング
X-On-Behalf-Of	ヘッダー	ユーザー・コンテキスト。値は、アカウントに含まれるユーザー名でなければなりません。ユーザーは、アカウント内と、親スペースを指定した場合はその親スペース内でアクションを実行する権限を持っている必要があります。	サービス ID OAuth 資格情報を使用する場合は必須です。ユーザー・サービス ID OAuth 資格情報を使用する場合は不要です。	ストリング
fileData	照会	ファイル・データ。	はい	RFC 1867 準拠の multipart/form-data ストリーム
locationField	照会	指定できる値は、ファイル添付先のオブジェクトに応じて、`activity`、`app`、`decision`、`instance`、`policy`、または `post` です。	はい	ストリング
ancestorIdField	照会	意味は locationField の値によって以下のように異なります。 `activity` の場合、Process Blueprint ID `app` の場合、プロセス・アプリケーション ID `decision` の場合、デシジョン・ダイアグラム ID `instance` の場合、既存のインスタンスの作業 ID 上記以外の locationField 値については、このパラメーターを指定する必要はありません	はい	ストリング
parentIdField	照会	意味は locationField の値によって以下のように異なります。 `activity` の場合、プロセス ID `app` の場合、アプリケーション ID `decision` の場合、デシジョン ID `instance` の場合、既存のインスタンスの作業 ID `policy` の場合、ポリシー ID `post` の場合は、この値を指定する必要はありません	はい	ストリング

応答

出力例

{  
   "size":"3.0",
   "parentId":"",
   "uploadUserId":"7f0002",
   "fileItemId":"123b",
   "name":"testFileUpload",
   "ancestorId":"",
   "uploadDate":"1441217698308",
   "status":"SUCCESS",
   "isPublic":"false",
   "location":"instance",
   "uploadUserName":"admin",
   "version":"20160630",
   "type":"1",
   "id":"5f501e134978a"
}

応答プロパティー

uploadUserId

ファイルをアップロードしたユーザーの ID。

location

ファイルがアップロードされた場所。

status

アップロードの試行結果を示すストリング値。可能な値には、次のものがあります。

SUCCESS: 操作は正常に終了しました。
FAILED: アップロードが失敗しました。
FAILED_DELETED: アップロードが失敗しました。ファイルにウィルスが含まれていないことを確認して、再試行してください。
SIZE: ファイルが 50 MB を超えたため、アップロードが失敗しました。
SPACE: アカウントに十分な空きスペースがなかったため、アップロードが失敗しました。

type

ファイルまたは文書のタイプ (関連付けられた数値で示される)。

タイプ値	説明
1	一般文書。ファイルが他のどの値にも該当しない場合に使用されます。
2	Microsoft Excel ファイル
3	画像
4	PDF 文書
5	Microsoft PowerPoint 文書
6	Microsoft Project 文書
7	Microsoft Visio 文書
8	Microsoft Word 文書
9	テキスト・ファイル

version

応答の作成に使用した API のバージョン。

size

アップロードされたファイルのサイズ (バイト単位)。

id

アップロードされたプロファイルの ID。 FileDownload サービスでこの ID を使用して、ファイルをダウンロードします。

parentId

アップロードされたファイルの添付先である親項目の ID。

name

アップロードされたファイルの名前。

ancestorId

アップロードされたファイルが属する上位項目の ID。

uploadDate

ファイルがアップロードされた日。値は、エポック、すなわち協定世界時 (UTC) 1970 年 1 月 1 日真夜中からの経過時間 (ミリ秒) で表されます。

uploadUserName

ファイルをアップロードしたユーザーの名前。

応答メッセージ

HTTP コード	理由
200	要求は正常に完了しました。
401	ユーザーには、要求を行う権限がありません。
405	指定されたメソッドは許可されていません。 POST メソッドを選択してください。