List Taxonomies
get
/content/published/api/v1.1/taxonomies
Returns all published taxonomies.
Request
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 taxonomy's response. Accepts a comma-separated list of field names or all. This field is currently ignored.
-
limit(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the size of the result. The maximum value allowed for limit is 500.Default Value:
100
-
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, first, last, prev, next.
Example: links=self,canonical will only return the links with the rel property self or canonical. -
offset(optional): integer(int32)
Start index of response rows.Default Value:
0
-
orderBy(optional): string
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. -
totalResults(optional): boolean
Accepts a Boolean value. Setting it to true displays the total results field in the response.Default Value:
false
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : CollectionProperties
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: additionalPropertiesadditional 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.)
Nested Schema : links
Type:
array
Links of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
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 : items
Type:
object
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.
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.
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" } ] }