Jump to

• Request
• Response
• Examples

Preview taxonomies and categories of an item by slug

get

/content/preview/api/v1.1/items/.by.slug/{slug}/taxonomies

Lists all promoted versions of taxonomies and categories of an item targeted to the specific channel by slug.

Request

Path Parameters

• slug: string
  Slug value of the item to be previewed.

Query Parameters

• channelToken(optional): string
  Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.
• links(optional): string
  Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
  Example: links=self,canonical will only return the links with the rel property self or canonical.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : TaxonomiesBean

Type: object

Show Source

• items(optional): array items
  Item taxonomies.
• links(optional): array links
  Resource links.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Item taxonomies.",
            "items":{
                "$ref":"#/definitions/TaxonomyItem"
            }
        },
        "links":{
            "type":"array",
            "description":"Resource links.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Item taxonomies.

Show Source

• Array of: object TaxonomyItem
  TaxonomyItem

{
    "type":"array",
    "description":"Item taxonomies.",
    "items":{
        "$ref":"#/definitions/TaxonomyItem"
    }
}

Nested Schema : links

Type: array

Resource links.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Resource links.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : TaxonomyItem

Type: object

TaxonomyItem

Show Source

• categories(optional): object TaxonomyCategories
  CategoriesBean
• id(optional): string
  The id of the taxonomy.
• links(optional): array links
• name(optional): string
  The name of the taxonomy
• shortName(optional): string
  The short name of the taxonomy

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the taxonomy."
        },
        "name":{
            "type":"string",
            "description":"The name of the taxonomy"
        },
        "shortName":{
            "type":"string",
            "description":"The short name of the taxonomy"
        },
        "categories":{
            "description":"The categories of the taxonomy",
            "$ref":"#/definitions/TaxonomyCategories"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"TaxonomyItem"
}

Nested Schema : TaxonomyCategories

Type: object

CategoriesBean

Show Source

• items(optional): array items
  Taxonomy Categories

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Taxonomy Categories",
            "items":{
                "$ref":"#/definitions/CategoryItem"
            }
        }
    },
    "description":"CategoriesBean"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : items

Type: array

Taxonomy Categories

Show Source

• Array of: object CategoryItem
  CategoryItem

{
    "type":"array",
    "description":"Taxonomy Categories",
    "items":{
        "$ref":"#/definitions/CategoryItem"
    }
}

Nested Schema : CategoryItem

Type: object

CategoryItem

Show Source

• apiName(optional): string
  The apiName of the category
• id(optional): string
  The id of the category.
• links(optional): array links
• name(optional): string
  The name of the category
• nodes(optional): array nodes
  The nodes of the category assigned to the item.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the category."
        },
        "name":{
            "type":"string",
            "description":"The name of the category"
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the category"
        },
        "nodes":{
            "type":"array",
            "description":"The nodes of the category assigned to the item.",
            "items":{
                "$ref":"#/definitions/CategoryNodeItem"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"CategoryItem"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : nodes

Type: array

The nodes of the category assigned to the item.

Show Source

• Array of: object CategoryNodeItem
  CategoryNodeBean

{
    "type":"array",
    "description":"The nodes of the category assigned to the item.",
    "items":{
        "$ref":"#/definitions/CategoryNodeItem"
    }
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Nested Schema : CategoryNodeItem

Type: object

CategoryNodeBean

Show Source

• apiName(optional): string
  The apiName of the Category node.
• id(optional): string
  The id of the Category node.
• name(optional): string
  The name of the Category node.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category node."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category node."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category node."
        }
    },
    "description":"CategoryNodeBean"
}

400 Response

Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing.

403 Response

Forbidden. Client is not authorized to perform this request.

404 Response

The requested resource was not found.

500 Response

Internal server error. An unexpected error condition encountered in the system.

Back to Top

Examples

Example:

The following example shows how to preview taxonomies of an item by it's slug by submission of a GET request on the REST resource using cURL:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/preview/api/v1.1/items/.by.slug/1481786136832-item1_taxonomiesresource595040100700008/taxonomies?channelToken=0a17fa56b37d40f1bbe31751364f765acontent/preview/api/v1.1/items/.by.slug/1481786136832-item1_taxonomiesresource595040100700008/taxonomies?channelToken=0a17fa56b37d40f1bbe31751364f765a'

This reads taxonomies of an item with slug: 1481786136832-item1_taxonomiesresource595040100700008, channelToken:0a17fa56b37d40f1bbe31751364f765a.

Response Body

{
        "items": [
          {
            "id": "5AD662150C07403FA5D76064ECA7D810",
            "name": "Test594336500988006-taxonomyCars-assetExpand",
            "shortName": "T28",
            "categories": {
              "items": [
                {
                  "id": "1666060BA6DE45F09D368C5A4DD851E3",
                  "name": "Car two doors",
                  "apiName": "t28-c-c1",
                  "nodes": [
                    {
                      "id": "AC1D8DDB67BE44FA8F7FCF7747769AC9",
                      "name": "Car intermediate",
                      "apiName": "t28-c1"
                    },
                    {
                      "id": "1666060BA6DE45F09D368C5A4DD851E3",
                      "name": "Car two doors",
                      "apiName": "t28-c-c1"
                    }
                  ],
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/api/v1.1/taxonomies/5AD662150C07403FA5D76064ECA7D810/categories/1666060BA6DE45F09D368C5A4DD851E3?channelToken=0a17fa56b37d40f1bbe31751364f765a",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "application/json"
                    }
                  ]
                },
                {
                  "id": "ABF9C120EBAC4753BAE89CA89AC9F7D6",
                  "name": "car two doors",
                  "apiName": "t28-c-c",
                  "nodes": [
                    {
                      "id": "774EC8B9839B4D7392C10F005654C47D",
                      "name": "car small",
                      "apiName": "t28-c"
                    },
                    {
                      "id": "ABF9C120EBAC4753BAE89CA89AC9F7D6",
                      "name": "car two doors",
                      "apiName": "t28-c-c"
                    }
                  ],
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/api/v1.1/taxonomies/5AD662150C07403FA5D76064ECA7D810/categories/ABF9C120EBAC4753BAE89CA89AC9F7D6?channelToken=0a17fa56b37d40f1bbe31751364f765a",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "application/json"
                    }
                  ]
                }
              ]
            },
            "links": [
              {
                "href": "https://<hostname>/content/preview/api/v1.1/taxonomies/5AD662150C07403FA5D76064ECA7D810?channelToken=0a17fa56b37d40f1bbe31751364f765a",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/.by.slug/1481786136832-item1_taxonomiesresource595040100700008/taxonomies?channelToken=0a17fa56b37d40f1bbe31751364f765a",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/.by.slug/1481786136832-item1_taxonomiesresource595040100700008/taxonomies?channelToken=0a17fa56b37d40f1bbe31751364f765a",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog/items/.by.slug/1481786136832-item1_taxonomiesresource595040100700008/taxonomies?channelToken=0a17fa56b37d40f1bbe31751364f765a",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

Back to Top