Design Automation:WorkItem クエリーの追加

A person is working on a laptop at a desk, with a large monitor displaying a 3D model. The desk has various items including a cup, notebook, and headphones.


ドキュメントへの記載が遅れていますが、Design Automation API の利便性向上を目的に、WorkItem 関連の新しい機能が追加されました。GET workitems/:id エンドポイントへの新しいクエリーパラメータと WorkItem ステータスを得る新しいエンドポイントの追加です。


WorkItem IDの取得

既存の GET workitems/:id エンドポイントに新しいクエリーパラメータ startAfterTime が追加されました。startAfterTime パラメータを利用すると、指定した UNIX 時間 以降に起動した WorkItem の ID 一覧を JSON 内の配列で返します。

メソッド:GET
エンドポイント:https://developer.api.autodesk.com/da/us-east/v3/workitems
クエリーパラメータ:startAfterTime=<<UNIX 時間>>
リクエスト ヘッダー:Authorization Bearer  <<アクセス トークン>>

例:

Postman interface displaying a GET request to Autodesk API with Authorization headers and JSON body showing WorkItem IDs and last modified timestamps.

WorkItem ステータスの取得

複数の WorkItem ID からステータスを得るための新しいエンドポイントです。リクエスボディに WorkItem ID を配列指定すると、レポート URL を含むステータス等の情報が同じく配列で返されます。

メソッド:POST
エンドポイント:https://developer.api.autodesk.com/da/us-east/v3/workitems/status
リクエスト ヘッダー:Authorization Bearer  <<アクセス トークン>>
リクエスト ヘッダー:Content-Type  application/json
リクエスト ボディ: [“workitem id1″,”workitem id2″,”workitem id3”, …]

  • WorkItem のステータスは、WirkItem 完了後、3 日間のみ保持されます。

例:

A screenshot of a developer tool interface displaying a POST request to the Autodesk API endpoint for retrieving WorkItem statuses, including a JSON body with WorkItem IDs and response results.

By Toshiaki Isezaki


Comments

Leave a Reply

Discover more from Autodesk Developer Blog

Subscribe now to keep reading and get access to the full archive.

Continue reading