API table - RapturePlatform/Rapture GitHub Wiki

Table API

For manipulating Rapture tables. Tables are data warehouses in Rapture that are used primarily internally to manage things such as indexes on other data. The terms index and table are used interchangeably in Rapture.

This api is deprecated: "The Table api is deprecated, use the index api instead" ## createTable 
HttpTableApi tableApi = new HttpTableApi(loginApi);
RaptureTableConfig retVal = tableApi.createTable(indexURI, config);
retVal = baseAPI.doTable_CreateTable(indexURI, config);
This function is deprecated: "The Table api is deprecated, use the index api instead"

Entitlement: /admin/index

Creates a RaptureTableConfig object with the specified configuration and stores it in the config repo.

Function Parameters

Parameter Type Description
indexURI String
config String

Return value

Type Description
RaptureTableConfig
Types used in this function

RaptureTableConfig

Holds the config info for a Rapture table, as described in the table API.

Field Type
name String
config String
authority String

getTablesForAuthority

HttpTableApi tableApi = new HttpTableApi(loginApi);
List<RaptureTableConfig> retVal = tableApi.getTablesForAuthority(authority);
retVal = baseAPI.doTable_GetTablesForAuthority(authority);
This function is deprecated: "The Table api is deprecated, use the index api instead"

Entitlement: /admin/index

Gets the configs for all tables in a given authority.

Function Parameters

Parameter Type Description
authority String

Return value

Type Description
List

getTable

HttpTableApi tableApi = new HttpTableApi(loginApi);
RaptureTableConfig retVal = tableApi.getTable(indexURI);
retVal = baseAPI.doTable_GetTable(indexURI);
This function is deprecated: "The Table api is deprecated, use the index api instead"

Entitlement: /admin/index

Gets the config for a specified table.

Function Parameters

Parameter Type Description
indexURI String

Return value

Type Description
RaptureTableConfig
Types used in this function

RaptureTableConfig

Holds the config info for a Rapture table, as described in the table API.

Field Type
name String
config String
authority String

deleteTable

HttpTableApi tableApi = new HttpTableApi(loginApi);
boolean retVal = tableApi.deleteTable(indexURI);
retVal = baseAPI.doTable_DeleteTable(indexURI);
This function is deprecated: "The Table api is deprecated, use the index api instead"

Entitlement: /admin/index

Deletes a RaptureTableConfig from the config repo.

Function Parameters

Parameter Type Description
indexURI String

Return value

Type Description
boolean

queryTable

HttpTableApi tableApi = new HttpTableApi(loginApi);
List<TableRecord> retVal = tableApi.queryTable(indexURI, query);
retVal = baseAPI.doTable_QueryTable(indexURI, query);
This function is deprecated: "The Table api is deprecated, use the index api instead"

Entitlement: /admin/index

Runs a TableQuery on a given table/index URI.

Function Parameters

Parameter Type Description
indexURI String
query TableQuery

Return value

Type Description
List
Types used in this function

TableQuery

Describes a query made against a table.

Field Type
fieldTests List(TableSelect)
fieldReturns List(String)
sortFields List(TableColumnSort)
skip int
limit int
⚠️ **GitHub.com Fallback** ⚠️