XOMNI: Experience Omni-Channel

Last Updated: March 30, 2016

The API provides to fetch a list of metadata of a particular logical device.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/management/company/physicaldevices/{physicaldeviceId}/devices/{deviceId}/metadata

URI Parameters

Parameter Name Description Type Conditions
physicaldeviceId Unique ID of the physical device. String
deviceId Unique ID of the device. String

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
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

[
   {
       "Key": "Sample metadata key 1",
       "Value": "Sample metadata value 1",
   },
   {
       "Key": "Sample metadata key 2",
       "Value": "Sample metadata value 2",
   },
   {
       "Key": "Sample metadata key 3",
       "Value": "Sample metadata value 3",
   },
   {
       "Key": "Sample metadata key 4",
       "Value": "Sample metadata value 4",
   },
   {
       "Key": "Sample metadata key 5",
       "Value": "Sample metadata value 5",
   }
]

Response Body Description

Parameter Name Description Type
[0..N].Key The key for the metadata. String
[0..N].Value The value of the metadata. 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) Device not found.
404 (Not Found) No device metadata found.