Request

Response

    DELETE

    workitems/:id

    Cancels a specific WorkItem.

    If the WorkItem is on the queue, it is removed from the queue and not processed.

    If the WorkItem is already being processed, then it may or may not be interrupted and cancelled.

    If the WorkItem has already finished processing, then it has no effect on the processing or results.

    Resource Information

    Method and URI
    DELETE
    https://developer.api.autodesk.com/da/us-east/v3/workitems/:id
    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.
    * Required

    Request

    URI Parameters

    id
    string
    The GUID used to identify the WorkItem.

    Response

    HTTP Status Code Summary

    204
    No Content
    OK.
    403
    Forbidden
    The user is not authorized to modify the WorkItem status.
    404
    Not Found
    The WorkItem doesn’t exist.
    409
    Conflict
    Conflict.
    500
    Internal Server Error
    Unknown error.

    Example

    OK.

    Request

    curl -v 'https://developer.api.autodesk.com/da/us-east/v3/workitems/:id' \
      -X 'DELETE' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
    

    Response

    204 No Content