Nothing
#' Make a Bucket for an App.
#'
#' Make an app-based bucket for storage of design files using the Data Management API.
#' @param token A string or \code{aps_token} object with
#' \code{bucket:create}, \code{bucket:read}, and \code{data:write} scopes.
#' @param bucket A string. Unique bucket name. Defaults to \code{mybucket}.
#' @param policy A string. May be \code{transient}, \code{temporary}, or
#' \code{persistent}.
#' @return An object containing the \code{bucketKey}, \code{bucketOwner}, and
#' \code{createdDate}.
#' @examples
#' \dontrun{
#' # Make a transient bucket with the name "mybucket"
#' resp <- makeBucket(token = myToken, bucket = "mybucket", policy = "transient")
#' }
#' @import httr2
#' @import jsonlite
#' @export
makeBucket <- function(token = NULL, bucket = "mybucket", policy = "transient") {
if (is.null(token)) stop("token is null")
if (is.null(bucket)) stop("bucket is null")
if (is.null(policy)) stop("policy is null")
token <- .resolve_token(token)
url <- 'https://developer.api.autodesk.com/oss/v2/buckets'
resp <- aps_request(url, token) |>
req_body_json(list(bucketKey = bucket, policyKey = policy)) |>
aps_perform()
parsed <- resp_body_json(resp, simplifyVector = FALSE)
structure(
list(
content = parsed,
path = url,
response = resp
),
class = "makeBucket"
)
}
#' Check the Status of an App-Managed Bucket.
#'
#' Check the status of a recently created app-managed bucket using the Data Management API.
#' @param token A string or \code{aps_token} object with \code{bucket:create}, \code{bucket:read}, and \code{data:write} scopes.
#' @param bucket A string. Name of the bucket. Defaults to \code{mybucket}.
#' @return An object containing the \code{bucketKey}, \code{bucketOwner}, and
#' \code{createdDate}.
#' @examples
#' \dontrun{
#' # Check the status of a bucket with the name "mybucket"
#' resp <- checkBucket(token = myToken, bucket = "mybucket")
#' resp
#' }
#' @import httr2
#' @import jsonlite
#' @export
checkBucket <- function(token = NULL, bucket = "mybucket") {
if (is.null(token)) stop("token is null")
if (is.null(bucket)) stop("bucket is null")
token <- .resolve_token(token)
url <- paste0('https://developer.api.autodesk.com/oss/v2/buckets/', bucket, '/details')
resp <- aps_request(url, token) |>
aps_perform()
parsed <- resp_body_json(resp, simplifyVector = FALSE)
structure(
list(
content = parsed,
path = url,
response = resp
),
class = "checkBucket"
)
}
#' List All App-Managed Buckets.
#'
#' List all app-managed buckets using the Data Management API.
#' @param token A string or \code{aps_token} object with
#' \code{bucket:read} scope.
#' @param limit An integer. Maximum number of buckets to return. Defaults to
#' \code{10}.
#' @param startAt A string. Bucket key to start the list from (for pagination).
#' Defaults to \code{NULL}.
#' @param region A string. Region filter. May be \code{"US"} or \code{"EMEA"}.
#' Defaults to \code{"US"}.
#' @return An object containing a list of bucket details.
#' @examples
#' \dontrun{
#' # List all buckets
#' resp <- listBuckets(token = myToken)
#' resp$content$items
#' }
#' @import httr2
#' @import jsonlite
#' @export
listBuckets <- function(token = NULL, limit = 10, startAt = NULL, region = "US") {
if (is.null(token)) stop("token is null")
token <- .resolve_token(token)
url <- 'https://developer.api.autodesk.com/oss/v2/buckets'
req <- aps_request(url, token) |>
req_url_query(limit = limit, region = region)
if (!is.null(startAt))
req <- req |> req_url_query(startAt = startAt)
resp <- req |> aps_perform()
parsed <- resp_body_json(resp, simplifyVector = FALSE)
structure(
list(
content = parsed,
path = url,
response = resp
),
class = "listBuckets"
)
}
#' Delete an App-Managed Bucket.
#'
#' Delete an app-managed bucket using the Data Management API.
#' @param token A string or \code{aps_token} object with
#' \code{bucket:delete} scope.
#' @param bucket A string. Name of the bucket to delete. Defaults to
#' \code{mybucket}.
#' @return An object containing the HTTP status code of the response.
#' @examples
#' \dontrun{
#' # Delete a bucket named "mybucket"
#' resp <- deleteBucket(token = myToken, bucket = "mybucket")
#' }
#' @import httr2
#' @import jsonlite
#' @export
deleteBucket <- function(token = NULL, bucket = "mybucket") {
if (is.null(token)) stop("token is null")
if (is.null(bucket)) stop("bucket is null")
token <- .resolve_token(token)
url <- paste0('https://developer.api.autodesk.com/oss/v2/buckets/', bucket)
resp <- aps_request(url, token, method = "DELETE") |>
aps_perform()
structure(
list(
content = list(status = resp_status(resp)),
path = url,
response = resp
),
class = "deleteBucket"
)
}
#' Upload a File to an App-Managed Bucket.
#'
#' Upload a design file to an app-managed bucket using the Data Management API.
#' @param file A string. File path.
#' @param token A string or \code{aps_token} object with
#' \code{bucket:create}, \code{bucket:read}, and \code{data:write} scopes.
#' @param bucket A string. Unique bucket name. Defaults to \code{mybucket}.
#' @return An object containing the \code{bucketKey}, \code{objectId} (i.e.
#' urn), \code{objectKey} (i.e. file name), \code{size}, \code{contentType}
#' (i.e. "application/octet-stream"), \code{location}. and other content
#' information.
#' @examples
#' \dontrun{
#' # Upload the "aerial.dwg" file to "mybucket"
#' resp <- uploadFile(file = system.file("inst/samples/aerial.dwg", package = "AutoDeskR"),
#' token = myToken, bucket = "mybucket")
#' myUrn <- resp$content$objectId
#' }
#' @import httr2
#' @import jsonlite
#' @export
uploadFile <- function(file = NULL, token = NULL, bucket = "mybucket") {
if (is.null(file)) stop("file is null")
if (is.null(token)) stop("token is null")
if (is.null(bucket)) stop("bucket is null")
token <- .resolve_token(token)
url <- paste0("https://developer.api.autodesk.com/oss/v2/buckets/", bucket, "/objects/", basename(file))
file_raw <- readBin(file, "raw", n = file.info(file)$size)
resp <- aps_request(url, token, method = "PUT") |>
req_body_raw(file_raw, type = "application/octet-stream") |>
aps_perform()
parsed <- resp_body_json(resp, simplifyVector = FALSE)
structure(
list(
content = parsed,
path = url,
response = resp
),
class = "uploadFile"
)
}
#' List Objects in an App-Managed Bucket.
#'
#' List objects stored in an app-managed bucket using the Data Management API.
#' @param token A string or \code{aps_token} object with
#' \code{data:read} scope.
#' @param bucket A string. Name of the bucket. Defaults to \code{mybucket}.
#' @param limit An integer. Maximum number of objects to return. Defaults to
#' \code{10}.
#' @return An object containing a list of objects in the bucket.
#' @examples
#' \dontrun{
#' # List objects in "mybucket"
#' resp <- listObjects(token = myToken, bucket = "mybucket")
#' resp$content$items
#' }
#' @import httr2
#' @import jsonlite
#' @export
listObjects <- function(token = NULL, bucket = "mybucket", limit = 10) {
if (is.null(token)) stop("token is null")
if (is.null(bucket)) stop("bucket is null")
token <- .resolve_token(token)
url <- paste0('https://developer.api.autodesk.com/oss/v2/buckets/', bucket, '/objects')
resp <- aps_request(url, token) |>
req_url_query(limit = limit) |>
aps_perform()
parsed <- resp_body_json(resp, simplifyVector = FALSE)
structure(
list(
content = parsed,
path = url,
response = resp
),
class = "listObjects"
)
}
#' Delete an Object from an App-Managed Bucket.
#'
#' Delete an object from an app-managed bucket using the Data Management API.
#' @param token A string or \code{aps_token} object with
#' \code{data:write} scope.
#' @param bucket A string. Name of the bucket. Defaults to \code{mybucket}.
#' @param object A string. Key (name) of the object to delete.
#' @return An object containing the HTTP status code of the response.
#' @examples
#' \dontrun{
#' # Delete the "aerial.dwg" object from "mybucket"
#' resp <- deleteObject(token = myToken, bucket = "mybucket", object = "aerial.dwg")
#' }
#' @import httr2
#' @import jsonlite
#' @export
deleteObject <- function(token = NULL, bucket = "mybucket", object = NULL) {
if (is.null(token)) stop("token is null")
if (is.null(bucket)) stop("bucket is null")
if (is.null(object)) stop("object is null")
token <- .resolve_token(token)
url <- paste0('https://developer.api.autodesk.com/oss/v2/buckets/', bucket, '/objects/', object)
resp <- aps_request(url, token, method = "DELETE") |>
aps_perform()
structure(
list(
content = list(status = resp_status(resp)),
path = url,
response = resp
),
class = "deleteObject"
)
}
#' Upload a File Using Signed S3 URLs.
#'
#' Upload a design file of any size to an app-managed bucket using the signed
#' S3 URL approach recommended by AutoDesk Platform Services (APS). Unlike
#' \code{\link{uploadFile}}, this function supports files larger than 100 MB.
#' @param file A string. File path.
#' @param token A string or \code{aps_token} object with
#' \code{data:write} scope.
#' @param bucket A string. Unique bucket name. Defaults to \code{mybucket}.
#' @return An object containing the finalized upload response with
#' \code{bucketKey}, \code{objectId}, \code{objectKey}, \code{size}, and
#' \code{location}.
#' @examples
#' \dontrun{
#' # Upload a large file using signed S3 URLs
#' resp <- uploadFileSigned(
#' file = "path/to/large_model.rvt",
#' token = myToken,
#' bucket = "mybucket"
#' )
#' myUrn <- resp$content$objectId
#' }
#' @import httr2
#' @import jsonlite
#' @export
uploadFileSigned <- function(file = NULL, token = NULL, bucket = "mybucket") {
if (is.null(file)) stop("file is null")
if (is.null(token)) stop("token is null")
if (is.null(bucket)) stop("bucket is null")
token <- .resolve_token(token)
object_key <- basename(file)
base_url <- paste0("https://developer.api.autodesk.com/oss/v2/buckets/", bucket, "/objects/", object_key)
# Step 1: obtain signed S3 upload URL
init_resp <- aps_request(paste0(base_url, "/signeds3upload"), token) |>
aps_perform()
init_parsed <- resp_body_json(init_resp, simplifyVector = FALSE)
upload_url <- init_parsed$urls[[1]]
upload_key <- init_parsed$uploadKey
# Step 2: PUT directly to S3 (no APS auth header required)
file_raw <- readBin(file, "raw", n = file.info(file)$size)
request(upload_url) |>
req_timeout(300) |>
req_method("PUT") |>
req_body_raw(file_raw, type = "application/octet-stream") |>
req_perform()
# Step 3: finalize the upload with APS
final_resp <- aps_request(paste0(base_url, "/signeds3upload"), token) |>
req_body_json(list(uploadKey = upload_key)) |>
aps_perform()
final_parsed <- resp_body_json(final_resp, simplifyVector = FALSE)
structure(
list(
content = final_parsed,
path = base_url,
response = final_resp
),
class = "uploadFileSigned"
)
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.