The list_tables tool lists the tables of one kind that you can query, for example all Datamarts or all Product Extensions. For each table, the tool returns the identifiers to use in the Get Table Fields, Query Analytics Data, and Query Business Data tools.
Tool Name – list_tables
Title – List Tables
Type – Private
Access Profile – Operator
Permissions
The tool is available to the Operator access profile when tool access control is on. The list_tables tool uses your Pricefx permissions and lists only the tables that you have permission to query. For the modelTable kind, the tool lists only the tables of a Model Object that your user groups are allowed to view.
Parameters
|
Parameter |
Required |
Description |
|---|---|---|
|
|
Yes |
The kind of table to list, for example datamart or productExtensionRows. The values are described in the Table Kinds table on this page. |
|
|
No |
Text to narrow the list. The tool returns the tables whose identifiers or label contain this text. The comparison ignores case. Default: Empty, which lists every table of the kind. |
|
|
Only for modelTable |
The unique name of the Model Object whose tables to list. The tool ignores |
Table Kinds
|
Kind |
Tables |
Query Tool |
|---|---|---|
|
datamart |
Datamarts |
|
|
dataSource |
Data Sources |
|
|
rollup |
Rollups |
|
|
modelTable |
Tables of a Model Object |
|
|
products |
Products (Product Master) |
|
|
customers |
Customers (Customer Master) |
|
|
sellers |
Sellers (Seller Master) |
|
|
productCompetitions |
Product Competition |
|
|
productReferences |
Product References |
|
|
productBillOfMaterials |
Product Bills of Materials |
|
|
productExtensionRows |
Product Extensions |
|
|
customerExtensionRows |
Customer Extensions |
|
|
sellerExtensionRows |
Seller Extensions |
|
When Pricefx enables pricing tables for your partition, the following kinds are also available, all read by query_business_data:
|
Kind |
Tables |
|---|---|
|
priceLists |
Price Lists |
|
priceListLineItems |
Line items of a Price List |
|
priceGrids |
Live Price Grids |
|
priceGridLineItems |
Line items of a Live Price Grid |
|
calculationGrids |
Calculation Grids |
|
calculationGridLineItems |
Line items of a Calculation Grid |
|
companyParameterTables |
Company Parameter tables |
|
companyParameterRows |
Rows of a Company Parameter table |
|
conditionRecords |
Condition Records of a Condition Record Set |
Output
The list_tables tool returns an object with the following fields.
|
Field |
Description |
|---|---|
|
|
The kind that was listed. |
|
|
The name of the tool that queries tables of this kind: |
|
|
The matching tables, at most 200. Each table has the fields in the Table Fields table on this page. |
|
|
true when more than 200 tables match. To see the others, narrow the list with |
Table Fields
|
Field |
Description |
|---|---|
|
|
The first identifier of the table. Use it as |
|
|
The second identifier of the table. Use it as |
|
|
The display name of the table. |
|
|
The business description of the table. Present only when the partition has one. |
|
|
The number of rows. Present only for modelTable tables. |
Behavior and Limitations
-
For a kind with one table per partition, for example products or customers, the
list_tablestool returns one entry with empty identifiers. -
The
list_tablestool returns at most 200 tables per call. -
For Datamarts and Data Sources,
labelis the display name. For Price List, Live Price Grid, and Calculation Grid line items,labelis the name of the Price List, Live Price Grid, or Calculation Grid. For other kinds,labelis the first identifier. -
For the modelTable kind, the
list_tablestool lists the tables of one Model Object only. Themodelparameter names that Model Object. -
The
list_tablestool leaves out a table that has no value for a required identifier. -
Quotes, Contracts, rebate line items, Rebate Records, compensation tables, claims, action items, and Custom Forms are not available as table kinds.
Errors
|
Situation |
Error Message |
|---|---|
|
|
|
|
|
|
|
No Model Object with the name in |
|