Jump to

• Request
• Response
• Examples

List all Taxonomies and Categories of an Item

get

/content/management/api/v1.1/items/{id}/taxonomies

Lists all Taxonomies and Categories of a given item.

Request

Path Parameters

• id: string
  id of the item.

Query Parameters

• links(optional): string
  This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : ItemSubResourceListTaxonomyId

Type: object

Taxonomies

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaxonomyInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Taxonomies"
}

Nested Schema : data

Type: array

Show Source

• Array of: object TaxonomyInfo
  TaxonomyInfo

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : TaxonomyInfo

Type: object

TaxonomyInfo

Show Source

• categories(optional): array categories
  Categories in the Taxonomy the item belongs to.
• id(optional): string
• links(optional): array links
• name(optional): string
• shortName(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "shortName":{
            "type":"string"
        },
        "categories":{
            "type":"array",
            "description":"Categories in the Taxonomy the item belongs to.",
            "items":{
                "$ref":"#/definitions/ItemCategoryInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"TaxonomyInfo"
}

Nested Schema : categories

Type: array

Categories in the Taxonomy the item belongs to.

Show Source

• Array of: object ItemCategoryInfo

{
    "type":"array",
    "description":"Categories in the Taxonomy the item belongs to.",
    "items":{
        "$ref":"#/definitions/ItemCategoryInfo"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : ItemCategoryInfo

Type: object

Show Source

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

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

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

Nodes in the category assigned to the item.

Show Source

• Array of: object CategoryNodeBean

{
    "type":"array",
    "description":"Nodes in the category assigned to the item.",
    "items":{
        "$ref":"#/definitions/CategoryNodeBean"
    }
}

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 : CategoryNodeBean

Type: object

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."
        }
    }
}

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top

Examples

The following example shows how to get the taxonomy information of an item by submitting a GET request using cURL.

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/items/{id}/taxonomies'

Example:

This reads the taxonomy information of the item ID: COREB423D3839C634CD485B76C696E58C41F.

/content/management/api/v1.1/items/COREB423D3839C634CD485B76C696E58C41F/taxonomies

Response Body

{
        "data": [
          {
            "id": "6A9A52CD216947E3875DC77576AB94BD",
            "name": "Taxonomy 1",
            "categories": [
              {
                "id": "EF4AD29B52E44BBB8DC3F3BC1673202B",
                "name": "C4"
              },
              {
                "id": "1B58D48E8FB048E09B7E0E2660313D89",
                "name": "C4.2"
              }
            ],
            "shortName": "TAX"
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/COREB423D3839C634CD485B76C696E58C41F/taxonomies",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
 }

Back to Top