Request

Response

    POST

    workitems/combine

    The allows users to create a simple fan-in workflow where 1-N workitems (parts) must complete before the final workitem (combinator) is processed.

    The following limits apply:

    Per-engine. These limits are enforced when the engine processes the workitem.

    1. Processing time (LimitProcessingTime)
    2. Total size of uncompressed bits for all referenced appbundles (LimitTotalUncompressedAppsSizePerActivity).

    Service wide. These limits are enforced during workitem submission.

    1. Total processing time per month (LimitMonthlyProcessingTimeInHours).
    2. Maximum number of WorkItem of parts in the request is 100.
    3. Activity has to be the same for all WorkItems of parts.

    More explanation is at WorkItem Combine API Reference.

    Resource Information

    Method and URI
    POST
    https://developer.api.autodesk.com/da/us-east/v3/workitems/combine
    Authentication Context
    user context optional
    Required OAuth Scopes
    code:all
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is obtained via either a two-legged or three-legged OAuth flow.
    Content-Type*
    string
    Must be application/json
    * Required

    Request

    Body Structure

    parts*
    array: object
    The WorkItems that must complete before the final workitem.
    combinator*
    object
    The final WorkItem that start only after the parts are finished.
    * Required

    (Beta) Each WorkItem accepts the optional priority field described in POST workitems. On a combine request, the first item in parts decides the tier for the whole request, the combinator included. The priority values of later parts and of the combinator are validated but do not change routing. If that tier is P1 and Priority Pass is not available for the engine, the whole request is rejected with 400. Available for Revit. Coming soon for the other engines during the public beta. To check an engine, call GET engines/:id and look for "priorityPass": true.

    (Beta) memoryGb and gpu are not yet supported on this endpoint. A request where any WorkItem sets memoryGb, even to 32, or sets gpu to true, returns 400. To use them, submit each WorkItem with POST workitems.

    Response

    HTTP Status Code Summary

    200
    OK
    Successfully create a new WorkItem.
    400
    Bad Request
    The request is invalid. (Beta) For example, when:
    • the request contains an unsupported priority value.
    • the first item in parts sets priority to P1 and Priority Pass is not available for the engine.
    • the request would exceed the limit of one P1 WorkItem per Client ID during the beta period.
    • any WorkItem sets memoryGb, or sets gpu to true.
    403
    Forbidden
    The user is not authorized to create the WorkItem.
    413
    Payload is too large.

    Response

    Body Structure (200)

    parts
    array: object
    The WorkItem status of parts WorkItems.
    combinator
    object
    The WorkItem status of the combinator WorkItem.

    Example

    Successfully create a new WorkItem.

    Request

    curl -v 'https://developer.api.autodesk.com/da/us-east/v3/workitems/combine' \
      -X 'POST' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
      -H 'Content-Type: application/json' \
      -d '{
            "parts": [
              {
                "activityId": "mynickname.part+prod",
                "arguments": {
                "HostDwg": {
                  "url": "https://s3.amazonaws.com/TestDwg/host.dwg",
                  "verb": "get"
                },
                "Result": {
                  "url": "das://intermediate/vararg_page1.pdf",
                   "verb":  "put"
                  }
                }
              },
              {
                "activityId": "mynickname.part+prod",
                "arguments": {
                "HostDwg": {
                  "url": "https://s3.amazonaws.com/TestDwg/1/xref.dwg",
                  "verb": "get"
                },
                "Result": {
                  "url": "das://intermediate/vararg_page2.pdf",
                  "verb":  "put"
                }
                }
              }
            ],
            "combinator": {
              "activityId" : "mynickname.combinator+prod",
              "arguments" : {
                "result" : {
                  "url": "https://cdn.us.oss.api.autodesk.com/oss/v2/signedresources/123?region=US",
                  "verb": "put"
                }
              }
            }
          }'
    
    Show More

    Response

    {
      "parts": [
          {
              "status": "pending",
              "activityId": "mynickname.part+prod",
              "stats": {
                  "timeQueued": "2024-03-09T16:56:05.6688164Z"
              },
              "id": "f9d2d97059cd4febbe13728bbcda4858"
          },
          {
              "status": "pending",
              "activityId": "mynickname.part+prod",
              "stats": {
                  "timeQueued": "2024-03-09T16:56:05.6688164Z"
              },
              "id": "2619e594c0ce447d8086518d1b140639"
          }
      ],
      "combinator": {
          "status": "pending",
          "activityId": "mynickname.combinator+prod",
          "stats": {},
          "id": "e19765fe17194839bc52eb6091065dcc"
      }
    }
    
    Show More