Stream bytes to an authorized direct field upload using Database or Local storage.

PUT

/api/workspace/files/uploads/{uploadSessionId}/content

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/files/uploads/example/content"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("binary")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/octet-stream")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/files/uploads/example/content';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/octet-stream'},
  body: 'binary'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/workspace/files/uploads/example/content \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/octet-stream' \
  --data binary

Authorizations

WorkspaceBearer

Parameters

Path Parameters

uploadSessionId

required

string

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body^required

application/octet-stream

string format: binary

Responses

200

application/json

object

Data

required

Any of:

object
object

Public state of a resumable managed file upload. PublishedFileReferenceId is non-null only once the session reaches Available.

object

UploadSessionId

required

string

FileBodyGenerationId

string

nullable

TargetFolderId

required

string

RequestedFileName

required

string

DeclaredMimeType

required

string

DeclaredSizeBytes

required

integer format: int64

ClientDeclaredSha256

string

nullable

PartSizeBytes

required

integer format: int32

MaximumParallelParts

required

integer format: int32

ExpiresAtUtc

required

string format: date-time

ClientChecksumAlgorithm

required

string

ClientChecksumRequired

required

boolean

Status

required

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

RowVersion

required

string format: uuid

AlreadyUploadedParts

required

Array<object>

One provider-confirmed uploaded part safe to expose for resume.

object

PartNumber

required

integer format: int32

SizeBytes

required

integer format: int64

FailureCode

string

nullable

PublishedFileReferenceId

string

nullable

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

required

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

The operation was refused; inspect Errors. Data may be null.

application/json

object

Data

required

Any of:

object
object

Public state of a resumable managed file upload. PublishedFileReferenceId is non-null only once the session reaches Available.

object

UploadSessionId

required

string

FileBodyGenerationId

string

nullable

TargetFolderId

required

string

RequestedFileName

required

string

DeclaredMimeType

required

string

DeclaredSizeBytes

required

integer format: int64

ClientDeclaredSha256

string

nullable

PartSizeBytes

required

integer format: int32

MaximumParallelParts

required

integer format: int32

ExpiresAtUtc

required

string format: date-time

ClientChecksumAlgorithm

required

string

ClientChecksumRequired

required

boolean

Status

required

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

RowVersion

required

string format: uuid

AlreadyUploadedParts

required

Array<object>

One provider-confirmed uploaded part safe to expose for resume.

object

PartNumber

required

integer format: int32

SizeBytes

required

integer format: int64

FailureCode

string

nullable

PublishedFileReferenceId

string

nullable

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

required

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden; the controller returns no response body.

404

The operation was refused; inspect Errors. Data may be null.

application/json

object

Data

required

Any of:

object
object

Public state of a resumable managed file upload. PublishedFileReferenceId is non-null only once the session reaches Available.

object

UploadSessionId

required

string

FileBodyGenerationId

string

nullable

TargetFolderId

required

string

RequestedFileName

required

string

DeclaredMimeType

required

string

DeclaredSizeBytes

required

integer format: int64

ClientDeclaredSha256

string

nullable

PartSizeBytes

required

integer format: int32

MaximumParallelParts

required

integer format: int32

ExpiresAtUtc

required

string format: date-time

ClientChecksumAlgorithm

required

string

ClientChecksumRequired

required

boolean

Status

required

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

RowVersion

required

string format: uuid

AlreadyUploadedParts

required

Array<object>

One provider-confirmed uploaded part safe to expose for resume.

object

PartNumber

required

integer format: int32

SizeBytes

required

integer format: int64

FailureCode

string

nullable

PublishedFileReferenceId

string

nullable

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

required

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

The operation was refused; inspect Errors. Data may be null.

application/json

object

Data

required

Any of:

object
object

Public state of a resumable managed file upload. PublishedFileReferenceId is non-null only once the session reaches Available.

object

UploadSessionId

required

string

FileBodyGenerationId

string

nullable

TargetFolderId

required

string

RequestedFileName

required

string

DeclaredMimeType

required

string

DeclaredSizeBytes

required

integer format: int64

ClientDeclaredSha256

string

nullable

PartSizeBytes

required

integer format: int32

MaximumParallelParts

required

integer format: int32

ExpiresAtUtc

required

string format: date-time

ClientChecksumAlgorithm

required

string

ClientChecksumRequired

required

boolean

Status

required

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

RowVersion

required

string format: uuid

AlreadyUploadedParts

required

Array<object>

One provider-confirmed uploaded part safe to expose for resume.

object

PartNumber

required

integer format: int32

SizeBytes

required

integer format: int64

FailureCode

string

nullable

PublishedFileReferenceId

string

nullable

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

required

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

503

The operation was refused; inspect Errors. Data may be null.

application/json

object

Data

required

Any of:

object
object

Public state of a resumable managed file upload. PublishedFileReferenceId is non-null only once the session reaches Available.

object

UploadSessionId

required

string

FileBodyGenerationId

string

nullable

TargetFolderId

required

string

RequestedFileName

required

string

DeclaredMimeType

required

string

DeclaredSizeBytes

required

integer format: int64

ClientDeclaredSha256

string

nullable

PartSizeBytes

required

integer format: int32

MaximumParallelParts

required

integer format: int32

ExpiresAtUtc

required

string format: date-time

ClientChecksumAlgorithm

required

string

ClientChecksumRequired

required

boolean

Status

required

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

RowVersion

required

string format: uuid

AlreadyUploadedParts

required

Array<object>

One provider-confirmed uploaded part safe to expose for resume.

object

PartNumber

required

integer format: int32

SizeBytes

required

integer format: int64

FailureCode

string

nullable

PublishedFileReferenceId

string

nullable

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

required

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Stream bytes to an authorized direct field upload using Database or Local storage.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Bodyrequired

Responses

200

Example

400

Example

403

404

Example

409

Example

503

Example

Request Body^required