Autodesk.Forge.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 (string bucketKey, string objectName, string newObjName)

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

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class CopyToExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var bucketKey = bucketKey_example;  // string | URL-encoded bucket key
            var objectName = objectName_example;  // string | URL-encoded object name
            var newObjName = newObjName_example;  // string | URL-encoded Object key to use as the destination

            try
            {
                ObjectDetails result = apiInstance.CopyTo(bucketKey, objectName, newObjName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.CopyTo: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateSignedResource

PostObjectSigned CreateSignedResource (string bucketKey, string objectName, PostBucketsSigned postBucketsSigned, string access = null)

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.

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class CreateSignedResourceExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var bucketKey = bucketKey_example;  // string | URL-encoded bucket key
            var objectName = objectName_example;  // string | URL-encoded object name
            var postBucketsSigned = new PostBucketsSigned(); // PostBucketsSigned | Body Structure
            var access = access_example;  // string | Access for signed resource Acceptable values: `read`, `write`, `readwrite`. Default value: `read`  (optional)  (default to read)

            try
            {
                PostObjectSigned result = apiInstance.CreateSignedResource(bucketKey, objectName, postBucketsSigned, access);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.CreateSignedResource: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteObject

void DeleteObject (string bucketKey, string objectName)

Deletes an object from the bucket.

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class DeleteObjectExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var bucketKey = bucketKey_example;  // string | URL-encoded bucket key
            var objectName = objectName_example;  // string | URL-encoded object name

            try
            {
                apiInstance.DeleteObject(bucketKey, objectName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.DeleteObject: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

void (empty response body)

Authorization

oauth2_application

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSignedResource

void DeleteSignedResource (string id, string region = null)

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

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class DeleteSignedResourceExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var id = id_example;  // string | Id of signed resource
            var region = region_example;  // string | The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US`  (optional)  (default to US)

            try
            {
                apiInstance.DeleteSignedResource(id, region);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.DeleteSignedResource: " + e.Message );
            }
        }
    }
}

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

void (empty response body)

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetObject

System.IO.Stream GetObject (string bucketKey, string objectName, string range = null, string ifNoneMatch = null, DateTime? ifModifiedSince = null, string acceptEncoding = null)

Download an object.

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class GetObjectExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var bucketKey = bucketKey_example;  // string | URL-encoded bucket key
            var objectName = objectName_example;  // string | URL-encoded object name
            var range = range_example;  // string | A range of bytes to download from the specified object. (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // 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) 
            var ifModifiedSince = 2013-10-20;  // DateTime? | 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) 
            var acceptEncoding = acceptEncoding_example;  // 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) 

            try
            {
                System.IO.Stream result = apiInstance.GetObject(bucketKey, objectName, range, ifNoneMatch, ifModifiedSince, acceptEncoding);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.GetObject: " + e.Message );
            }
        }
    }
}

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	DateTime?	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

System.IO.Stream

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetObjectDetails

ObjectFullDetails GetObjectDetails (string bucketKey, string objectName, DateTime? ifModifiedSince = null, string with = null)

Returns object details in JSON format.

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class GetObjectDetailsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var bucketKey = bucketKey_example;  // string | URL-encoded bucket key
            var objectName = objectName_example;  // string | URL-encoded object name
            var ifModifiedSince = 2013-10-20;  // DateTime? | 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) 
            var with = with_example;  // string | Extra information in details; multiple uses are supported Acceptable values: `createdDate`, `lastAccessedDate`, `lastModifiedDate`  (optional) 

            try
            {
                ObjectFullDetails result = apiInstance.GetObjectDetails(bucketKey, objectName, ifModifiedSince, with);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.GetObjectDetails: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
bucketKey	string	URL-encoded bucket key
objectName	string	URL-encoded object name
ifModifiedSince	DateTime?	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetObjects

BucketObjects GetObjects (string bucketKey, int? limit = null, string beginsWith = null, string startAt = null)

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

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class GetObjectsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var bucketKey = bucketKey_example;  // string | URL-encoded bucket key
            var limit = 56;  // int? | Limit to the response size, Acceptable values: 1-100 Default = 10  (optional)  (default to 10)
            var beginsWith = beginsWith_example;  // string | Provides a way to filter the based on object key name (optional) 
            var startAt = startAt_example;  // 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) 

            try
            {
                BucketObjects result = apiInstance.GetObjects(bucketKey, limit, beginsWith, startAt);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.GetObjects: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
bucketKey	string	URL-encoded bucket key
limit	int?	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSignedResource

System.IO.Stream GetSignedResource (string id, string range = null, string ifNoneMatch = null, DateTime? ifModifiedSince = null, string acceptEncoding = null, string region = null)

Download an object using a signed URL.

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class GetSignedResourceExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var id = id_example;  // string | Id of signed resource
            var range = range_example;  // string | A range of bytes to download from the specified object. (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // 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) 
            var ifModifiedSince = 2013-10-20;  // DateTime? | 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) 
            var acceptEncoding = acceptEncoding_example;  // 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) 
            var region = region_example;  // string | The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US`  (optional)  (default to US)

            try
            {
                System.IO.Stream result = apiInstance.GetSignedResource(id, range, ifNoneMatch, ifModifiedSince, acceptEncoding, region);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.GetSignedResource: " + e.Message );
            }
        }
    }
}

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	DateTime?	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

System.IO.Stream

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStatusBySessionId

void GetStatusBySessionId (string bucketKey, string objectName, string sessionId)

This endpoint returns status information about a resumable upload.

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class GetStatusBySessionIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var bucketKey = bucketKey_example;  // string | URL-encoded bucket key
            var objectName = objectName_example;  // string | URL-encoded object name
            var sessionId = sessionId_example;  // string | Unique identifier of a session of a file being uploaded

            try
            {
                apiInstance.GetStatusBySessionId(bucketKey, objectName, sessionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.GetStatusBySessionId: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
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

void (empty response body)

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UploadChunk

ObjectDetails UploadChunk (string bucketKey, string objectName, int? contentLength, string contentRange, string sessionId, System.IO.Stream body, string contentDisposition = null, string ifMatch = null)

This endpoint allows resumable uploads for large files in chunks.

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class UploadChunkExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var bucketKey = bucketKey_example;  // string | URL-encoded bucket key
            var objectName = objectName_example;  // string | URL-encoded object name
            var contentLength = 56;  // int? | Indicates the size of the request body.
            var contentRange = contentRange_example;  // string | Byte range of a segment being uploaded
            var sessionId = sessionId_example;  // string | Unique identifier of a session of a file being uploaded
            var body = /path/to/file.txt;  // System.IO.Stream | 
            var contentDisposition = contentDisposition_example;  // string | The suggested default filename when downloading this object to a file after it has been uploaded. (optional) 
            var ifMatch = ifMatch_example;  // 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) 

            try
            {
                ObjectDetails result = apiInstance.UploadChunk(bucketKey, objectName, contentLength, contentRange, sessionId, body, contentDisposition, ifMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.UploadChunk: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
bucketKey	string	URL-encoded bucket key
objectName	string	URL-encoded object name
contentLength	int?	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	System.IO.StreamSystem.IO.Stream
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]
contentType	string	Content type for the upload	[optional]

Return type

ObjectDetails

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UploadObject

ObjectDetails UploadObject (string bucketKey, string objectName, int? contentLength, System.IO.Stream body, string contentDisposition = null, string ifMatch = null)

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.

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class UploadObjectExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var bucketKey = bucketKey_example;  // string | URL-encoded bucket key
            var objectName = objectName_example;  // string | URL-encoded object name
            var contentLength = 56;  // int? | Indicates the size of the request body.
            var body = /path/to/file.txt;  // System.IO.Stream | 
            var contentDisposition = contentDisposition_example;  // string | The suggested default filename when downloading this object to a file after it has been uploaded. (optional) 
            var ifMatch = ifMatch_example;  // 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) 

            try
            {
                ObjectDetails result = apiInstance.UploadObject(bucketKey, objectName, contentLength, body, contentDisposition, ifMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.UploadObject: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
bucketKey	string	URL-encoded bucket key
objectName	string	URL-encoded object name
contentLength	int?	Indicates the size of the request body.
body	System.IO.StreamSystem.IO.Stream
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]
contentType	string	Content type for the upload	[optional]

Return type

ObjectDetails

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UploadSignedResource

ObjectDetails UploadSignedResource (string id, int? contentLength, System.IO.Stream body, string contentDisposition = null, string xAdsRegion = null, string ifMatch = null)

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

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class UploadSignedResourceExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var id = id_example;  // string | Id of signed resource
            var contentLength = 56;  // int? | Indicates the size of the request body.
            var body = /path/to/file.txt;  // System.IO.Stream | 
            var contentDisposition = contentDisposition_example;  // string | The suggested default filename when downloading this object to a file after it has been uploaded. (optional) 
            var xAdsRegion = xAdsRegion_example;  // string | The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US`  (optional)  (default to US)
            var ifMatch = ifMatch_example;  // 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) 

            try
            {
                ObjectDetails result = apiInstance.UploadSignedResource(id, contentLength, body, contentDisposition, xAdsRegion, ifMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.UploadSignedResource: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	Id of signed resource
contentLength	int?	Indicates the size of the request body.
body	System.IO.StreamSystem.IO.Stream
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]
contentType	string	Content type for the upload	[optional]

Return type

ObjectDetails

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UploadSignedResourcesChunk

ObjectDetails UploadSignedResourcesChunk (string id, string contentRange, string sessionId, System.IO.Stream body, string contentDisposition = null, string xAdsRegion = null)

Resumable upload for signed URLs.

Example

using System;
using System.Diagnostics;
using Autodesk.Forge;
using Autodesk.Forge.Client;
using Autodesk.Forge.Model;

namespace Example
{
    public class UploadSignedResourcesChunkExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2_application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ObjectsApi();
            var id = id_example;  // string | Id of signed resource
            var contentRange = contentRange_example;  // string | Byte range of a segment being uploaded
            var sessionId = sessionId_example;  // string | Unique identifier of a session of a file being uploaded
            var body = /path/to/file.txt;  // System.IO.Stream | 
            var contentDisposition = contentDisposition_example;  // string | The suggested default filename when downloading this object to a file after it has been uploaded. (optional) 
            var xAdsRegion = xAdsRegion_example;  // string | The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US`  (optional)  (default to US)

            try
            {
                ObjectDetails result = apiInstance.UploadSignedResourcesChunk(id, contentRange, sessionId, body, contentDisposition, xAdsRegion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ObjectsApi.UploadSignedResourcesChunk: " + e.Message );
            }
        }
    }
}

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	System.IO.StreamSystem.IO.Stream
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]
contentType	string	Content type for the upload	[optional]

Return type

ObjectDetails

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

ObjectsApi.md

Latest commit

History

ObjectsApi.md

File metadata and controls

Autodesk.Forge.ObjectsApi

CopyTo

Example

Parameters

Return type

Authorization

HTTP request headers

CreateSignedResource

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteObject

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteSignedResource

Example

Parameters

Return type

Authorization

HTTP request headers

GetObject

Example

Parameters

Return type

Authorization

HTTP request headers

GetObjectDetails

Example

Parameters

Return type

Authorization

HTTP request headers

GetObjects

Example

Parameters

Return type

Authorization

HTTP request headers

GetSignedResource

Example

Parameters

Return type

Authorization

HTTP request headers

GetStatusBySessionId

Example

Parameters

Return type

Authorization

HTTP request headers

UploadChunk

Example

Parameters

Return type

Authorization

HTTP request headers

UploadObject

Example

Parameters

Return type

Authorization

HTTP request headers

UploadSignedResource

Example

Parameters

Return type

Authorization

HTTP request headers

UploadSignedResourcesChunk