pyapacheatlas.core.client.AtlasClient.assignTerm#

AtlasClient.assignTerm(entities, termGuid=None, termName=None, glossary_name='Glossary')#

AtlasClient.assignTerm is being deprecated. Please use AtlasClient.glossary.assignTerm instead.

Assign a single term to many entities. Provide either a term guid (if you know it) or provide the term name and glossary name. If term name is provided, term guid is ignored.

As for entities, you may provide a list of AtlasEntity BUT they must have a valid guid defined (not None, not -N) or it will fail with a transient error. Alternatively, you may provide your own dict that contains a ‘guid’ key and value.

Parameters

  • entities (list(Union(dict, AtlasEntity))) – The list of entities that should have the term assigned.

  • termGuid (str) – The guid for the term. Ignored if using termName.

  • termName (str) – The name of the term. Optional if using termGuid.

  • glossary_name (str) – The name of the glossary. Defaults to Glossary. Ignored if using termGuid.

Returns

A dictionary indicating success or failure.

Return type

dict