Skip to content

Latest commit

 

History

History
271 lines (196 loc) · 9.92 KB

dataTableRows.md

File metadata and controls

271 lines (196 loc) · 9.92 KB
Raw

Data Table Rows Actions

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

Contents

Delete

Delete rows from a data table

result = client.data_table_rows.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, dataTableRows.*, or dataTableRows.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
query Advanced Query N Query to apply to filter the data table Advanced Query Example
limit string N Limit number of rows to delete from data table 1000 10
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Data Table Rows Delete If request successfully deletes a set of Data Table rows

Error Responses

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

Export

Request an export of the data table's data

result = client.data_table_rows.export(
    applicationId=my_application_id,
    dataTableId=my_data_table_id,
    exportData=my_export_data)

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.read, all.Organization, all.Organization.read, all.User, all.User.read, dataTableRows.*, or dataTableRows.export.

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
exportData Data Table Rows Export Y Object containing export specifications Data Table Rows Export Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
202 Job Enqueued API Result If request was successfully queued

Error Responses

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

Get

Returns the rows for a data table

result = client.data_table_rows.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, dataTableRows.*, or dataTableRows.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
sortColumn string N Column to sort the rows by myColumnName
sortDirection string N Direction to sort the rows by. Accepted values are: asc, desc asc asc
limit string N How many rows to return 1000 0
offset string N How many rows to skip 0 0
includeFields string N Comma-separated list of fields to include in resulting rows. When not provided, returns all fields. id,createdAt
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Data Table Rows Collection of data table rows

Error Responses

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

Post

Inserts a new row(s) into a data table

result = client.data_table_rows.post(
    applicationId=my_application_id,
    dataTableId=my_data_table_id,
    dataTableRow=my_data_table_row)

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, dataTableRows.*, or dataTableRows.post.

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
dataTableRow Data Table Row Insert Y The row(s) to insert Data Table Row Insert Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
201 Data Table Row Insert Result Successfully created data table row, or bulk insert count

Error Responses

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

Query

Queries for rows from a data table

result = client.data_table_rows.query(
    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.read, all.Organization, all.Organization.read, all.User, all.User.read, dataTableRows.*, or dataTableRows.query.

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
sortColumn string N Column to sort the rows by myColumnName
sortDirection string N Direction to sort the rows by. Accepted values are: asc, desc asc asc
limit string N How many rows to return 1000 0
offset string N How many rows to skip 0 0
includeFields string N Comma-separated list of fields to include in resulting rows. When not provided, returns all fields. id,createdAt
query Advanced Query N Query to apply to filter the data table Advanced Query Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Data Table Rows Collection of data table rows

Error Responses

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

Truncate

Delete all data in the data table

result = client.data_table_rows.truncate(
    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, dataTableRows.*, or dataTableRows.truncate.

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 request successfully deleted all rows in the data table, this will not send workflow data table deletion triggers

Error Responses

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