Jump to

• Request
• Response
• Examples

Preview of a taxonomy

get

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

Returns promoted version of taxonomy if its published to the specified channel. 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.

Request Headers:


Is required	Header Name	Header Value
Required	channelToken	{valid channel token value}
Optional	Accept	application/json

Request

Path Parameters

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

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.
• expand(optional): string
  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.
• 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 : Taxonomy

Type: object

Taxonomy

Show Source

• createdDate(optional): object date
  date
• customProperties(optional): object customProperties
  Additional Properties Allowed: additionalProperties

  Custom properties of the taxonomy. This consists of a name-value pairs defined by the user.
• description(optional): string
  The description of the taxonomy.
• id(optional): string
  The id of the taxonomy.
• links(optional): array links
  Links
• name(optional): string
  The name of the taxonomy.
• shortName(optional): string
  The short name of the taxonomy.
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the taxonomy."
        },
        "name":{
            "type":"string",
            "description":"The name of the taxonomy."
        },
        "description":{
            "type":"string",
            "description":"The description of the taxonomy."
        },
        "shortName":{
            "type":"string",
            "description":"The short name of the taxonomy."
        },
        "customProperties":{
            "type":"object",
            "description":"Custom properties of the taxonomy. This consists of a name-value pairs defined by the user.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "createdDate":{
            "description":"Created date of the taxonomy.",
            "$ref":"#/definitions/date"
        },
        "updatedDate":{
            "description":"Last updated date of the taxonomy.",
            "$ref":"#/definitions/date"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Taxonomy"
}

Nested Schema : date

Type: object

date

Show Source

• description(optional): string
• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    },
    "description":"date"
}

Nested Schema : customProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Custom properties of the taxonomy. This consists of a name-value pairs defined by the user.",
    "additionalProperties":{
        "type":"string"
    }
}

Custom properties of the taxonomy. This consists of a name-value pairs defined by the user.

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

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

Example:

The following example shows how to preview a taxonomy published to the specified channel 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/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=986bc783d8c8452c813b7cf92dde0322'

This previews published taxonomy with id: 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/preview/api/v1.1/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=986bc783d8c8452c813b7cf92dde0322",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=986bc783d8c8452c813b7cf92dde0322",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=986bc783d8c8452c813b7cf92dde0322",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }
   

Back to Top