XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API is designed to fetch all image assets. You can filter your result with file name field. File name filtering is based on “starts with” search.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/asset/images?skip={skip}&take={take}&fileName={fileName}

URI Parameters

Parameter Name Description Type Conditions
skip The number of items in the collection to skip before executing a select. Number
take The number of items that should be fetched from the collection. Number
filename The unique name of file String

Request Headers

Header Field Name Description
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da

Response

{
    "Results":[
   {
	"Resizeable":false,
	"ResizedAssets":null,
       "ContentMimeType": "image/jpeg",
       "OriginalFilename": "testvideo.jpg",
       "AssetId": 181,
       "AssetUrl": "https://xomnistaging.blob.core.windows.net/images/7e4820c9-fedb-40f4-a153-903fe74d036d",
   },
   {
	"Resizeable":true,
           "ResizedAssets":[
              {
                  "CreatedDate":"2013-10-08T00:00:00",
                  "ImageSizeProfile":{
                      "Id":1,
                      "Height":100,
                      "Width":200
                  },
                  "AssetUrl":"http://xomnistaging.blob.core.windows.net/resizedassets/test-resizedasset"
              }
           ],
       "ContentMimeType": "image/jpeg",
       "OriginalFilename": "testvideo1.jpg",
       "AssetId": 182,
       "AssetUrl": "https://xomnistaging.blob.core.windows.net/images/932dc307-0e85-4c82-af64-9f56acb47135",
   }
]
    "TotalCount":2
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of asset in the filtered collection without paging. Number
Results[0..N].ContentMimeType Mime type of given asset. This value will be in the HTTP header of asset URL. String
Results[0..N].OriginalFilename File name of the asset given in file upload process. For more info about the file upload APIs, see Storage APIs. String
Results[0..N].AssetId The unique id of an asset moved from temporary storage to permanent storage. The value can be used to delete a relationship between an image and a brand. Number
Results[0..N].AssetUrl The unique URL of the asset. String

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 GET operations.