tags¶

The following methods allow for interaction with the ZMS Tags API endpoints.

Methods are accessible via zms.tags

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class TagsAPI¶

Bases: APIClient

A Client object for the ZMS Tags domain.

Provides access to tag management operations including: - List tag namespaces with filtering, ordering, and pagination - List tag keys within a namespace - List tag values within a tag key

list_tag_keys(customer_id, namespace_id, page_num=1, page_size=20, filter_by=None, order_by=None)¶

Retrieve tag keys within a specific namespace.

Parameters:

customer_id – The customer ID.
namespace_id – The namespace ID.
page_num – Page number (default 1).
page_size – Number of items per page (default 20).
filter_by – Filter options using TagKeyFilter.
order_by – Ordering options using TagKeyQueryOrderBy.

Returns:

(tag_key_connection dict, response, error)

Return type:

tuple

Examples

List tag keys:

>>> result, _, err = client.zms.tags.list_tag_keys(
...     customer_id="123456789",
...     namespace_id="ns-abc-123"
... )
>>> if err:
...     print(err)
>>> for key in result.get("nodes", []):
...     print(key.get("name"))

list_tag_namespaces(customer_id, page_num=1, page_size=20, filter_by=None, order_by=None)¶

Retrieve tag namespaces with support for filtering, ordering, and pagination.

Parameters:

customer_id – The customer ID.
page_num – Page number (default 1).
page_size – Number of items per page (default 20).
filter_by – Filter options using NamespaceFilter.
order_by – Ordering options using NamespaceQueryOrderBy.

Returns:

(namespace_connection dict, response, error)

Return type:

tuple

Examples

List tag namespaces:

>>> result, _, err = client.zms.tags.list_tag_namespaces(
...     customer_id="123456789"
... )
>>> if err:
...     print(err)
>>> for ns in result.get("nodes", []):
...     print(ns.get("name"), ns.get("origin"))

list_tag_values(customer_id, tag_id, namespace_origin, page_num=1, page_size=20, filter_by=None, order_by=None)¶

Retrieve tag values for a specific tag key.

Parameters:

customer_id – The customer ID.
tag_id – The tag key ID.
namespace_origin – The namespace origin (CUSTOM, EXTERNAL, ML, UNKNOWN).
page_num – Page number (default 1).
page_size – Number of items per page (default 20).
filter_by – Filter options using TagValueFilter.
order_by – Ordering options using TagValueQueryOrderBy.

Returns:

(tag_value_connection dict, response, error)

Return type:

tuple

Examples

List tag values:

>>> result, _, err = client.zms.tags.list_tag_values(
...     customer_id="123456789",
...     tag_id="tag-key-123",
...     namespace_origin="CUSTOM"
... )
>>> if err:
...     print(err)
>>> for val in result.get("nodes", []):
...     print(val.get("name"))