Skip to content

Return current state and provider-confirmed uploaded parts.

GET
/api/workspace/files/uploads/{uploadSessionId}
curl --request GET \
--url https://example.com/api/workspace/files/uploads/example
  • None
uploadSessionId
required
string
access_token
string

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

OK

Media typeapplication/json
object
Data

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

object
UploadSessionId
string
nullable
FileBodyGenerationId
string
nullable
TargetFolderId
string
nullable
RequestedFileName
string
nullable
DeclaredMimeType
string
nullable
DeclaredSizeBytes
integer format: int64
ClientDeclaredSha256
string
nullable
PartSizeBytes
integer format: int32
MaximumParallelParts
integer format: int32
ExpiresAtUtc
string format: date-time
ClientChecksumAlgorithm
string
nullable
ClientChecksumRequired
boolean
Status
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11
RowVersion
string format: uuid
AlreadyUploadedParts
Array<object>
nullable

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

object
PartNumber
integer format: int32
SizeBytes
integer format: int64
FailureCode
string
nullable
PublishedFileReferenceId
string
nullable
Errors
Array<object>
nullable
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
Array<object>
nullable
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
Array<object>
nullable
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
boolean
Example
{
"Data": {
"Status": 0,
"Errors": [
{
"Type": 0,
"Severity": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
Data

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

object
UploadSessionId
string
nullable
FileBodyGenerationId
string
nullable
TargetFolderId
string
nullable
RequestedFileName
string
nullable
DeclaredMimeType
string
nullable
DeclaredSizeBytes
integer format: int64
ClientDeclaredSha256
string
nullable
PartSizeBytes
integer format: int32
MaximumParallelParts
integer format: int32
ExpiresAtUtc
string format: date-time
ClientChecksumAlgorithm
string
nullable
ClientChecksumRequired
boolean
Status
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11
RowVersion
string format: uuid
AlreadyUploadedParts
Array<object>
nullable

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

object
PartNumber
integer format: int32
SizeBytes
integer format: int64
FailureCode
string
nullable
PublishedFileReferenceId
string
nullable
Errors
Array<object>
nullable
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
Array<object>
nullable
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
Array<object>
nullable
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
boolean
Example
{
"Data": {
"Status": 0,
"Errors": [
{
"Type": 0,
"Severity": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Conflict

Media typeapplication/json
object
Data

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

object
UploadSessionId
string
nullable
FileBodyGenerationId
string
nullable
TargetFolderId
string
nullable
RequestedFileName
string
nullable
DeclaredMimeType
string
nullable
DeclaredSizeBytes
integer format: int64
ClientDeclaredSha256
string
nullable
PartSizeBytes
integer format: int32
MaximumParallelParts
integer format: int32
ExpiresAtUtc
string format: date-time
ClientChecksumAlgorithm
string
nullable
ClientChecksumRequired
boolean
Status
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11
RowVersion
string format: uuid
AlreadyUploadedParts
Array<object>
nullable

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

object
PartNumber
integer format: int32
SizeBytes
integer format: int64
FailureCode
string
nullable
PublishedFileReferenceId
string
nullable
Errors
Array<object>
nullable
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
Array<object>
nullable
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
Array<object>
nullable
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
boolean
Example
{
"Data": {
"Status": 0,
"Errors": [
{
"Type": 0,
"Severity": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Too Many Requests

Media typeapplication/json
object
Data
nullable
Errors
Array<object>
nullable
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
Array<object>
nullable
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
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Service Unavailable

Media typeapplication/json
object
Data

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

object
UploadSessionId
string
nullable
FileBodyGenerationId
string
nullable
TargetFolderId
string
nullable
RequestedFileName
string
nullable
DeclaredMimeType
string
nullable
DeclaredSizeBytes
integer format: int64
ClientDeclaredSha256
string
nullable
PartSizeBytes
integer format: int32
MaximumParallelParts
integer format: int32
ExpiresAtUtc
string format: date-time
ClientChecksumAlgorithm
string
nullable
ClientChecksumRequired
boolean
Status
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11
RowVersion
string format: uuid
AlreadyUploadedParts
Array<object>
nullable

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

object
PartNumber
integer format: int32
SizeBytes
integer format: int64
FailureCode
string
nullable
PublishedFileReferenceId
string
nullable
Errors
Array<object>
nullable
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
Array<object>
nullable
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
Array<object>
nullable
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
boolean
Example
{
"Data": {
"Status": 0,
"Errors": [
{
"Type": 0,
"Severity": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}