XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The tag metadata management systems provides APIs to create new tag metadata in backend. Using this API, you can create a new tag metadata by giving key, value and related tag id. The metadata may be used to store contextual and optional data about a tag.

Request

{
    "Key":"SampleMetadataKey",
    "Value":"Sample Metadata Value",
    "TagId":1
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/private/catalog/tagmetadata

Request Body Description

Parameter Name Description Type Conditions
TagId The Id of the tag which the metadata belongs to. Number
Required
Required
Key The key for the metadata. String
Required
Value The value of the metadata. 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

{
    "Key":"SampleMetadataKey",
    "Value":"Sample Metadata Value",
    "TagId":1,
}

Response Body Description

Parameter Name Description Type
TagId The Id of the tag which the metadata belongs to. Number
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) Given tag could not be found in our backend.
409 (Conflict) Given tag metadata already exists.