Skip to content

Latest commit

 

History

History
419 lines (259 loc) · 16.5 KB

ObjectsApi.md

File metadata and controls

419 lines (259 loc) · 16.5 KB
Raw

ForgeSdk.ObjectsApi

All URIs are relative to https://developer.api.autodesk.com/

Method HTTP request Description
copyTo PUT /oss/v2/buckets/{bucketKey}/objects/{objectName}/copyto/{newObjName}
createSignedResource POST /oss/v2/buckets/{bucketKey}/objects/{objectName}/signed
deleteObject DELETE /oss/v2/buckets/{bucketKey}/objects/{objectName}
deleteSignedResource DELETE /oss/v2/signedresources/{id}
getObject GET /oss/v2/buckets/{bucketKey}/objects/{objectName}
getObjectDetails GET /oss/v2/buckets/{bucketKey}/objects/{objectName}/details
getObjects GET /oss/v2/buckets/{bucketKey}/objects
getSignedResource GET /oss/v2/signedresources/{id}
getStatusBySessionId GET /oss/v2/buckets/{bucketKey}/objects/{objectName}/status/{sessionId}
uploadChunk PUT /oss/v2/buckets/{bucketKey}/objects/{objectName}/resumable
uploadObject PUT /oss/v2/buckets/{bucketKey}/objects/{objectName}
uploadSignedResource PUT /oss/v2/signedresources/{id}
uploadSignedResourcesChunk PUT /oss/v2/signedresources/{id}/resumable

copyTo

ObjectDetails copyTo(bucketKey, objectName, newObjName, oauth2client, credentials)

Copies an object to another object name in the same bucket.

Parameters

Name Type Description Notes
bucketKey String URL-encoded bucket key
objectName String URL-encoded object name
newObjName String URL-encoded Object key to use as the destination

Return type

ObjectDetails

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

createSignedResource

PostObjectSigned createSignedResource(bucketKey, objectName, postBucketsSigned, opts, oauth2client, credentials)

This endpoint creates a signed URL that can be used to download an object within the specified expiration time. Be aware that if the object the signed URL points to is deleted or expires before the signed URL expires, then the signed URL will no longer be valid. A successful call to this endpoint requires bucket owner access.

Parameters

Name Type Description Notes
bucketKey String URL-encoded bucket key
objectName String URL-encoded object name
postBucketsSigned PostBucketsSigned Body Structure
access String Access for signed resource Acceptable values: `read`, `write`, `readwrite`. Default value: `read` [optional] [default to read]

Return type

PostObjectSigned

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

deleteObject

deleteObject(bucketKey, objectName, oauth2client, credentials)

Deletes an object from the bucket.

Parameters

Name Type Description Notes
bucketKey String URL-encoded bucket key
objectName String URL-encoded object name

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

deleteSignedResource

deleteSignedResource(id, opts, oauth2client, credentials)

Delete a signed URL. A successful call to this endpoint requires bucket owner access.

Parameters

Name Type Description Notes
id String Id of signed resource
region String The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US` [optional] [default to US]

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

getObject

Object getObject(bucketKey, objectName, opts, oauth2client, credentials)

Download an object.

Parameters

Name Type Description Notes
bucketKey String URL-encoded bucket key
objectName String URL-encoded object name
range String A range of bytes to download from the specified object. [optional]
ifNoneMatch String The value of this header is compared to the ETAG of the object. If they match, the body will not be included in the response. Only the object information will be included. [optional]
ifModifiedSince Date If the requested object has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message body. [optional]
acceptEncoding String When gzip is specified, a gzip compressed stream of the object’s bytes will be returned in the response. Cannot use “Accept-Encoding:gzip” with Range header containing an end byte range. End byte range will not be honored if “Accept-Encoding: gzip” header is used. [optional]

Return type

Object

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/octet-stream

getObjectDetails

ObjectFullDetails getObjectDetails(bucketKey, objectName, opts, oauth2client, credentials)

Returns object details in JSON format.

Parameters

Name Type Description Notes
bucketKey String URL-encoded bucket key
objectName String URL-encoded object name
ifModifiedSince Date If the requested object has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message body. [optional]
_with String Extra information in details; multiple uses are supported Acceptable values: `createdDate`, `lastAccessedDate`, `lastModifiedDate` [optional]

Return type

ObjectFullDetails

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

getObjects

BucketObjects getObjects(bucketKey, opts, oauth2client, credentials)

List objects in a bucket. It is only available to the bucket creator.

Parameters

Name Type Description Notes
bucketKey String URL-encoded bucket key
limit Integer Limit to the response size, Acceptable values: 1-100 Default = 10 [optional] [default to 10]
beginsWith String Provides a way to filter the based on object key name [optional]
startAt String Key to use as an offset to continue pagination This is typically the last bucket key found in a preceding GET buckets response [optional]

Return type

BucketObjects

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

getSignedResource

Object getSignedResource(id, opts, oauth2client, credentials)

Download an object using a signed URL.

Parameters

Name Type Description Notes
id String Id of signed resource
range String A range of bytes to download from the specified object. [optional]
ifNoneMatch String The value of this header is compared to the ETAG of the object. If they match, the body will not be included in the response. Only the object information will be included. [optional]
ifModifiedSince Date If the requested object has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message body. [optional]
acceptEncoding String When gzip is specified, a gzip compressed stream of the object’s bytes will be returned in the response. Cannot use “Accept-Encoding:gzip” with Range header containing an end byte range. End byte range will not be honored if “Accept-Encoding: gzip” header is used. [optional]
region String The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US` [optional] [default to US]

Return type

Object

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/octet-stream

getStatusBySessionId

getStatusBySessionId(bucketKey, objectName, sessionId, oauth2client, credentials)

This endpoint returns status information about a resumable upload.

Parameters

Name Type Description Notes
bucketKey String URL-encoded bucket key
objectName String URL-encoded object name
sessionId String Unique identifier of a session of a file being uploaded

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

uploadChunk

ObjectDetails uploadChunk(bucketKey, objectName, contentLength, contentRange, sessionId, body, opts, oauth2client, credentials)

This endpoint allows resumable uploads for large files in chunks.

Parameters

Name Type Description Notes
bucketKey String URL-encoded bucket key
objectName String URL-encoded object name
contentLength Integer Indicates the size of the request body.
contentRange String Byte range of a segment being uploaded
sessionId String Unique identifier of a session of a file being uploaded
body File
contentDisposition String The suggested default filename when downloading this object to a file after it has been uploaded. [optional]
ifMatch String If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written. [optional]

Return type

ObjectDetails

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/octet-stream
  • Accept: application/vnd.api+json, application/json

uploadObject

ObjectDetails uploadObject(bucketKey, objectName, contentLength, body, opts, oauth2client, credentials)

Upload an object. If the specified object name already exists in the bucket, the uploaded content will overwrite the existing content for the bucket name/object name combination.

Parameters

Name Type Description Notes
bucketKey String URL-encoded bucket key
objectName String URL-encoded object name
contentLength Integer Indicates the size of the request body.
body File
contentDisposition String The suggested default filename when downloading this object to a file after it has been uploaded. [optional]
ifMatch String If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written. [optional]

Return type

ObjectDetails

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/octet-stream
  • Accept: application/vnd.api+json, application/json

uploadSignedResource

ObjectDetails uploadSignedResource(id, contentLength, body, opts, oauth2client, credentials)

Overwrite a existing object using a signed URL. Conditions to call this operation: Object is available Expiration period is valid Signed URL should be created with `write` or `readwrite`

Parameters

Name Type Description Notes
id String Id of signed resource
contentLength Integer Indicates the size of the request body.
body File
contentDisposition String The suggested default filename when downloading this object to a file after it has been uploaded. [optional]
xAdsRegion String The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US` [optional] [default to US]
ifMatch String If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written. [optional]

Return type

ObjectDetails

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/octet-stream
  • Accept: application/vnd.api+json, application/json

uploadSignedResourcesChunk

ObjectDetails uploadSignedResourcesChunk(id, contentRange, sessionId, body, opts, oauth2client, credentials)

Resumable upload for signed URLs.

Parameters

Name Type Description Notes
id String Id of signed resource
contentRange String Byte range of a segment being uploaded
sessionId String Unique identifier of a session of a file being uploaded
body File
contentDisposition String The suggested default filename when downloading this object to a file after it has been uploaded. [optional]
xAdsRegion String The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US` [optional] [default to US]

Return type

ObjectDetails

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/octet-stream
  • Accept: application/vnd.api+json, application/json