XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The APIs can be used to create relationships between assets and categories. Using this API, you can get a list of documents assigned to a particular category.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/categories/{categoryId}/document

URI Parameters

Parameter Name Description Type Conditions
categoryId The unique ID of a category Number

Request Headers

Header Field Name Description
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

[
   {
       "ContentMimeType": "image/jpeg",
       "OriginalFilename": "testvideo.jpg",
       "AssetId": 181,
       "AssetUrl": "https://xomnistaging.blob.core.windows.net/documents/7e4820c9-fedb-40f4-a153-903fe74d036d",
       "IsDefault": false
   },
   {
       "ContentMimeType": "image/jpeg",
       "OriginalFilename": "testvideo1.jpg",
       "AssetId": 182,
       "AssetUrl": "https://xomnistaging.blob.core.windows.net/documents/932dc307-0e85-4c82-af64-9f56acb47135",
       "IsDefault": true
   }
]

Response Body Description

Parameter Name Description Type
[0..N].ContentMimeType Mime type of given asset. This value will be in the HTTP header of asset URL. String
[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
[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
[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. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) The category or any documents for the given category could not be found.