XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API updates an existing device storage data and returns it.

Request

{
   "Key":"SampleKey11",
   "Value":"SampleValue",
   "IsPublic":true
}
HTTP Method Resource URI
PUT https://{tenantName}.api.xomni.com/company/logicaldevices/{deviceId}/storage

URI Parameters

Parameter Name Description Type Conditions
deviceId Id of the device String

Request Body Description

Parameter Name Description Type Conditions
IsPublic A Boolean field indicating whether the data storage item is accessable from other devices or not. Boolean
Required
Key Data storage key. String
Required
Value Data storage value. String
Required

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

{  
   "Data":{  
      "DeviceId":"9ead1d3d-28c1-4dc4-b99e-3542401c9f77",
      "Key":"SampleKey11",
      "Value":"SampleValue",
      "IsPublic":true
   }
}

Response Body Description

Parameter Name Description Type
Data.IsPublic A Boolean field indicating whether the data storage item is accessable from other devices or not. Boolean
Data.DeviceId Id of the device String
Data.Key Data storage key. String
Data.Value Data storage value. 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 PUT operations. Possible response status codes are as listed below:

Status Code Description
403 (Forbidden) Device storage item is marked as private. Only related device can access this item.
404 (Not Found) Specified device not found.
404 (Not Found) Specified device storage data not found.