Sample - Box Platform API
GET/files/upload_sessions/{upload_session_id}

Get upload session

Return information about an upload session.

The actual endpoint URL is returned by the Create upload session endpoint.

1 parameter
upload_session_idstringrequired
The ID of the upload session.

2 status codes
200Returns an upload session object.
idstringoptional
The unique identifier for this session.
typestringoptional
The value will always be `upload_session`.
Allowed:upload_session
session_expires_atstringoptional
The date and time when this session expires.
part_sizeintegeroptional
The size in bytes that must be used for all parts of of the upload. Only the last part is allowed to be of a smaller size.
total_partsintegeroptional
The total number of parts expected in this upload session, as determined by the file size and part size.
num_parts_processedintegeroptional
The number of parts that have been uploaded and processed by the server. This starts at `0`. When committing a file files, inspecting this property can provide insight if all parts have been uploaded correctly.
session_endpointsobjectoptional
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

Any other status is an error: An unexpected client error.