List All Lookup Table Values

post/lookuptablemanager.fetch/{tableId}

Retrieves all Company Parameter records for the specified Company Parameter table (LookupTable).

Export the table to the Excel file (XLSX) using the output=xls URL query parameter. When exporting to the file, specify fields (within the resultFields property) you want to include in the output table.

Example:

{
   "data":{
      "criteria":[

      ],
      "operator":"and"
   },
   "resultFields":[
      "key1",
      "key2",
      "key3",
      "attribute1",
      "attribute2",
      "attribute3"
   ],
   "valueFields":[

   ]
}
Securitybasic or X-PriceFx-jwt
Request
path Parameters
tableId
required
string

Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method.

query Parameters
output
string

Specifies the format of the output file.

Possible values: "json" "xls" "csv"
Example: output=xls
useColumnNames
string
Default: "true"

Set to false to retrieve the table with labels (as used in the database) instead of names in the table header.

Possible values: "true" "false"
Example: useColumnNames=false
Request Body schema: application/json

You can specify the start and end row to limit the number of retrieved records.

endRow
number
Default: 300

The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.

oldValues
any
operationType
string non-empty
startRow
number

The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.

textMatchStyle
string non-empty
sortBy
Array of objects
Responses
200

OK

Response Schema: application/json
object
status
number
startRow
number
node
string non-empty
csrfToken
string non-empty
Array of objects non-empty unique
Array (non-empty)
version
required
number
typedId
required
string non-empty
name
required
string non-empty
value
required
string non-empty
lowerBound
any
upperBound
any
lastUpdateByName
required
string non-empty
createdByName
required
string non-empty
tableId
any
valueType
required
string non-empty
type
required
string non-empty
rawValue
required
string non-empty
createDate
required
string non-empty
createdBy
required
number
lastUpdateDate
required
string non-empty
lastUpdateBy
required
number
endRow
number

The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.

Request samples
application/json
{
  • "endRow": 30,
  • "oldValues": null,
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact"
}
Response samples
application/json
{
  • "response": {
    • "status": 0,
    • "startRow": 0,
    • "node": "<node>",
    • "csrfToken": "<token>",
    • "data": [
      • {
        • "version": 18,
        • "typedId": "2147489943.LTV",
        • "name": "test",
        • "value": "null",
        • "lowerBound": null,
        • "upperBound": null,
        • "lastUpdateByName": "admin",
        • "createdByName": "admin",
        • "tableId": null,
        • "valueType": "STRING",
        • "type": "SIMPLE",
        • "rawValue": "null",
        • "createDate": "2021-10-01T12:08:23",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2021-10-06T12:49:48",
        • "lastUpdateBy": 2147490696
        },
      • {
        • "version": 2,
        • "typedId": "2147490005.LTV",
        • "name": "recordName",
        • "value": "recordValue",
        • "lowerBound": null,
        • "upperBound": null,
        • "lastUpdateByName": "admin",
        • "createdByName": "admin",
        • "tableId": null,
        • "valueType": "STRING",
        • "type": "SIMPLE",
        • "rawValue": "recordValue",
        • "createDate": "2021-10-07T09:04:47",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2021-10-07T09:04:47",
        • "lastUpdateBy": 2147490696
        },
      • {
        • "version": 2,
        • "typedId": "2147490006.LTV",
        • "name": "recordName2",
        • "value": "recordValue2",
        • "lowerBound": null,
        • "upperBound": null,
        • "lastUpdateByName": "admin",
        • "createdByName": "admin",
        • "tableId": null,
        • "valueType": "STRING",
        • "type": "SIMPLE",
        • "rawValue": "recordValue2",
        • "createDate": "2021-10-07T09:07:24",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2021-10-07T09:07:24",
        • "lastUpdateBy": 2147490696
        }
      ],
    • "endRow": 3
    }
}