Request

Response

    Query processing progress
    GET

    photoscene/{photosceneid}/progress

    Returns the processing progress and status of a photoscene.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/photo-to-3d/v1/photoscene/{photosceneid}/progress
    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 query

    Response

    HTTP Status Code Summary

    200
    OK
    The photoscene’s progress query was successful
    403
    Forbidden
    Unauthorized

    Response

    Body Structure (200)

    Expand all
    Photoscene
    object
    An object containing details of the photoscene.
    photosceneid
    string
    ID of the photoscene to queried
    progressmsg
    string
    A short message indicating status
    progress
    number
    Current progress percentage
    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 a successful progress query, when processing is still in progress.

    Request

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

    Response

    {
      "Photoscene": {
        "photosceneid": "AtAuFsedTdqWdhF9VzHepp5oM9PITiuizI4xdMbz",
        "progressmsg": "Processing",
        "progress": "58.4"
      }
    }
    

    Example 2

    This example demonstrates a successful progress query, when processing is completed.

    Request

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

    Response

    {
      "Photoscene": {
        "photosceneid": "AtAuFsedTdqWdhF9VzHepp5oM9PITiuizI4xdMbz",
        "progressmsg": "DONE",
        "progress": "100"
      }
    }
    

    Example 3

    This example demonstrates an unsuccessful progress query, when the provided photosceneid is wrong.

    Request

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

    Response

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