client.aliases.put

A method of the Aliases endpoint.

put(id: int, object_id: int, object_type: str, alias: str, *, display_name: str = None) → Response

Replace all attributes of this Alias

API URL: PUT /aliases/{id}

import civis
client = civis.APIClient()
response = client.aliases.put(...)

Parameters:

idint

The id of the Alias object.

object_idint

The id of the object

object_typestr

The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.

aliasstr

The alias of the object

display_namestr, optional

The display name of the Alias object. Defaults to object name if not provided.

Returns:

civis.Response

• idint

  The id of the Alias object.

• object_idint

  The id of the object

• object_typestr

  The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.

• aliasstr

  The alias of the object

• user_idint

  The id of the user who created the alias

• display_namestr

  The display name of the Alias object. Defaults to object name if not provided.