ドキュメント Web フックを介したファイルのアップロード
作成対象：
- 開発者
ファイルをドキュメントストレージプロバイダーにアップロードするプロセスは、2 つの異なる API エンドポイントを必要とする 2 段階の手順です。Adobe Workfront は、/uploadInit を呼び出して、アップロードプロセスを開始します。このエンドポイントはドキュメント ID を返します。この ID は、ドキュメントのバイトデータをアップロードする際に /upload に渡されます。基盤となるドキュメントストレージシステムによっては、長さ 0 のドキュメントを作成し、後でドキュメントの内容を更新する必要がある場合があります。
ドキュメント ID とドキュメントバージョン ID を使用して、Workfront から追加の情報を取得できる機能が、この仕様のバージョン 1.1 に追加されました。
例： ドキュメント管理システムがドキュメントに関する追加情報を必要とする場合、web フックの実装コードは、ドキュメント ID を使用して、Workfront の RESTful API でその情報を取得できます。このような情報は、ドキュメントのカスタムデータフィールドから取得するのが優れたプラクティスです。また、情報にはタスク、イシューまたはプロジェクトを含めます。
POST メソッド
URL
POST /uploadInit
クエリパラメーター
| 名前 | 説明 |
|---|---|
| parentId | Web フックプロバイダーで参照される親フォルダー ID。 |
| filename | ドキュメントの名前 |
| documentId | Workfront ドキュメント ID（バージョン 1.1 で追加） |
| documentVersionId | Workfront ドキュメントのバージョン ID（バージョン 1.1 で追加） |
応答
/metadata エンドポイントで定義した、ファイルのメタデータです。プロバイダーが使用するドキュメント ID が含まれます。
例：
https://www.acme.com/api/uploadInit?parentId=12345&filename=new-file.png&documentId=511ea6e000023edb38d2effb2f4e6e3b&documentVersionId=511ea6e000023edb38d2e ffb2f4e6e3b
PUT メソッド
Web フックプロバイダーにドキュメントのバイトデータをアップロードします。
URL
PUT /upload
クエリパラメーター
| 名前 | 説明 |
|---|---|
| id | 前半で作成されたドキュメント ID。 |
リクエスト本文
ドキュメントの Raw コンテンツのバイトデータです。
応答
{
result: "success"
}
または
{
result: "fail"
}
例
https://www.acme.com/api/upload?id=1234 [document bytes included in update stream]
応答
{
result:"success"
}