photoscene
Creates and initializes a photoscene for reconstruction.
Note: The photoscene and any associated files will be deleted after 30 days.
Resource Information
| Method and URI | POST https://developer.api.autodesk.com/photo-to-3d/v1/photoscene |
| 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. |
| Content-Type* string | Must be application/x-www-form-urlencoded |
Request
Body Structure
| scenename* string | Specifies the name of the photoscene; this will be used in output file names.
Note: Avoid control-characters such as: |
| callback string | URI to be invoked when the processing of the photoscene has completed.
Can have multiple comma-delimited (
|
| format array: string | Output file format; multiple file formats can be listed in a comma-delimited list.
Supported values are:
|
| scenetype enum:string | Specifies the subject type of the photoscene.
Possible values: aerial, object |
| gpstype enum:string | Specifies the GPS coordinates type.
Note: This parameter is available only if |
| hubprojectid string | The identifier of an A360 Personal hub or BIM 360 Docs project. Output files will be delivered to a folder in this project. This must be specified with a hubfolderid. Please refer to the Data Management API for more information. |
| hubfolderid string | The URN of an A360 Personal hub or BIM 360 Docs folder. Output files will be delivered to this folder. This must be specified with a hubprojectid. Please refer to the Data Management API for more information. |
| targetcs string | A Cartesian coordinate system name from the Autodesk Geospatial Coordinate Systems library.
Note: The photoscene must have the rcs format enabled to use this feature. Click here for a list of supported coordinate system names. |
| version enum:string | The reconstruction engine version.
Possible values: 1.0, 2.0, 3.0 |
Response
HTTP Status Code Summary
| 200 OK | Photoscene was successfully created |
| 403 Forbidden | Unauthorized |
Response
Body Structure (200)
| Photoscene object | An object containing details of the photoscene. |
| photosceneid string | ID of the photoscene |
| 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 successfull creation of a photoscene.
Request
curl -v 'https://developer.api.autodesk.com/photo-to-3d/v1/photoscene' \
-X 'POST' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsImtpZCI6...' \
-d 'scenename=testscene' \
-d 'format=rcm,rcs,ortho' \
-d 'metadata_name[0]=targetcs' \
-d 'metadata_value[0]=UTM84-32N'
Response
{
"Photoscene": {
"photosceneid": "hcYJcrnHUsNSPII9glhVe8lRF6lFXs4NHzGqJ3zdWMU"
}
}
Example 2
This example demonstrates an unsuccessfull attempt at creating of a photoscene without providing a name for the photoscene.
Request
curl -v 'https://developer.api.autodesk.com/photo-to-3d/v1/photoscene' \
-X 'POST' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsImtpZCI6...' \
-d 'scenename=' \
-d 'format=rcm,rcs,ortho' \
-d 'metadata_name[0]=targetcs' \
-d 'metadata_value[0]=UTM84-32N'
Response
{
"Error": {
"code": "28",
"msg": "Scene name cannot be empty"
}
}