This endpoint is used to upload the file in chunks using the tus open protocol. Please see tus.io for more information.
Authentication
Requires Authorization header with valid Bearer token for scope itwin-platform.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Rate limits
All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.
Request parameters
The unique identifier of the Schedule.
Unique identifier of the file being uploaded.
Request headers
Tus-Resumable header to signify protocol version.
Upload-Offset header to signify how much has already been uploaded.
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
The binary data representing a chunk of the file to be uploaded.
Response 204 No Content
The file chunk upload was successful.
Response headers
How much of the file has been uploaded.
Response 400 Bad Request
User has failed to provide required headers.
{ "error": { "code": "InvalidUploadOffsetHeader", "message": "Could not parse Upload-Offset header." } }
Response 401 Unauthorized
This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 403 Forbidden
User is not authorized to upload to this file.
{ "error": { "code": "InsufficientPermissions", "message": "The user has insufficient permissions for the requested operation." } }
Response 404 Not Found
This response indicates that the provided File or Schedule is not available or that the Tus-Resumable header is missing.
{ "error": { "code": "FileNotFound", "message": "Resource not found." } }
Response 409 Conflict
This response indicates that the Upload-Offset header does not match the current offset on the server.
{ "error": { "code": "OffsetMismatch", "message": "Offset does not match file. File offset: {expectedOffset}. Request offset: {actualOffset}" } }
Response 413 Request Entity Too Large
This response indicates that the request size is larger than the file size.
{ "error": { "code": "RequestEntityTooLarge", "message": "Request contains more data than the file's upload length." } }
Response 415 Unsupported Media Type
This response indicates that the Content-Type header is missing or is incorrect.
{ "error": { "code": "InvalidContentType", "message": "Content-Type is invalid. Must be application/offset+octet-stream." } }
Response 429 Too many requests
This response indicates that the client sent more requests than allowed by this API for the current tier of the client.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
scheduleId-Files-fileId-PatchRequest-3
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "type": "object", "description": "Contains error information.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error.", "nullable": true } }, "required": [ "code", "message" ], "additionalProperties": true }
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
{ "type": "object", "title": "Error Response", "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.", "properties": { "error": { "description": "Error information.", "$ref": "#/components/schemas/Error" } }, "required": [ "error" ], "additionalProperties": false }
Was this page helpful?