Skip to content

Latest commit

 

History

History
219 lines (156 loc) · 7.08 KB

dataTable.md

File metadata and controls

219 lines (156 loc) · 7.08 KB

Data Table Actions

Details on the various actions that can be performed on the Data Table resource, including the expected parameters and the potential responses.

Contents

Add Column

Adds a new column to this data table

result = client.data_table.add_column(
    applicationId=my_application_id,
    dataTableId=my_data_table_id,
    dataTableColumn=my_data_table_column)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, dataTable.*, or dataTable.addColumn.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
dataTableId string Y ID associated with the data table 575ed78e7ae143cd83dc4aab
dataTableColumn Data Table Column Y Object containing the new column properties Data Table Column Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Data Table Updated data table information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if data table was not found

Delete

Deletes a data table

result = client.data_table.delete(
    applicationId=my_application_id,
    dataTableId=my_data_table_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, dataTable.*, or dataTable.delete.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
dataTableId string Y ID associated with the data table 575ed78e7ae143cd83dc4aab
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Success If data table was successfully deleted

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if data table was not found

Get

Retrieves information on a data table

result = client.data_table.get(
    applicationId=my_application_id,
    dataTableId=my_data_table_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, dataTable.*, or dataTable.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
dataTableId string Y ID associated with the data table 575ed78e7ae143cd83dc4aab
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Data Table Data table information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if data table was not found

Patch

Updates information about a data table

result = client.data_table.patch(
    applicationId=my_application_id,
    dataTableId=my_data_table_id,
    dataTable=my_data_table)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, dataTable.*, or dataTable.patch.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
dataTableId string Y ID associated with the data table 575ed78e7ae143cd83dc4aab
dataTable Data Table Patch Y Object containing updated properties of the data table Data Table Patch Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Data Table Updated data table information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if data table was not found

Remove Column

Removes a column from this data table

result = client.data_table.remove_column(
    applicationId=my_application_id,
    dataTableId=my_data_table_id,
    columnName=my_column_name)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, dataTable.*, or dataTable.removeColumn.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
dataTableId string Y ID associated with the data table 575ed78e7ae143cd83dc4aab
columnName string Y Name of the column to remove myColumnName
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Data Table Updated data table information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if data table was not found