XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The tag management systems provides APIs to fetch a full list of tags from the backend. Tags are used by catalog APIs to filter catalog items.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/catalog/tag?skip={skip}&take={take}&includeMetadata={includeMetadata}

URI Parameters

Parameter Name Description Type Conditions
skip The number of items in the collection to skip before executing a select. Number
take The number of items that should be fetched from the collection. Number
includeMetadata Boolean field indicating if the tag collection returned from API contains tag metadata collection or doesn’t. Boolean

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": {
        "Results": [
            {
                "Id": 1,
                "Name": "Sample Tag 0",
                "Description": "Sample Tag O Description",
                "TagMetadata": [
                    {
                        "Key": "tagmetadatakey0",
                        "Value": "tagmetadatavalue0"
                    },
                    {
                        "Key": "tagmetadatakey1",
                        "Value": "tagmetadatavalue1"
                    },
                    {
                        "Key": "tagmetadatakey3",
                        "Value": "tagmetadatavalue3"
                    },
                ]
            },
            {
                "Id": 2,
                "Name": "Sample Tag 1",
                "Description": "Sample Tag 1 Description",
                "TagMetadata": [
                    {
                        "Key": "tagmetadatakey0",
                        "Value": "tagmetadatavalue0"
                    },
                    {
                        "Key": "tagmetadatakey1",
                        "Value": "tagmetadatavalue1"
                    },
                    {
                        "Key": "tagmetadatakey6",
                        "Value": "tagmetadatavalue6"
                    },
                ]
            }
        ],
        "TotalCount": 100
    }
}

Response Body Description

Parameter Name Description Type
Data.TotalCount Total count of the items in filtered collection without paging. Number
Data.Results[0..N].Id The unique ID of the tag. Number
Data.Results[0..N].Name The name of the tag. String
Data.Results[0..N].Description The description of the tag. String
Data.Results[0..N].TagMetadata[0..N].Key The key for the metadata. String
Data.Results[0..N].TagMetadata[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
400 (Bad Request) Skip and/or take parameters are malformed.