Request

Response

    Retrieve result link
    GET

    photoscene/{photosceneid}

    Returns a time-limited HTTPS link to an output file of the specified format.

    Note: The link will expire 30 days after the date of processing completion.

    Resource Information

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

    Request

    Query String Parameters

    format
    enum:string
    Requested output file format. Must be a format that was specified in the POST /photoscene method. Only one format may be specified at a time. Possible values: rcm, obj, rcs, fbx, ortho, report

    Response

    HTTP Status Code Summary

    200
    OK
    HTTPS link to the photoscene’s output format was successfully returned
    403
    Forbidden
    Unauthorized

    Response

    Body Structure (200)

    Expand all
    Photoscene
    object
    An object containing details of the photoscene.
    photosceneid
    string
    ID of the photoscene
    progressmsg
    string
    A human readable notification indicating current progress
    progress
    string
    Current progress as a percentage
    scenelink
    string
    URL to access the result of the processed photoscene
    urn
    string
    URN to access the result of the processed photoscene.

    Please refer to the Data Management API tutorial for information about downloading files.

    filesize
    string
    File size of the output file created
    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 successfull request for a link to a rcs formatted output of a photoscene.

    Request

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

    Response

    {
      "Photoscene": {
        "photosceneid": "AtAuFsedTdqWdhF9VzHepp5oM9PITiuizI4xdMbz",
        "progressmsg": "DONE",
        "progress": "100",
        "scenelink": "https://s3.amazonaws.com/com.autodesk.storage...",
        "filesize": "41640100",
        "resultmsg": {}
      }
    }
    
    Show More

    Example 2

    This example demonstrates an unsuccessfull request for a link.

    Request

    {
      "Photoscene": {
        "photosceneid": "AtAuFsedTdqWdhF9VzHepp5oM9PITiuizI4xdMbz",
        "progressmsg": "DONE",
        "progress": "100",
        "scenelink": "https://s3.amazonaws.com/com.autodesk.storage...",
        "filesize": "41640100",
        "resultmsg": {}
      }
    }
    
    Show More

    Response

    {
      "Error": {
        "code": "22",
        "msg": "Your data is not ready"
      }
    }