projects/{project_id}/versions/{version_id}/exports/{export_id}
Returns the status of a PDF export job, as well as data you need to download the exported file when the export is complete.
The POST projects/:project_id/versions/:version_id/exports endpoint initiates the job, and returns a job ID to be used in this endpoint.
To download the exported PDF file after the job is complete, use GET :urn/manifest/:derivativeurn.
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 | GET https://developer.api.autodesk.com/bim360/docs/v1/projects/:project_id/versions/:version_id/exports/:export_id |
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. |
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 exported page; selected when initiating POST projects/:project_id/versions/:version_id/exports. |
export_id string: UUID | The ID of the export job; returned when initiating POST projects/:project_id/versions/:version_id/exports. |
Response
HTTP Status Code Summary
200 OK | The request has succeeded. |
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, exported document or job 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 (200)
id string: UUID | The ID of the export job. |
status enum:string | The status of the export job. Possible values: committed , completed , failed . When the job is complete, an object representing the result of the job is returned in the response. |
data object | |
versionUrn string | The Base64 (URL Safe) encoded ID (URN) assigned to the file when it was first uploaded to BIM 360 Document Management. This is used to download the page. Note that this is equal to the urn parameter in GET :urn/manifest/:derivativeurn |
resourceId string | The URL-encoded ID (URN) of the exported PDF page. Note that this is equivalent to the derivativeurn parameter in GET :urn/manifest/:derivativeurn. |
link string | (Deprecated) The complete URL for downloading the exported PDF. See GET :urn/manifest/:derivativeurn for more details. This URL is deprecated. We recommend using the signed URL (signedUrl ) for downloading the export. |
signedUrl string | The signed URL to download the export result. The default expiration time is 2 minutes. This property is replacing the link URL. |
Example
The request has succeeded.
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/433d07ec-32a2-44eb-a5eb-b41090bfe932' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"id": "433d07ec-32a2-44eb-a5eb-b41090bfe932",
"status": "completed",
"data": {
"versionUrn": "dXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi5wZjNmclUwZ1RaYU9vdEtYZzJoMUZ3P3ZlcnNpb249MQ",
"resourceId": "urn:adsk.viewing:fs.file:dXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi5wZjNmclUwZ1RaYU9vdEtYZzJoMUZ3P3ZlcnNpb249MQ/output/qXP_ZA5_3EqJoq5zqvnLHA/h8YAl4KMcEe9-L5SaEXY6A.pdf",
"link": "https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi5wZjNmclUwZ1RaYU9vdEtYZzJoMUZ3P3ZlcnNpb249MQ/manifest/urn%3Aadsk.viewing%3Afs.file%3AdXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi5wZjNmclUwZ1RaYU9vdEtYZzJoMUZ3P3ZlcnNpb249MQ%2Foutput%2FqXP_ZA5_3EqJoq5zqvnLHA%2Fh8YAl4KMcEe9-L5SaEXY6A.pdf",
"signedUrl": "https://autodesk-360-translation-storage.s3.amazonaws.com/dXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi5wZjNmclUwZ1RaYU9vdEtYZzJoMUZ3P3ZlcnNpb249MQ/output/qXP_ZA5_3EqJoq5zqvnLHA/h8YAl4KMcEe9-L5SaEXY6A.pdf?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEFkaCXVzLWVhc3QtMSJIMEYCIQDNNbuZoazvwW76c8hUdKythQhpfmixh2AviJuykqwbxAIhAIM1ciB8MQj5FXAQMEnP2lVdraat6%2BU5XcH3rBAdLqUhKtsECLL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQABoMMjM3ODgyMTcyOTEyIgwzc1S4pCpcQPPqfQkqrwQOC9D39XsK8QpayEEZz5jLC69LO6qdMbs7mUJru5F%2Bx0VV0TXxy1vYjqdfH1SHCwW05FA8czaT40oYKmDcVDRV9iVBrxDNbYxuqS0rBK5CeOfzUQAlsl%2FHgFS%2BQ6p4ca5r2dOgG7fOics1ZLz5goqB7eRP7h27KGnGgcFmsZ4mcHlCBSrDz56hppqJfe%2BLoobZbcxkNvlTvMHH2XeXe5TsyMQWkpIT1qwEJnyMV2IlhBy6Inr%2FXCic5ID3H5NJKw9sI9W3ZhLL2nC9w791jjmxNnQAF624G38jC7pE9fN4vdHeytG27ajW291g9Z28ph%2BwK711ZAxXXM5jyApN6IcRI7ZT%2FmeqNwK3tf0JYjaWMY9flsi%2BgOc9Age7U%2FYl9gpPWokv94A4RTpZgaIoDcnPZRjOFhaKlqc%2FPRhfhU82fIchm2ajDUpJxU2R2NLpMcYQrdQwIpvdKskwr%2Bdv0ueQVOCCYy4OSmUSUN1uLvo9xuaevrakvtEw93jHAsrxBeBsiBFIrWYRSYRRxbp%2FWu%2FykQun1%2B35ny5m0aaDjMxSf3MFekcZlycFRTQ10rlsuWM1s9%2BhLpXylNngzG3vHdGkW2bz9OP517BlnXWhY2P34BY%2BoAYR1osK8FBKK4odoSzaysmsi8akSHooHCTHCE2cW%2BBOVpP%2BO2INmJeS9tVkBqVweYfABSDq0SPcS19wIOoErm2S05pJEFWxJsyh%2B4m2YcmKgrq4883NBU4R6eNKMOfYsZcGOqgBZ59tHFFtRgH8HKVbbDAqkt8RxlyxhjhY6d1rixsLsUtJcPcZP%2FZZmV51SH3rGTfg0cMCEHUH1UMQOQCwXPhJq8VQcI6Wyz7ywNuiWwUiC7%2B2ekEAnKrUwfVyLtI0u1ntG4inL9eYVmM%2BO6w7Es2XjCz%2FHms3q1HEHK26rWukyk18TO118virTD7%2BAwU4otL8D5tlV0OLH8t6D%2B%2FwZN3q0Baxj1zbsFlo&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220805T023429Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Credential=ASIATOYXB4XYG76TKVPE%2F20220805%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b7cdd11b4ad70051d652bf9f0fa7e49e24b08c800f71211c495d53db2c0509d8"
}
}