XOMNI: Experience Omni-Channel

Last Updated: February 19, 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/private/catalog/tag?skip={skip}&take={take}

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

Request Headers

Header Field Name Description
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

    {
    "Results":[
       {
           "Id":1,
           "Name":"Sample Tag 0",
           "Description":"64236e87-6a9f-4d64-ba12-6fbe277ebfd3",
           "TagMetadata":[
              {
                  "Key":"Key1",
                  "Value":"83b5ce23-827e-404b-81a7-03fc5d066e0a",
              },
              {
                  "Key":"Key2",
                  "Value":"f1777570-a324-4418-8d68-2bf57b26783f",
              },
              {
                  "Key":"Key3",
                  "Value":"8a6c0d95-63b1-41bd-a607-26d330ddeaca",
              },
              {
                  "Key":"Key4",
                  "Value":"28ed938b-e104-47d8-bdbb-dd05d7627405",
              },
              {
                  "Key":"Key5",
                  "Value":"8d96d70b-be02-47cc-8079-986a9bd4f56f",
              }
           ]
       },
       {
           "Id":2,
           "Name":"Sample Tag 1",
           "Description":"c2723d49-2a50-4314-a003-719c18019db0",
           "TagMetadata":[
              {
                  "Key":"Key1",
                  "Value":"da2c628b-f111-4b9d-8c8d-f51074271159",
              },
              {
                  "Key":"Key2",
                  "Value":"e57ae1fa-b3e9-49b2-92c1-5e8d8aa98ac9",
              },
              {
                  "Key":"Key3",
                  "Value":"c10e685d-7da6-44fc-bbc9-30fe62d2dccb",
              },
              {
                  "Key":"Key4",
                  "Value":"18fa80e6-a7ec-417b-90ee-f4ea80fb327e",
              },
              {
                  "Key":"Key5",
                  "Value":"082e8008-7c10-4681-9797-d7f02176de10",
              }
           ]
       },
       {
           "Id":3,
           "Name":"Sample Tag 2",
           "Description":"b7819f7b-7bf1-476d-bd70-c56c8cda2705",
           "TagMetadata":[
              {
                  "Key":"Key1",
                  "Value":"748dde4e-8822-48c3-b402-0831da9ee06e",
              },
              {
                  "Key":"Key2",
                  "Value":"84aebede-53ca-4b9a-830b-12893a8f553b",
              },
              {
                  "Key":"Key3",
                  "Value":"9781f7ca-20fd-4430-a174-1bbbad054a4d",
              },
              {
                  "Key":"Key4",
                  "Value":"a28b0d88-e9d8-41dd-90b5-89402c358d2c",
              },
              {
                  "Key":"Key5",
                  "Value":"9fef756c-6e4d-4878-9d9a-e10d44f0297f",
              }
           ]
       }
    ],
    "TotalCount":10
} 

Response Body Description

Parameter Name Description Type
TotalCount Total count of the items in filtered collection without paging. Number
Results[0..N].Id The unique ID of the tag. Number
Results[0..N].Name The name of the tag. String
Results[0..N].Description The description of the tag. String
Results[0..N].TagMetadata[0..N].Key The key for the metadata. String
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.