| Server IP : 79.136.114.73 / Your IP : 18.191.73.161 Web Server : Apache/2.4.7 (Ubuntu) PHP/5.5.9-1ubuntu4.29 OpenSSL/1.0.1f System : Linux b8009 3.13.0-170-generic #220-Ubuntu SMP Thu May 9 12:40:49 UTC 2019 x86_64 User : www-data ( 33) PHP Version : 5.5.9-1ubuntu4.29 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority, MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /var/www/appsrv.astacus.se/forge/forge-api-nodejs-client/docs/ |
Upload File : |
# ForgeSdk.ObjectsApi
All URIs are relative to *https://developer.api.autodesk.com/*
Method | HTTP request | Description
------------- | ------------- | -------------
[**copyTo**](ObjectsApi.md#copyTo) | **PUT** /oss/v2/buckets/{bucketKey}/objects/{objectName}/copyto/{newObjName} |
[**createSignedResource**](ObjectsApi.md#createSignedResource) | **POST** /oss/v2/buckets/{bucketKey}/objects/{objectName}/signed |
[**deleteObject**](ObjectsApi.md#deleteObject) | **DELETE** /oss/v2/buckets/{bucketKey}/objects/{objectName} |
[**deleteSignedResource**](ObjectsApi.md#deleteSignedResource) | **DELETE** /oss/v2/signedresources/{id} |
[**getObject**](ObjectsApi.md#getObject) | **GET** /oss/v2/buckets/{bucketKey}/objects/{objectName} |
[**getObjectDetails**](ObjectsApi.md#getObjectDetails) | **GET** /oss/v2/buckets/{bucketKey}/objects/{objectName}/details |
[**getObjects**](ObjectsApi.md#getObjects) | **GET** /oss/v2/buckets/{bucketKey}/objects |
[**getSignedResource**](ObjectsApi.md#getSignedResource) | **GET** /oss/v2/signedresources/{id} |
[**getStatusBySessionId**](ObjectsApi.md#getStatusBySessionId) | **GET** /oss/v2/buckets/{bucketKey}/objects/{objectName}/status/{sessionId} |
[**uploadChunk**](ObjectsApi.md#uploadChunk) | **PUT** /oss/v2/buckets/{bucketKey}/objects/{objectName}/resumable |
[**uploadObject**](ObjectsApi.md#uploadObject) | **PUT** /oss/v2/buckets/{bucketKey}/objects/{objectName} |
[**uploadSignedResource**](ObjectsApi.md#uploadSignedResource) | **PUT** /oss/v2/signedresources/{id} |
[**uploadSignedResourcesChunk**](ObjectsApi.md#uploadSignedResourcesChunk) | **PUT** /oss/v2/signedresources/{id}/resumable |
<a name="copyTo"></a>
# **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**](ObjectDetails.md)
### Authorization
[oauth2_application](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/vnd.api+json, application/json
<a name="createSignedResource"></a>
# **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**](PostBucketsSigned.md)| Body Structure |
**access** | **String**| Access for signed resource Acceptable values: `read`, `write`, `readwrite`. Default value: `read` | [optional] [default to read]
### Return type
[**PostObjectSigned**](PostObjectSigned.md)
### Authorization
[oauth2_application](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/vnd.api+json, application/json
<a name="deleteObject"></a>
# **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](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
<a name="deleteSignedResource"></a>
# **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](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
<a name="getObject"></a>
# **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](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/octet-stream
<a name="getObjectDetails"></a>
# **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**](ObjectFullDetails.md)
### Authorization
[oauth2_application](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/vnd.api+json, application/json
<a name="getObjects"></a>
# **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**](BucketObjects.md)
### Authorization
[oauth2_application](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/vnd.api+json, application/json
<a name="getSignedResource"></a>
# **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](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/octet-stream
<a name="getStatusBySessionId"></a>
# **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](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/vnd.api+json, application/json
<a name="uploadChunk"></a>
# **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**](ObjectDetails.md)
### Authorization
[oauth2_application](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/octet-stream
- **Accept**: application/vnd.api+json, application/json
<a name="uploadObject"></a>
# **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**](ObjectDetails.md)
### Authorization
[oauth2_application](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/octet-stream
- **Accept**: application/vnd.api+json, application/json
<a name="uploadSignedResource"></a>
# **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**](ObjectDetails.md)
### Authorization
[oauth2_application](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/octet-stream
- **Accept**: application/vnd.api+json, application/json
<a name="uploadSignedResourcesChunk"></a>
# **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**](ObjectDetails.md)
### Authorization
[oauth2_application](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/octet-stream
- **Accept**: application/vnd.api+json, application/json