Workitem Visibility at Your Fingertips: Introducing Two New APS Design Automation APIs for Effortless Tracking and Status Updates

We are introducing two new APIs for Design Automation service to improve the bookkeeping of logs and the status of work items.

1. Retrieve work item IDs:

A new query parameter is added to the GET workitems/:id | Design Automation API | Autodesk Platform Services endpoint.

• Initiate a GET request to workitems?startAfterTime=<dt>, replacing <dt> with the desired starting timestamp in epoch seconds.
• The response's "data" section will contain a list of work item IDs.

/workitems?startAfterTime={dt} where dt is datetime is Unix in UTC

This onlinetool can be used to convert human readable date string to epoch seconds aka Unix time and vice versa.

Unix time is a date and time representation widely used in computing. It measures time by the number of seconds that have elapsed since

00:00:00 UTC on 1 January 1970.

Using PowerShell

Epoch seconds to Local Date Time

(Get-Date -Date "1970-01-01T00:00:00Z").addSeconds(1704623400)

Local Date Time to Epoch Seconds

Get-Date -Date "2024-01-07T16:00:00" -AsUTC -UFormat %s

Note:

Work items are preserved for 3 days from the datetime of their execution, any datetime input that is 5 days older than the current UTC time will be discarded.

Example:

baseUrl: https://developer.api.autodesk.com/da/us-east/v3

Request:

curl --request GET \
  --url '{baseUrl}/workitems?startAfterTime=1704606190' \
  --header 'Authorization: Bearer token'

Response:

{
    "paginationToken": null,
    "data": [
        {
            "id": "0bcb374954724fe9b8453c4d4bfc3ad8",
            "lastModifiedInUTCEpochSecond": 1704778269
        },
        {
            "id": "187d01b6766d4040be0780272df63675",
            "lastModifiedInUTCEpochSecond": 1704778271
        },
        {
            "id": "039cf746b2584b6bb4e724c5146dc1a1",
            "lastModifiedInUTCEpochSecond": 1704778272
        }
    ]
}

The response contains a list of work item IDs and their corresponding last modified times for a specific page. To iterate through additional pages, use the pagination token in the query parameter.

2. Obtain work item statuses:

A new endpoint /workitems/status is added to get the workitem statuses for given array of workitem IDs in the payload.

• Construct a POST request to workitems/status.
• Utilize the "data" section from the previous [1] GET response as the payload for this POST request.
• The response will provide the statuses of the specified work items.

Example:

baseUrl: https://developer.api.autodesk.com/da/us-east/v3

Request:

curl --request POST \
  --url {baseUrl}/workitems/status \
  --header 'Authorization: Bearer Token' \
  --header 'Content-Type: application/json' \ 
  --data '[
    "0bcb374954724fe9b8453c4d4bfc3ad8",
    "187d01b6766d4040be0780272df63675",
    "039cf746b2584b6bb4e724c5146dc1a1"
]'

Response:

{
    "results": [
        {
            "status": "success",
            "reportUrl": "https://dasprod-store.s3.amazonaws.com/workItem/apsone/0bcb374954724fe9b8453c4d4bfc3ad8/report.txt?X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEE4aCXVzLWVhc3QtMSJGMEQCIG6stk426%2FVTkPx6RGsbM6RU1%2F14Bm4AY6kgpSvgjXtzAiASaFptAYO5x2neGvEn5tMEESa68AGytWQOMQ5NjVFgCSqJAwjn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAQaDDIyMDQ3MzE1MjMxMCIMUoDtI7h%2BSq9UVUdwKt0CSHyeH94%2B08mPtyCsPTJ7FX8K%2FhV1d6oDPHm0Zz69OX%2F6%2FPNLmXbCh4JvAAe96sPtJW2nvIBYEZY3lDmjDKM4UcoEI8rQMWmiO%2FtgnAK6ocoYtUR%2Bwl4j936%2B326auzQaMtsxpmabZwgSshRMipDZiZ%2BeXKIvwT0NJNOyFjcXLVyrhP5UD0uGwavBu%2FMrocYEbVhwJhRUdAPvIBPYrNXgqG1pR8ZledQj%2BFSRiPtBNEZAEpA5ED%2B%2BqbhVNWLu%2FuM%2FyQI2R2iX3NSWQ300jk6UhTYuXEH%2FKvEvsbM0cLF7IBBVJhsnl0MtCPDw5Hpi1tzpineGG0rAdSZEtRzG9eCN5l4uic8Z9NXJiyI4WdbgBbSQQob3j2Ew%2Bnwmhs9v37my1BhAN8hAUER2CdXHZMpdrAEaWZkVQAkKlcBS%2FYpTlilQqBAFcjT6IT%2BAXc1ZGKFg5hg5EPWF%2Brj3vQFhKTDTwfOsBjqfAV0BE1sB43tpOBVeYP7w%2B4g7pXGI1eBHDU76rruUxaNdmIlFxyVGkas%2BBbBnesmpEF7YNhokXlgDUgxgK2ZEI8qdLO00w%2FzTIBt4iDkJJsHW0lRxh%2B5Tbte%2FPqEtCQSPLsQYpSp%2BjHQ9HGzRth%2BnUgvCrHKUsShnQKnWH%2FkBOUU5pOCSiKjSEz%2FN2%2FS1YhMeMasWdmqs7W1od%2B%2F8t3MMBw%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIATGVJZKM3MNJWGMMA%2F20240109%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240109T060527Z&X-Amz-SignedHeaders=host&X-Amz-Signature=ab54e25f0d83d71ab4b5b3562785689279a4945d251a57618a7854b59c724b92",
            "stats": {
                "timeQueued": "2024-01-09T05:27:11.7892314Z",
                "timeDownloadStarted": "2024-01-09T05:27:12.0660187Z",
                "timeInstructionsStarted": "2024-01-09T05:27:12.3432632Z",
                "timeInstructionsEnded": "2024-01-09T05:27:16.6958539Z",
                "timeUploadEnded": "2024-01-09T05:27:16.6962841Z",
                "timeFinished": "2024-01-09T05:27:17.1396631Z",
                "bytesDownloaded": 1604853
            },
            "id": "0bcb374954724fe9b8453c4d4bfc3ad8"
        },
        {
            "status": "success",
            "reportUrl": "https://dasprod-store.s3.amazonaws.com/workItem/apsone/187d01b6766d4040be0780272df63675/report.txt?X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEE4aCXVzLWVhc3QtMSJGMEQCIG6stk426%2FVTkPx6RGsbM6RU1%2F14Bm4AY6kgpSvgjXtzAiASaFptAYO5x2neGvEn5tMEESa68AGytWQOMQ5NjVFgCSqJAwjn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAQaDDIyMDQ3MzE1MjMxMCIMUoDtI7h%2BSq9UVUdwKt0CSHyeH94%2B08mPtyCsPTJ7FX8K%2FhV1d6oDPHm0Zz69OX%2F6%2FPNLmXbCh4JvAAe96sPtJW2nvIBYEZY3lDmjDKM4UcoEI8rQMWmiO%2FtgnAK6ocoYtUR%2Bwl4j936%2B326auzQaMtsxpmabZwgSshRMipDZiZ%2BeXKIvwT0NJNOyFjcXLVyrhP5UD0uGwavBu%2FMrocYEbVhwJhRUdAPvIBPYrNXgqG1pR8ZledQj%2BFSRiPtBNEZAEpA5ED%2B%2BqbhVNWLu%2FuM%2FyQI2R2iX3NSWQ300jk6UhTYuXEH%2FKvEvsbM0cLF7IBBVJhsnl0MtCPDw5Hpi1tzpineGG0rAdSZEtRzG9eCN5l4uic8Z9NXJiyI4WdbgBbSQQob3j2Ew%2Bnwmhs9v37my1BhAN8hAUER2CdXHZMpdrAEaWZkVQAkKlcBS%2FYpTlilQqBAFcjT6IT%2BAXc1ZGKFg5hg5EPWF%2Brj3vQFhKTDTwfOsBjqfAV0BE1sB43tpOBVeYP7w%2B4g7pXGI1eBHDU76rruUxaNdmIlFxyVGkas%2BBbBnesmpEF7YNhokXlgDUgxgK2ZEI8qdLO00w%2FzTIBt4iDkJJsHW0lRxh%2B5Tbte%2FPqEtCQSPLsQYpSp%2BjHQ9HGzRth%2BnUgvCrHKUsShnQKnWH%2FkBOUU5pOCSiKjSEz%2FN2%2FS1YhMeMasWdmqs7W1od%2B%2F8t3MMBw%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIATGVJZKM3MNJWGMMA%2F20240109%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240109T060527Z&X-Amz-SignedHeaders=host&X-Amz-Signature=f007c39119cb39ab14871b78762ac74035d979cf96334374c31f8e338be7d533",
            "stats": {
                "timeQueued": "2024-01-09T05:28:22.4155923Z",
                "timeDownloadStarted": "2024-01-09T05:28:22.539931Z",
                "timeInstructionsStarted": "2024-01-09T05:28:23.5046278Z",
                "timeInstructionsEnded": "2024-01-09T05:28:29.4995246Z",
                "timeUploadEnded": "2024-01-09T05:28:29.5000095Z",
                "timeFinished": "2024-01-09T05:28:29.8964189Z",
                "bytesDownloaded": 1604853
            },
            "id": "187d01b6766d4040be0780272df63675"
        },
        {
            "status": "success",
            "reportUrl": "https://dasprod-store.s3.amazonaws.com/workItem/apsone/039cf746b2584b6bb4e724c5146dc1a1/report.txt?X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEE4aCXVzLWVhc3QtMSJGMEQCIG6stk426%2FVTkPx6RGsbM6RU1%2F14Bm4AY6kgpSvgjXtzAiASaFptAYO5x2neGvEn5tMEESa68AGytWQOMQ5NjVFgCSqJAwjn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAQaDDIyMDQ3MzE1MjMxMCIMUoDtI7h%2BSq9UVUdwKt0CSHyeH94%2B08mPtyCsPTJ7FX8K%2FhV1d6oDPHm0Zz69OX%2F6%2FPNLmXbCh4JvAAe96sPtJW2nvIBYEZY3lDmjDKM4UcoEI8rQMWmiO%2FtgnAK6ocoYtUR%2Bwl4j936%2B326auzQaMtsxpmabZwgSshRMipDZiZ%2BeXKIvwT0NJNOyFjcXLVyrhP5UD0uGwavBu%2FMrocYEbVhwJhRUdAPvIBPYrNXgqG1pR8ZledQj%2BFSRiPtBNEZAEpA5ED%2B%2BqbhVNWLu%2FuM%2FyQI2R2iX3NSWQ300jk6UhTYuXEH%2FKvEvsbM0cLF7IBBVJhsnl0MtCPDw5Hpi1tzpineGG0rAdSZEtRzG9eCN5l4uic8Z9NXJiyI4WdbgBbSQQob3j2Ew%2Bnwmhs9v37my1BhAN8hAUER2CdXHZMpdrAEaWZkVQAkKlcBS%2FYpTlilQqBAFcjT6IT%2BAXc1ZGKFg5hg5EPWF%2Brj3vQFhKTDTwfOsBjqfAV0BE1sB43tpOBVeYP7w%2B4g7pXGI1eBHDU76rruUxaNdmIlFxyVGkas%2BBbBnesmpEF7YNhokXlgDUgxgK2ZEI8qdLO00w%2FzTIBt4iDkJJsHW0lRxh%2B5Tbte%2FPqEtCQSPLsQYpSp%2BjHQ9HGzRth%2BnUgvCrHKUsShnQKnWH%2FkBOUU5pOCSiKjSEz%2FN2%2FS1YhMeMasWdmqs7W1od%2B%2F8t3MMBw%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIATGVJZKM3MNJWGMMA%2F20240109%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240109T060527Z&X-Amz-SignedHeaders=host&X-Amz-Signature=27759dfc0217d35d9bfbd1ec1c2d3e6ea42fcf8e19c00475ca2149826238bc4c",
            "stats": {
                "timeQueued": "2024-01-09T05:28:48.0688633Z",
                "timeDownloadStarted": "2024-01-09T05:28:48.176612Z",
                "timeInstructionsStarted": "2024-01-09T05:28:48.4643926Z",
                "timeInstructionsEnded": "2024-01-09T05:28:52.6441453Z",
                "timeUploadEnded": "2024-01-09T05:28:52.645911Z",
                "timeFinished": "2024-01-09T05:28:53.0199785Z",
                "bytesDownloaded": 1604853
            },
            "id": "039cf746b2584b6bb4e724c5146dc1a1"
        }
    ],
    "errors": {}
}

errors in response body reports if a given workitem ID is not found.