Read a Published Taxonomy

get

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

Returns published taxonomy. A taxonomy is uniquely identified by an id.
Each published taxonomy has the following information:
  1. Standard fields: These are fields created by the system.
    • id: ID of the taxonomy.
    • name: Name of the taxonomy.
    • description : Description of the taxonomy.
    • shortName: Short name of the taxonomy.
    • customProperties: Custom properties defined for the taxonomy.
    • updatedDate : Last published date of the taxonomy on the channel requested.

  2. Request Headers (Optional) :
    Header NameHeader Value
    channelToken{valid channel token value}
    Acceptapplication/json

Request

Path Parameters
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.
Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : Taxonomy
Type: object
Taxonomy
Show Source
Nested Schema : date
Type: object
date
Show Source
Nested Schema : customProperties
Type: object
Additional Properties Allowed
Show Source
Custom properties of the taxonomy. This consists of a name-value pairs defined by the user.

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 a published taxonomies.

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

This reads published taxonomy with id: 1143EFDC17EC47318DFA55D04F098433, channelToken: 986bc783d8c8452c813b7cf92dde0322.

/content/published/api/v1.1/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=986bc783d8c8452c813b7cf92dde0322

Response Body

{
        "id": "1143EFDC17EC47318DFA55D04F098433",
        "name": "allChannels-taxonomyPublished-1-Test1261401333683001",
        "description": "Taxonomy Description - 1",
        "shortName": "ALL",
        "createdDate": {
          "value": "2020-07-08T13:17:09.162Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2020-07-08T13:17:58.289Z",
          "timezone": "UTC"
        },
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=986bc783d8c8452c813b7cf92dde0322",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=986bc783d8c8452c813b7cf92dde0322",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=986bc783d8c8452c813b7cf92dde0322",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }
Back to Top