projects/{projectId}/exports/{exportId}
Retrieves the status of an export job. The S3 signed URL (in result.output.signedUrl
) will be available for downloading the exported file.
The export job ID is obtained from POST /projects/{projectId}/exports.
Note that only the authenticated user who launched the export job may use this endpoint to retrieve the signed URL. The signed URL will be available for 1 hour, and will expire thereafter. If you haven’t downloaded the file yet, you must create a new export job for the same files.
For more details about exporting files, see the Export Files tutorial.
Note that this endpoint is not compatible with BIM 360 projects. For BIM 360 projects use GET versions/{version_id}/exports/{export_id}.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/files/v1/projects/{projectId}/exports/{exportId} |
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 | The ID of a user on whose behalf your API request is acting. Required if you’re using a 2-legged authentication context, which must be 2-legged OAuth2 security with user impersonation.
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. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId). |
Request
URI Parameters
projectId string: UUID | The ID of the project. Use the Data Management API to retrieve the project ID. For more information, see the Retrieve a Project ID tutorial. You can use a project ID either with a “b.” prefix or without a “b.” prefix. For instance, a project ID of “b.a4be0c34a-4ab7” can also be referred to as “a4be0c34a-4ab7”. |
exportId string | The ID of the export job. The export ID is generated when you initialize an export job using POST exports. |
Response
HTTP Status Code Summary
200 OK | Successfully get the export job status |
400 Bad Request | The parameters of the requested operation are invalid.
Sample error code with possible messages:
|
401 Unauthorized | The provided bearer token is not valid.
Sample error code with possible messages:
|
403 Forbidden | The user or service represented by the bearer token does not have permission to perform this operation.
Sample error code with possible messages:
|
404 Not Found | The project, project user or the exporting job is not found
Sample error code with possible messages:
|
500 Internal Server Error | An unknown error occurred on the server.
Sample error code with possible messages:
|
Response
Body Structure (200)
id string: UUID | The ID of the PDF export job. |
status string | The status of the PDF export job. |
result object | The result of a completed export job:
|
output object | The output containing the downloadable signed URL. |
signedUrl string | The signed URL to download the PDF or ZIP file. Expires in 1 hour. |
failedFiles array: object | Only for dwg/rvt files. |
id string | The file version URN. |
reason string | The reason for failure. |
detail string | The detail message for failure |
error object |
|
code string | The HTTP code of the error. |
title string | The title of the error. |
detail string | The detail of the error. |
Example
Successfully retrieved export data
Request
curl -v 'https://developer.api.autodesk.com/construction/files/v1/projects/9ba6681e-1952-4d54-aac4-9de6d9858dd4/exports/5b4bb914-c123-4f10-87e3-579ef934aaf9' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response (200 with signedUrl)
{
"id": "5b4bb914-c123-4f10-87e3-579ef934aaf9",
"status": "successful",
"result": {
"output": {
"signedUrl": "https://signedUrl"
}
}
}
Response (200 with failed result)
{
"id": "5b4bb914-c123-4f10-87e3-579ef934aaf9",
"status": "failed",
"result": {
"error": {
"code": "401",
"title": "ERR_AUTHORIZATION_ERROR",
"detail": "Authentication header is not correct"
}
}
}
Response (200 with partial successful result)
{
"id": "5b4bb914-c123-4f10-87e3-579ef934aaf9",
"status": "partialSuccess",
"result": {
"signedUrl": "https://signedUrl",
"failedFiles": [{
"id": "fileUrn",
"reason": "ERR_NO_PROCESSABLE_FILES",
"detail": "This file does not contain any 2d pdf files or still under processing."
}]
}
}