XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API is designed to provide file upload mechanisms with small chunks (Up to 4 MB). File upload APIs upload given files to a temporary storage. If a relation request comes for a particular file, the API copies the file to a permanent storage. Using this API, you can parallelize your file upload and you can create resume/continue mechanisms in file upload scenarios. This API returns a unique key for your upload. You should store these unique keys orderly in order to finalize file upload process.

Request

"ZTQyN2E2MjktZTA4OC00MzNiLWE2ODUtMzk5MzE5ZjY4ZGM1"
HTTP Method Resource URI
PUT https://{tenantName}.api.xomni.com/private/asset/temp?fileName={fileName}

URI Parameters

Parameter Name Description Type Conditions
filename The unique name of file. String

Request Body Description

You should send file chunk as byte array in request body.

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

"ZTQyN2E2MjktZTA4OC00MzNiLWE2ODUtMzk5MzE5ZjY4ZGM1"

Response Body Description

The unique key represents file upload operation.

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for PUT operations. Possible response status codes are as listed below:

Status Code Description
409 (Conflict) There is an existing file for given file name.
413 (Request Entity Too Large) Byte array content in file upload request exceeds limit. (Max request limit is 4 MB).