Menu
Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version
Publication date

Mar 9, 2022

Confidentiality
Public
Reactions
1
Share

TagService

Functions
add_additional_info_spec_to_tag_key @classmethod

Add an additional info spec to a tag key

key : str
spec_name : str
spec : ParamSpecSimpleDTO
Return type : Dict
add_tag_dict_to_entity @classmethod
add_tag_to_entity @classmethod
add_tags_to_entity @classmethod
add_tags_to_entity_and_propagate @classmethod
apply_sync @classmethod

Apply the synchronization of the tags with the community

tags_not_sync : TagsNotSynchronizedDTO
check_propagation_add_tags @classmethod

Check the impact of the propagation of the given tags

entity_type : TagEntityType
entity_id : str
tags : List
Return type : TagPropagationImpactDTO
check_propagation_delete_tag @classmethod

Check the impact of deletion of a the propagation of the given tags

entity_type : TagEntityType
entity_id : str
tag : NewTagDTO
Return type : TagPropagationImpactDTO
community_tag_key_from_tag_key @classmethod

Get the community tag key by key

tag_key : TagKeyModel
Return type : CommunityTagKeyDTO
community_tag_key_page_to_tag_key_model_page @classmethod

Convert a community tag key page to a tag key model page

community_tag_key_page : PageDTO[CommunityTagKeyDTO]
Return type : PageDTO[TagKeyModelDTO]
create_tag @classmethod
create_tag_key @classmethod
key : str
label : str
Return type : TagKeyModel
create_tag_value @classmethod

Create a new tag value

edit_tag_value : TagValueEditDTO
tag_key_model : TagKeyModel
Return type : TagValueModel
delete_additional_info_spec_to_tag_key @classmethod

Delete an additional info spec to a tag key

key : str
spec_name : str
Return type : Dict
delete_registered_tag @classmethod
delete_tag_from_entity @classmethod
entity_type : TagEntityType
entity_id : str
tag_key : str
tag_value : Union
delete_tag_key @classmethod
delete_tag_value @classmethod
deprecate_tag_values @classmethod

Deprecate all tag values for a given tag key

tag_key_model : TagKeyModel
find_by_entity_id @classmethod
entity_type : TagEntityType
entity_id : str
Return type : EntityTagList
get_all_tags @classmethod
Return type : List
get_and_check_entity_tag @classmethod
entity_tag_id : str
Return type : EntityTag
get_by_key @classmethod
tag_key : str
Return type : TagKeyModel
get_community_available_tags @classmethod
get_community_tag_keys_imported @classmethod

Get the community tag keys imported

Return type : List
get_community_tag_values @classmethod
get_entities_by_tag @classmethod
entity_type : TagEntityType
tag : Tag
Return type : List
get_new_community_tag_values @classmethod

Get the new community tag values for a tag key

tag_key : TagKeyModel
Return type : List
get_not_synchronized_community_tags @classmethod

Get the tags that are not synchronized with the community

Return type : TagsNotSynchronizedDTO
get_tag_origins @classmethod
entity_tag_id : str
Return type : List
get_tag_value_by_id @classmethod

Get the community tag value imported

tag_value_id : str
Return type : TagValueModel
get_tag_value_by_key_and_value @classmethod

Get the community tag value by key and value

tag_key : str
tag_value : Union
Return type : TagValueModel
import_all_community_tag_key_values @classmethod
rename_and_update_additional_info_spec_to_tag_key @classmethod

Rename and update an additional info spec to a tag key

key : str
old_spec_name : str
new_spec_name : str
spec : ParamSpecSimpleDTO
Return type : Dict
reorder_tags @classmethod
search_community_tag_keys_by_key @classmethod

Get the community tags by key

tag_key : str
number_of_items_per_page : int
page : int
Return type : PageDTO[TagKeyModelDTO]
search_keys @classmethod
tag_key : str
page : int - 0
number_of_items_per_page : int - 20
Return type : PageDTO[TagKeyModelDTO]
search_values @classmethod
tag_key : str
tag_value : str
page : int - 0
number_of_items_per_page : int - 20
Return type : Paginator
share_tag_to_community @classmethod

Share a tag to the community

tag_key : str
publish_mode : Literal
space_selected : Optional
Return type : TagKeyModel
tag_has_values @classmethod

Check if the tag key has values

tag_key_model : TagKeyModel
Return type : bool
update_additional_info_spec_to_tag_key @classmethod

Update an additional info spec to a tag key

key : str
spec_name : str
spec : ParamSpecSimpleDTO
Return type : Dict
update_registered_tag_value @classmethod
update_tag_key_label @classmethod

Update the label of a tag key

key : str
label : str
Return type : TagKeyModel
update_tag_value @classmethod

Update a tag value

key : str
edit_tag_value : TagValueEditDTO
Return type : TagValueModel
Shine Logo
Technical bricks to reuse or customize

Have you developed a brick?

Share it to accelerate projects for the entire community.