vaults/{vaultId}/file-versions/{id}/svf/bubble.json
This endpoint should be invoked only for DWF/DWFx file. Retrieves the bubble.json file, which serves as the root file for the Autodesk Large Model Viewer (LMV) format. It provides essential metadata and structure information required to render 2D/3D models or other complex visualizations in the LMV viewer.
Note: When requesting this endpoint for a file version first time, the server would trigger a low priority job in background to generate the bubble.json and other LMV related visualization files, which will be cached for subsequent use. Subsequent calls to this endpoint will retrieve the bubble.json from the cache directly. In order to get the associated DWF/DWFx file (if available) for a CAD file, “visualization-attachments” endpoint should be used.
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/file-versions/{id}/svf/bubble.json |
Authentication Context | user context required |
Required OAuth Scopes | No scopes required |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via a three-legged OAuth flow. |
Request
URI Parameters
vaultId string | The unique identifier of a vault. |
id string | The unique identifier of a file version. |
vaultId string | The unique identifier of a vault. |
id string | The unique identifier of a file version. |
Request
Query String Parameters
allowSync boolean | In a multi-site environment, this field tells if the file should be synched to the local site.
|
wmSrcItemVerId string | When current file is a dwf associated to an Item, to download its watermarked version, supply this Item Version’s id as the watermark source. |
wmSrcFileVerId string | When current file is a dwf associated to an Item, directly or as a CAD file’s visualization attachment, to download its watermarked version, supply this File Version’s id or its CAD File Version’s id as the watermark source. |
Response
HTTP Status Code Summary
200 OK | Bubble.json is retrieved from cache. |
202 Accepted | Bubble.json and other lmv files are not generated yet for this DWF/x file. 202 indicates server has accepted the request and have scheduled a low prioirty background job to created the necessary files required for viewing.
Note: User could invoke this endpoint every x seconds in loop to check this translation job status and wait for completion till StatusCode = 200 |
400 Bad Request | The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request. |
401 Unauthorized | The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again. |
403 Forbidden | The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again. |
404 Not Found | The requested resource was not found. |
Response
Body Structure (202)
Response for 202 has no body.
Example
This example illustrates how to get the root bubble.json for the Autodesk Large Model Viewer (LMV) format.
Note: {VaultServerAddress}
is used as a placeholder in the example(s) and could represent one of the following:
- Vault Server IP address or hostname. Ex: http://10.41.110.49.
- Vault Gateway URL if gateway is configured. Ex: https://test.vg.autodesk.com.
Request
curl -v '{VaultServerAddress}/AutodeskDM/Services/api/vault/v2/vaults/117/file-versions/43/svf/bubble.json' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
bubble.json content is returned in the response body.