remote_hosts_list_data_sets {civis}

List data sets available from a remote host

Description

List data sets available from a remote host

Usage

remote_hosts_list_data_sets(
  id,
  credential_id = NULL,
  username = NULL,
  password = NULL,
  q = NULL,
  s = NULL
)

Arguments

id

integer required. The ID of the remote host.

credential_id

integer optional. The credential ID.

username

string optional. The user name for remote host.

password

string optional. The password for remote host.

q

string optional. The query string for data set.

s

boolean optional. If true will only return schemas, otherwise, the results will be the full path.

Value

An array containing the following fields:

name

string, The path to a data_set.

fullPath

boolean, Boolean that indicates whether further querying needs to be done before the table can be selected.