Task 5 – Submit a WorkItem
When you post a WorkItem to Design Automation, you are instructing Design Automation to execute an Activity.
The relationship between an Activity and a WorkItem can be thought of as the relationship between a “function definition” and “function call”. Named parameters of the Activity have corresponding named arguments of the WorkItem. Like in function calls, optional parameters of the Activity can be skipped and left unspecified while posting a WorkItem.
By the end of this task, you will be able to:
- Create a WorkItem to execute an Activity.
- Check if execution succeeded or failed.
- Get the URL to the execution log file.
You will use the following operations to work with WorkItems in this task:
| HTTP Request | Description |
|---|---|
| POST /workitems | Creates a new WorkItem and queues it for processing. |
| GET /workitems/{id} | Gets the status of a specific WorkItem. |
Step 1 - Generate a Personal Access Token
To get a personal access token (PAT), simply access your autodesk profile via the following link: https://profile.autodesk.com/security and follow the instructions. Generate a PAT for product scope “Design Automation for Fusion” or “Project Alpine”. Either product scope will work.
The table below describes the different options for authentication and authorization for submitting WorkItems to Design Automation for Fusion.
Option |
OAuth Type |
Required Body Content |
Notes |
Use Case |
|---|---|---|---|---|
| Submit for your activity on behalf of yourself as Fusion user | 2LO | PAT of Fusion user | The owner of the app of the 2LO token must be same as the user that has created the PAT. | Access is needed for a “service user’s” data that is aggregated from customers into one account |
| Submit for your activity on behalf of a different Fusion user | 3LO | PAT of Fusion user + Signed Activity ID | 3LO token must be for the same user as the PAT | Access is needed for direct customer data that logs in and allows it |
Step 2 - Create a WorkItem
To create a WorkItem to execute the Activity ConfigureDesignActivity:
Request
curl -X POST \ 'https://developer.api.autodesk.com/da/us-east/v3/workitems' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \ -d '{ "activityId": "<YOUR_NICKNAME>.ConfigureDesignActivity+my_current_version", \ "arguments": { "PersonalAccessToken": "<YOUR_PERSONAL_ACCESSTOKEN>", "TaskParameters": "{\n \"fileURN\": \"urn:adsk.wipprod:dm.lineage:shuH8zKvThW_4Tdu-m22sw\",\n \"parameters\": {\n \"d3\": \"40mm\"\n }\n}" } }'Show More
Note
Attribute Description activityIdThe fully qualified id of the activity (owner.activity+alias) this WorkItem will execute. argumentsContains all the parameters that need to be passed to the Activity specified by activityId. They must match the parameters you specified in Task 5, when you created the Activity. In this case we send over the PAT so DA4Fusion can access files on Fusion teams, aswell as “d3”: “40mm” as in a map of parameters to change the height of the nut to 40mm, additonal to the fileURN of the design we want to change. The response contains the
idof the posted WorkItem:{ "status": "pending", "stats": { "timeQueued": "2023-09-27T08:52:30.7161306Z" }, "id": "<YOUR_WORKITEM_ID>" }
Step 3 - Check status of the WorkItem
Design Automation WorkItems are queued before they are processed. A WorkItem’s processing time will vary depending on the size and complexity of the input files, the type of processing done by the AppBundle, and the size of the output files.
In this walkthrough, you will be checking the WorkItem status to see if it has completed.
However, the best practice is to use the onComplete argument when submitting a WorkItem.
The onComplete argument lets you specify a callback URL, which will be called once the WorkItem is completed.
For more information see the documentation on callbacks here.
You can check the status of a WorkItem by calling [GET] /workitems/{id}:
Request
curl -X GET \
'https://developer.api.autodesk.com/da/us-east/v3/workitems/<YOUR_WORKITEM_ID> \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'
Response
{
"status": "success",
"reportUrl": "https://dasprod-store.s3.amazonaws.com/workItem/<YOUR_NICKNAME>/<YOUR_WORKITEM_ID>/report.txt?..(Truncated)",
"stats": {
"timeQueued": "2023-09-27T08:52:30.7161306Z",
"timeDownloadStarted": "2023-09-27T08:52:30.882113Z",
"timeInstructionsStarted": "2023-09-27T08:52:31.6418619Z",
"timeInstructionsEnded": "2023-09-27T08:52:55.0320553Z",
"timeUploadEnded": "2023-09-27T08:52:55.4675607Z",
"timeFinished": "2023-09-27T08:52:55.9182974Z",
"bytesDownloaded": 134691,
"bytesUploaded": 360182
},
"id": "<YOUR_WORKITEM_ID>"
}
| Attribute | Description |
|---|---|
status |
Indicates if execution is pending, successful, failed or cancelled. |
reportUrl |
The URL to get the report log for this WorkItem’s execution. |
