aliases_patch {civis}R Documentation

Update some attributes of this Alias

Description

Update some attributes of this Alias

Usage

aliases_patch(
  id,
  object_id = NULL,
  object_type = NULL,
  alias = NULL,
  display_name = NULL
)

Arguments

id

integer required. The id of the Alias object.

object_id

integer optional. The id of the object

object_type

string optional. 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 optional. 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.


[Package civis version 3.1.2 Index]