Jump to

• Request
• Response
• Examples

Read a Published Category

get

/content/published/api/v1.1/taxonomies/{id}/categories/{categoryId}

Returns published category. A category is uniquely identified by an id.
Each published category has the following information:

1. Standard fields: These are fields created by the system.
   
   • id: ID of the category.
   • name: Name of the category.
   • description : Description of the category.
   • parent: Parent of the category.
   • ancestors: Ancestors of the category. Each position in this array represents an ancestor category from first to last position. First category in the array represents the root category and the last category in the array represents the immediate parent of the requested resource.
2. Additional fields: These fields are not included by default in the response.
   
   • keywords: A comma-separated list of values assigned to the keywords system managed category property.
   • synonyms: A comma-separated list of values assigned to the synonyms system managed category property.
   • relatedCategories: A list where each element represents a category that is related to the current category. Note that this field only shows the categories published to the same channel as the current category.
   • customProperties: Category property values for the user defined category properties. Note that this field only shows the category property values of the publishable category properties.

Request Headers (Optional) :

Header Name	Header Value
channelToken	{valid channel token value}
Accept	application/json

Request

Path Parameters

• categoryId: string
  Unique identifier (ID) for a category.
• id: string
  Unique identifier (ID) of a taxonomy.

Query Parameters

• channelToken(optional): string
  Channel token of the publish target. A channel token must be provided as either a query parameter or a request header.
• expand(optional): string
  Expand parameter provides the option of getting child resources (referenced items) inline with the category's response. Accepts a comma-separated list of field names or all. Field names are case-sensitive. When expand is specified as all (with all in lower case), all the fields of the requested category are expanded. When expand is not specified, the category response contains links to the referenced children. Expansion of this form is supported for one level only. When the expand parameter contains a nonexistent field as per category definition, the resource produces HTTP 400.
  
  Example : expand=children
  Returns children categories sorted by their respective position ascending. This sort order cannot be changed in this request.
  Example : expand=all
  Returns child resources (children) available for this category. Only the first 1000 children categories will be expanded.
• fields(optional): string
  This parameter is used to control the returned fields for a category. This parameter accepts a comma-separated list of field names. As all the field names are case-sensitive, users must provide the correct field names in the query. A category has both standard fields (id, name, description, position, parentId) and additional fields (keywords, synonyms, relatedCategories, customProperties). The standard fields are always returned in the response and cannot be filtered out. Users can only filter out the additional fields. This parameter is optional in the query and by default results shows only standard fields in the response. Any incorrect or invalid field name given in the query will result in an error.
  
  Example: ?fields=keywords
  This returns all standard fields along with the keywords additional field for the category.
  
• 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 : CategoryInformation

Type: object

Category Information

Show Source

• ancestors(optional): array ancestors
  The ancestors of the Category. First element represents the root category and the last element represents the immediate parent of the category.
• apiName(optional): string
  The apiName of the Category.
• children(optional): object CollectionPropertiesCategoryChildBean
  CollectionProperties.
• customProperties(optional): object customProperties
  Additional Properties Allowed: CustomPropertyValuesBean

  The custom properties' values of the Category.
• description(optional): string
  The description of the Category.
• id(optional): string
  The id of the Category.
• keywords(optional): array keywords
  The keywords of the Category.
• links(optional): array links
  Links
• name(optional): string
  The name of the Category.
• parent(optional): object CategoryAncestorBean
• position(optional): integer(int32)
  Minimum Value: 0

  The position of the Category among its siblings.
• relatedCategories(optional): array relatedCategories
  The related categories of the Category.
• synonyms(optional): array synonyms
  The synonyms of the Category.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category."
        },
        "description":{
            "type":"string",
            "description":"The description of the Category."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category."
        },
        "position":{
            "type":"integer",
            "format":"int32",
            "description":"The position of the Category among its siblings.",
            "minimum":0
        },
        "parent":{
            "description":"The parent of the Category.",
            "$ref":"#/definitions/CategoryAncestorBean"
        },
        "ancestors":{
            "type":"array",
            "description":"The ancestors of the Category. First element represents the root category and the last element represents the immediate parent of the category.",
            "items":{
                "$ref":"#/definitions/CategoryAncestorBean"
            }
        },
        "children":{
            "description":"The children of the Category. Children categories are sorted by position starting from lowest to highest value. Only the first 1000 children categories will be expanded.",
            "$ref":"#/definitions/CollectionPropertiesCategoryChildBean"
        },
        "keywords":{
            "type":"array",
            "description":"The keywords of the Category.",
            "items":{
                "type":"string"
            }
        },
        "synonyms":{
            "type":"array",
            "description":"The synonyms of the Category.",
            "items":{
                "type":"string"
            }
        },
        "relatedCategories":{
            "type":"array",
            "description":"The related categories of the Category.",
            "items":{
                "$ref":"#/definitions/RelatedCategory"
            }
        },
        "customProperties":{
            "type":"object",
            "description":"The custom properties' values of the Category.",
            "additionalProperties":{
                "$ref":"#/definitions/CustomPropertyValuesBean"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Category Information"
}

Nested Schema : ancestors

Type: array

The ancestors of the Category. First element represents the root category and the last element represents the immediate parent of the category.

Show Source

• Array of: object CategoryAncestorBean

{
    "type":"array",
    "description":"The ancestors of the Category. First element represents the root category and the last element represents the immediate parent of the category.",
    "items":{
        "$ref":"#/definitions/CategoryAncestorBean"
    }
}

Nested Schema : CollectionPropertiesCategoryChildBean

Type: object

CollectionProperties.

Show Source

• aggregationResults(optional): array aggregationResults
  Aggregation results.
• count(optional): integer(int32)
  Total number of records in the current response.
• hasMore(optional): boolean
  Check whether there are more pages to fetch.
• items(optional): array items
  Singular resources contained in the collection.
• limit(optional): integer(int32)
  Actual page size used by the server. This might not be the same as what the client requests.
• links(optional): array links
  Links of the resource.
• offset(optional): integer(int32)
  The actual index from which the singular resources are returned.
• pinned(optional): array pinned
  Pinned items. Shows items pinned at the top of search list
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties

  additional collection properties.
• scrollId(optional): string
  scrollId if the search resolved to a scroll search.
• totalResults(optional): integer(int32)
  Total number of rows that satisfy the client request (excluding the paging parameters.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "properties":{
            "type":"object",
            "description":"additional collection properties.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/CategoryChildBean"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"CollectionProperties."
}

Nested Schema : customProperties

Type: object

Additional Properties Allowed

Show Source

• object CustomPropertyValuesBean

{
    "type":"object",
    "description":"The custom properties' values of the Category.",
    "additionalProperties":{
        "$ref":"#/definitions/CustomPropertyValuesBean"
    }
}

The custom properties' values of the Category.

Nested Schema : keywords

Type: array

The keywords of the Category.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The keywords of the Category.",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : CategoryAncestorBean

Type: object

Show Source

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

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

Nested Schema : relatedCategories

Type: array

The related categories of the Category.

Show Source

• Array of: object RelatedCategory
  Related Category

{
    "type":"array",
    "description":"The related categories of the Category.",
    "items":{
        "$ref":"#/definitions/RelatedCategory"
    }
}

Nested Schema : synonyms

Type: array

The synonyms of the Category.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The synonyms of the Category.",
    "items":{
        "type":"string"
    }
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

• Array of: object CategoryChildBean

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/CategoryChildBean"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"additional collection properties.",
    "additionalProperties":{
        "type":"object"
    }
}

additional collection properties.

Nested Schema : AggregationResult

Type: object

Show Source

• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : CategoryChildBean

Type: object

Show Source

• apiName(optional): string
  The apiName of the child Category.
• description(optional): string
  The description of the child Category.
• id(optional): string
  The id of the child Category.
• links(optional): array links
  Links
• name(optional): string
  The name of the child Category.
• position(optional): integer(int32)
  Minimum Value: 0

  The position of the child Category among its siblings.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the child Category."
        },
        "name":{
            "type":"string",
            "description":"The name of the child Category."
        },
        "description":{
            "type":"string",
            "description":"The description of the child Category."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the child Category."
        },
        "position":{
            "type":"integer",
            "format":"int32",
            "description":"The position of the child Category among its siblings.",
            "minimum":0
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

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

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

Type: object

Nested Schema : CustomPropertyValuesBean

Type: object

Show Source

• values(optional): array values
  The list of values of the custom property.

{
    "type":"object",
    "properties":{
        "values":{
            "type":"array",
            "description":"The list of values of the custom property.",
            "items":{
                "$ref":"#/definitions/CustomPropertyValue"
            }
        }
    }
}

Nested Schema : values

Type: array

The list of values of the custom property.

Show Source

• Array of: object CustomPropertyValue

{
    "type":"array",
    "description":"The list of values of the custom property.",
    "items":{
        "$ref":"#/definitions/CustomPropertyValue"
    }
}

Nested Schema : CustomPropertyValue

Type: object

Show Source

• id(optional): string
  Read Only: true

  The id of the custom property value.
• value(optional): string
  The value of the custom property.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the custom property value.",
            "readOnly":true
        },
        "value":{
            "type":"string",
            "description":"The value of the custom property."
        }
    }
}

Nested Schema : RelatedCategory

Type: object

Related Category

Show Source

• apiName(optional): string
  The apiName of the category.
• id(optional): string
  The id of the category.
• name(optional): string
  The name of the category.
• nodes(optional): array nodes
  The path of the category.
• taxonomy(optional): object RelatedTaxonomyBean

{
    "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."
        },
        "taxonomy":{
            "description":"The taxonomy of the category.",
            "$ref":"#/definitions/RelatedTaxonomyBean"
        },
        "nodes":{
            "type":"array",
            "description":"The path of the category.",
            "items":{
                "$ref":"#/definitions/CategoryNodeItem"
            }
        }
    },
    "description":"Related Category"
}

Nested Schema : nodes

Type: array

The path of the category.

Show Source

• Array of: object CategoryNodeItem
  CategoryNodeBean

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

Nested Schema : RelatedTaxonomyBean

Type: object

Show Source

• id(optional): string
  The id of the taxonomy.
• 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."
        }
    }
}

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

304 Response

Not changed. The request honors requests with e-tag.

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

The following example shows how to read published taxonomy category.

curl -i -X GET -H "Accept:application/json" 'http://<hostname>/content/published/api/v1.1/taxonomies/{id}/categories/{categoryId}'

Example

Searches published taxonomy category with taxonomy id: 26950D77A5654D8BA407AC9F7DBCFF1F, having category id: 2069018ECE874C2DAA4051E9C16AD244 with channelToken: 1a3885a5a75b40baafe6495eb0b1125b.

/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories/5096C5762F9540BCB23AA13001CA872E?channelToken=1a3885a5a75b40baafe6495eb0b1125b

Response Body

{
        "id": "5096C5762F9540BCB23AA13001CA872E",
        "name": "car blue",
        "description": "car description",
        "apiName": "t31-car-blue-26950d77a5654d8ba407ac9f7dbcff1f",
        "position": 1,
        "parent": {
          "id": "6775D3D56E184CC3B8EC59A32AF1DD73",
          "name": "car",
          "apiName": "t31-c"
        },
        "ancestors": [
          {
            "id": "6775D3D56E184CC3B8EC59A32AF1DD73",
            "name": "car",
            "apiName": "t31-c"
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories/5096C5762F9540BCB23AA13001CA872E?channelToken=1a3885a5a75b40baafe6495eb0b1125b",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories/5096C5762F9540BCB23AA13001CA872E?channelToken=1a3885a5a75b40baafe6495eb0b1125b",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories/5096C5762F9540BCB23AA13001CA872E?channelToken=1a3885a5a75b40baafe6495eb0b1125b",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }       

Back to Top