List Taxonomies

get

/content/published/api/v1.1/taxonomies

Returns all published taxonomies.

Request

Query Parameters
  • Channel token of the publish target. A channel token must be provided as either a query parameter or a request header.
  • Expand parameter provides the option of getting child resources (referenced items) inline with the taxonomy's response. Accepts a comma-separated list of field names or all. This field is currently ignored.
  • Number of rows to return.
    Default Value: 100
  • Start index of response rows.
    Default Value: 0
  • The orderBy parameter is used to control the order (ascending or descending) of queried taxonomies. This parameter is optional in the query and by default there is no order of results. This parameter accepts field names separated by a colon (:), which the user wants to sort the results and sort order.
    format: orderBy={fieldName}:{asc/des} (*Note: asc stands for ascending and des for descending. asc and des are always in lower case.)
    Field names can be name, createdDate, updatedDate (standard fields). The sort order is optional and by default it is ascending. Any incorrect or invalid field name given in the query will be ignored.

    Example: orderBy=name:asc
    Returns all the taxonomies in the ascending order of name.
    Example: orderBy=updatedDate:asc
    Returns all the taxonomies in the ascending order of updatedDate.
  • Accepts a Boolean value. Setting it to true displays the total results field in the response.
    Default Value: false
Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : CollectionProperties
Type: object
CollectionProperties.
Show Source
Nested Schema : aggregationResults
Type: array
Aggregation results.
Show Source
Nested Schema : items
Type: array
Singular resources contained in the collection.
Show Source
Nested Schema : pinned
Type: array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
additional collection properties.
Nested Schema : AggregationResult
Type: object
Show Source
Nested Schema : items
Type: object
Nested Schema : additionalProperties
Type: object

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.

500 Response

Internal server error. An unexpected error condition encountered in the system.
Back to Top

Examples

The following example shows how to list published taxonomies.

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

This lists published taxonomies with channelToken: c17cc9115c844500adcdb76557732b84.

/content/published/api/v1.1/taxonomies?totalResults=true&offset=0&channelToken=c17cc9115c844500adcdb76557732b84

Response Body

{
        "hasMore": false,
        "offset": 0,
        "count": 2,
        "limit": 100,
        "totalResults": 2,
        "items": [
          {
            "id": "1143EFDC17EC47318DFA55D04F098433",
            "name": "allChannels-taxonomyPublished-1-Test1261401333683001",
            "description": "Taxonomy Description - 1",
            "shortName": "ALL",
            "createdDate": {
              "value": "2020-07-08T13:17:58.265Z",
              "timezone": "UTC"
            },
            "updatedDate": {
              "value": "2020-07-08T13:17:58.265Z",
              "timezone": "UTC"
            },
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=c17cc9115c844500adcdb76557732b84",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          {
            "id": "AAD120D5F976401384908E2E25ACCB62",
            "name": "twoChannels-taxonomyPublished-2-Test1261401333683001",
            "description": "Taxonomy Description - 2",
            "shortName": "TWO",
            "createdDate": {
              "value": "2020-07-08T13:18:14.091Z",
              "timezone": "UTC"
            },
            "updatedDate": {
              "value": "2020-07-08T13:18:14.091Z",
              "timezone": "UTC"
            },
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/taxonomies/AAD120D5F976401384908E2E25ACCB62?channelToken=c17cc9115c844500adcdb76557732b84",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies?channelToken=c17cc9115c844500adcdb76557732b84&totalResults=true&offset=0",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies?channelToken=c17cc9115c844500adcdb76557732b84&totalResults=true&offset=0",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/taxonomies?channelToken=c17cc9115c844500adcdb76557732b84",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies?channelToken=c17cc9115c844500adcdb76557732b84&totalResults=true&offset=0",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies?channelToken=c17cc9115c844500adcdb76557732b84&totalResults=true&offset=0",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }
Back to Top