Request

Response

    Cancel processing
    POST

    photoscene/{photosceneid}/cancel

    Aborts the processing of a photoscene and marks it as cancelled.

    Resource Information

    Method and URI
    POST
    https://developer.api.autodesk.com/photo-to-3d/v1/photoscene/{photosceneid}/cancel
    Authentication Context
    user context optional
    Required OAuth Scopes
    data:write
    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

    photosceneid
    string
    Specifies the ID of the photoscene to cancel

    Response

    HTTP Status Code Summary

    200
    OK
    Processing was successfully cancelled
    403
    Forbidden
    Unauthorized

    Response

    Body Structure (200)

    Expand all
    msg
    string
    A human readable notification that the operation was successful.
    Error
    object
    Even though the the service returns a HTTP Status Code of 200, it may return an error payload, which provides details on why the operation failed.
    code
    int
    A code that identifies the error type. See Error List for possible values
    msg
    string
    A short, human readable explanation of the error

    Example 1

    This example demonstrates the successful cancelation of a photoscene processing operation.

    Request

    curl -v 'https://developer.api.autodesk.com/photo-to-3d/v1/photoscene/AtAuFsedTdqWdhF9VzHepp5oM9PITiuizI4xdMbz/cancel' \
      -X 'POST' \
      -H 'Authorization: Bearer eyjhbGCIOIjIuzI1NiISimtpZCI6...'
    

    Response

    {
      "msg": "No error"
    }
    

    Example 2

    This example demonstrates an unsuccessful attempt to cancel a photoscene processing operation.

    Request

    curl -v 'https://developer.api.autodesk.com/photo-to-3d/v1/photoscene/AtAuFsedTdqWdhF9VzHepp5oM9PITiuizI4xdMbz/cancel' \
      -X 'POST' \
      -H 'Authorization: Bearer eyjhbGCIOIjIuzI1NiISimtpZCI6...'
    

    Response

    {
      "Error": {
        "code": "19",
        "msg": "Specified photoscene ID doesn't exist in the database"
      }
    }