Create Dataset

finspacedata_create_dataset

R Documentation

Creates a new FinSpace Dataset

Description

Creates a new FinSpace Dataset.

Usage

finspacedata_create_dataset(clientToken, datasetTitle, kind,
  datasetDescription, ownerInfo, permissionGroupParams, alias,
  schemaDefinition)

Arguments

clientToken

A token that ensures idempotency. This token expires in 10 minutes.

datasetTitle

[required] Display title for a FinSpace Dataset.

kind

[required] The format in which Dataset data is structured.

• TABULAR – Data is structured in a tabular format.

• NON_TABULAR – Data is structured in a non-tabular format.

datasetDescription

Description of a Dataset.

ownerInfo

Contact information for a Dataset owner.

permissionGroupParams

[required] Permission group parameters for Dataset permissions.

alias

The unique resource identifier for a Dataset.

schemaDefinition

Definition for a schema on a tabular Dataset.

Value

A list with the following syntax:

list(
  datasetId = "string"
)

Request syntax

svc$create_dataset(
  clientToken = "string",
  datasetTitle = "string",
  kind = "TABULAR"|"NON_TABULAR",
  datasetDescription = "string",
  ownerInfo = list(
    name = "string",
    phoneNumber = "string",
    email = "string"
  ),
  permissionGroupParams = list(
    permissionGroupId = "string",
    datasetPermissions = list(
      list(
        permission = "string"
      )
    )
  ),
  alias = "string",
  schemaDefinition = list(
    tabularSchemaConfig = list(
      columns = list(
        list(
          dataType = "STRING"|"CHAR"|"INTEGER"|"TINYINT"|"SMALLINT"|"BIGINT"|"FLOAT"|"DOUBLE"|"DATE"|"DATETIME"|"BOOLEAN"|"BINARY",
          columnName = "string",
          columnDescription = "string"
        )
      ),
      primaryKeyColumns = list(
        "string"
      )
    )
  )
)