client.aliases.get_object_type

A method of the Aliases endpoint.

get_object_type(object_type: str, alias: str) Response

Get details about an alias within an FCO type

API URL: GET /aliases/{object_type}/{alias}

import civis
client = civis.APIClient()
response = client.aliases.get_object_type(...)
Parameters:
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

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.