aliases_list: List Aliases

In civis: R Client for the 'Civis Platform API'

List Aliases

Description

List Aliases

Usage

aliases_list(
  object_type = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

object_type	string optional. Filter results by object type. Pass multiple object types with a comma-separatedlist. 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.
limit	integer optional. Number of results to return. Defaults to 50. Maximum allowed is 1000.
page_num	integer optional. Page number of the results to return. Defaults to the first page, 1.
order	string optional. The field on which to order the result set. Defaults to id. Must be one of: id, object_type.
order_dir	string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.

Value

An array containing the following fields:

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.

civis documentation built on April 1, 2023, 12:01 a.m.