projects/{project_id}/versions/{version_id}/exports
Exports a single page from an uploaded PDF file into a new PDF file. You can also export the page’s markups (annotations) and hyperlinks.
Note that you can only export a page from a PDF file that was uploaded to the Plans folder or to a folder nested under the Plans folder (attributes.extension.data.actions: SPLIT
). BIM 360 Document Management splits these files into separate pages (sheets) when they are uploaded, and assigns a separate ID to each page. You can identify exportable PDF files, by searching for files with the following combination of properties:
attributes.extension.type: items:autodesk.bim360.Document
(identifies all files that are split into separate pages)attributes.extension.data.sourceFileName: <filename>.pdf
(identifies all PDF files)
You can export PDF pages both from PDF files that were uploaded via the BIM 360 Document Management UI and from PDF files that were uploaded via BIM 360 endpoints. For more details about uploading documents to BIM 360 via the BIM 360 endpoints, see the File Upload tutorial.
Note that this endpoint is asynchronous and initiates a job that runs in the background, rather than halting execution of your program. The response returns an export ID that you can use to poll GET projects/:project_id/versions/:version_id/exports/:export_id to verify the status of the job. When the job is complete, you can retrieve the data you need to download the exported page.
Note that if you export the same file version twice, this endpoint returns the GET exports/:id response. A new signed URL is generated and the previous signed URL remains active for 2 minutes.
Note that the user must have permission to view files. For information about permissions, see the Help documentation.
For more details about exporting PDF files, see the PDF Export tutorial.
For more information about Document Management endpoints, see the Data Management API
Note that this endpoint is ONLY compatible with BIM 360 projects. It is not compatible with Autodesk Construction Cloud (ACC) projects. For more information about compatibility between between BIM 360 and ACC, see the Compatibility section.
Resource Information
Method and URI | POST https://developer.api.autodesk.com/bim360/docs/v1/projects/:project_id/versions/:version_id/exports |
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. |
Content-Type* string | Must be application/json |
x-user-id string | In a two-legged authentication context, the app has access to all users specified by the administrator in the SaaS integrations UI. By providing this header, the API call will be limited to act on behalf of only the user specified. |
Request
URI Parameters
project_id string: UUID | The ID of the project. This corresponds to project ID in the Data Management API. To convert a project ID in the Data Management API into a project ID in the BIM 360 API you need to remove the “b." prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7. |
version_id string | The URL-encoded version ID (URN) of the page to export.
When a file is uploaded to BIM 360 Document Management, a corresponding version ID is created for the file. Every time the file is saved a new version is created. When a PDF file is uploaded to the Plans folder or to a child of the Plans folder, BIM 360 assigns a separate version ID to each page of the PDF. The user needs to select the version ID that corresponds to the page that he/she wants to export. To export the latest version ( To export an alternative version of the page, use GET projects/:project_id/items/:item_id/versions to find the ID. |
Request
Body Structure
includeMarkups boolean | true : export the page with markups (annotations). Note that
the endpoint only exports published and unarchived markups.
You can manage a page’s markups by opening the page in the Document Management module. |
includeHyperlinks boolean | true : export the page with hyperlinks.
Note that all hyperlinks in the page are exported, including external links and internal links to other BIM 360 documents, whether the links were imported when the PDF was originally uploaded or whether they were added within BIM 360 Document Management. |
Response
HTTP Status Code Summary
202 Accepted | Successfully created an export job. |
400 Bad Request | The parameters of the requested operation are invalid. |
401 Unauthorized | The provided bearer token is not valid. |
403 Forbidden | The user or service represented by the bearer token does not have permission to perform this operation. |
404 Not Found | The project or exported document does not exist. |
429 Too Many Requests | Rate limit exceeded; wait some time before retrying. |
500 Internal Server Error | An unknown error occurred on the server. |
Response
Body Structure (202)
id string: UUID | The unique identifier of the export job. |
status enum:string | The status of the export job.
Possible values: committed , completed , failed |
Example
Successfully created an export job.
Request
curl -v 'https://developer.api.autodesk.com/bim360/docs/v1/projects/c0337487-5b66-422b-a284-c273b424af54/versions/urn%3Aadsk.wipqa%3Afs.file%3Avf.pf3frU0gTZaOotKXg2h1Fw%3Fversion%3D1/exports' \
-X 'POST' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"includeMarkups": true,
"includeHyperlinks": true
}'
Response
{
"id": "eed4fd1d-57fc-4e41-9c19-1d7b8ec2cf25",
"status": "committed"
}