Taxonomy

The EqualAndBelow method retrieves all entries for a specific taxonomy that match a specific term and its descendant terms, requiring only the target term.

Note This query is applicable for the stack.Taxonomies() and stack.ContentType('uid').Query() methods.

Example

ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "environment");
Taxonomy csQuery = stack.Taxonomies();

csQuery.EqualAndBelow("taxonomies.taxonomy_uid", "term_uid");
csQuery.Find<Product>().ContinueWith((queryResult) => {
	//Your callback code.
});

The Below method retrieves all entries for a specific taxonomy that match all of their descendant terms by specifying only the target term and a specific level.

Note If you don't specify the level, the default behavior is to retrieve terms up to level 10.

Example

ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "environment");
Taxonomy csQuery = stack.Taxonomies();

csQuery.Below("taxonomies.taxonomy_uid", "term_uid");
csQuery.Find<Product>().ContinueWith((queryResult) => {
	//Your callback code.
});

The EqualAndAbove method retrieves all entries for a specific taxonomy that match a specific term and all its ancestor terms, requiring only the target term and a specified level.

Note If you don't specify the level, the default behavior is to retrieve terms up to level 10.

Example

ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "environment");
Taxonomy csQuery = stack.Taxonomies();

csQuery.EqualAndAbove("taxonomies.taxonomy_uid", "term_uid");
csQuery.Find<Product>().ContinueWith((queryResult) => {
	//Your callback code.
});

The Above method retrieves all entries for a specific taxonomy that match only the parent terms of a specified target term, excluding the target term itself and a specified level.

Note If you don't specify the level, the default behavior is to retrieve terms up to level 10.

Example

ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "environment");
Taxonomy csQuery = stack.Taxonomies();

csQuery.Above("taxonomies.taxonomy_uid", "term_uid");
csQuery.Find<Product>().ContinueWith((queryResult) => {
	//Your callback code.
});

The SetLocale method sets the locale for the taxonomy fetch request. Passing a null or empty value is treated as a no-op. Chain this method before calling Fetch.

Validation

No exception is thrown for a null or empty locale. It's treated as a no-op.

Behavior

Client-side only. Sets a pending query parameter. No HTTP call is made until Fetch is called.

Example

ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "environment");
var taxonomy = await stack.Taxonomies("taxonomy_uid").SetLocale("hi-in").Fetch<MyTaxonomy>();

The IncludeFallback method falls back to the master locale when the taxonomy is not published in the requested locale. It can be used with or without SetLocale. Chain this method before calling Fetch.

Validation

Takes no parameters, so there's nothing to validate.

Behavior

Client-side only. Unconditionally sets include_fallback=true as a pending query parameter. No HTTP call is made until Fetch is called.

Example

ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "environment");
var taxonomy = await stack.Taxonomies("taxonomy_uid").SetLocale("hi-in").IncludeFallback().Fetch<MyTaxonomy>();

The AddParam method adds a custom query parameter to the taxonomy fetch request. Chain this method before calling Fetch.

Validation

No SDK-level null check is performed on key or value.

Behavior

Client-side only. Sets an arbitrary pending query parameter. No HTTP call is made until Fetch is called.

Example

ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "environment");
var taxonomy = await stack.Taxonomies("taxonomy_uid").AddParam("include_branch", "true").Fetch<MyTaxonomy>();

The Fetch method fetches a published taxonomy by its UID from the CDA. It requires the taxonomy to have been initialized via stack.Taxonomies("uid"). Use SetLocale, IncludeFallback, and AddParam to configure the request before calling Fetch.

Validation

Throws TaxonomyException if the Taxonomy was created through the zero-arg Taxonomies() (no UID set), because Fetch needs a specific taxonomy to request. See Delivery API Errors for general request errors.

Behavior

Makes one HTTP GET request to /taxonomies/{uid}. The response is unwrapped at the $.taxonomy JSON token before deserializing to T, falling back to the raw response object if that token is absent.

Example

ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "environment");
var taxonomy = await stack.Taxonomies("taxonomy_uid").Fetch<MyTaxonomy>();
var localized = await stack.Taxonomies("taxonomy_uid").SetLocale("hi-in").Fetch<MyTaxonomy>();
var withFallback = await stack.Taxonomies("taxonomy_uid").SetLocale("hi-in").IncludeFallback().Fetch<MyTaxonomy>();

The Find method fetches all published taxonomies from the CDA. It is valid only on an unscoped Taxonomy instance, created via stack.Taxonomies() with no UID. Use AddParam (for example, "skip", "limit", "include_count") to configure pagination before calling Find.

Validation

Throws TaxonomyException if the Taxonomy was created through Taxonomies(uid) (a UID was set), because Find lists taxonomies in general and does not operate on a single taxonomy.

Behavior

Makes one HTTP GET request to /taxonomies. The response is unwrapped at the $.taxonomies JSON token into the returned collection's Items.

Example

ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "environment");
var result = await stack.Taxonomies().Find<MyTaxonomy>();
var page = await stack.Taxonomies().AddParam("skip", "0").AddParam("limit", "10").Find<MyTaxonomy>();

The Term method returns a Term instance scoped to the given term UID within this taxonomy. It requires the taxonomy to have been initialized via stack.Taxonomies("uid").

Validation

Throws TaxonomyException if the Taxonomy has no UID (same reason as Fetch). Separately, the returned Term object's own constructor throws TaxonomyException if termUid is null or empty.

Behavior

Client-side only. Constructs a Term instance. No HTTP call is made.

Example

ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "environment");
Term term = stack.Taxonomies("taxonomy_uid").Term("term_uid");

The Terms method returns a TermQuery instance for listing all published terms within this taxonomy. It requires the taxonomy to have been initialized via stack.Taxonomies("uid"). Chain SetLocale and IncludeFallback on the returned TermQuery before calling Find.

Validation

Throws TaxonomyException if the Taxonomy has no UID (same reason as Fetch).

Behavior

Client-side only. Constructs a TermQuery instance. No HTTP call is made.

Example

ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "environment");
TermQuery termQuery = stack.Taxonomies("taxonomy_uid").Terms();