aliases_post {civis}

Create an Alias

Description

Create an Alias

Usage

aliases_post(object_id, object_type, alias, display_name = NULL)

Arguments

object_id

integer required. The id of the object

object_type

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

alias

string required. The alias of the object

display_name

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

Value

A list containing the following elements:

id

integer, The id of the Alias object.

objectId

integer, The id of the object

objectType

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

alias

string, The alias of the object

userId

integer, The id of the user who created the alias

displayName

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