XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides to create a new logical device metadata.

Request

{
    "Key":"Sample metadata key",
    "Value":"Sample metadata value"
}
HTTP Method Resource URI
POST 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 Body Description

Parameter Name Description Type Conditions
Key The key for the metadata. String
Value The value of the metadata. String

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

{
    "Key":"Sample metadata key",
    "Value":"Sample metadata value"
}

Response Body Description

Parameter Name Description Type
Key The key for the metadata. String
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 POST operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) Device not found.
409 (Conflict) Given metadata already exists in device metadata collection.