XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API is designed to provide asset relations.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/storage/assets/{assetId}/relations

URI Parameters

Parameter Name Description Type Conditions
assetId The unique ID of the asset. Number

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

{
  "RelatedItemIds": [
    12,
    4,
    6
  ],
  "RelatedCategoryIds": [
    2,
    5,
    7
  ],
  "RelatedBrandIds": [
    1,
    2,
    4
  ]
}

Response Body Description

Parameter Name Description Type
RelatedItemIds A collection contains related item IDs. Array
RelatedCategoryIds A collection contains related category IDs. Array
RelatedBrandIds A collection contains related brand IDs. Array

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) Asset not found.
404 (Not Found) No relation found for given asset ID.