List Customer Extension Objects

post/customermanager.fetch/*/CX/{CustomerMasterExtensionName}

Retrieves records from the Customer Extensions table.

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

Example request body for the export action:

{
   "data":{
      "criteria":[

      ],
      "operator":"and"
   },
   "resultFields":[
      "customerId",
      "lastUpdateDate",
      "attribute1"
   ],
   "valueFields":[

   ]
}

You can choose fields to be returned in the response by employing the resultFields or valueFields filter:
resultFields: returns key-value pairs as objects. This is the more friendly response compared to valueFields but the server fetches all fields from the database in the backend which might result in a slower performance. See the List Customers' listCustomersResponseExample_resultFields response example.

valueFields: returns just an array of values. Use this option if a better performance is required. See the List Customers' listCustomersResponseExample_valueFields response example.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
CustomerMasterExtensionName
required
string

Enter the name of Customer Extension you want to retrieve objects from. You can find the name in Administration > Configuration > Master Data > Customer Master Extension or using the /configurationmanager.get/customerextension endpoint.

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
endRow
number
oldValues
any
operationType
string non-empty
startRow
number
textMatchStyle
string non-empty
object
_constructor
string non-empty
operator
string non-empty
Array of objects non-empty unique
Array (non-empty)
fieldName
string non-empty
operator
string non-empty
value
string non-empty
sortBy
Array of objects
Responses
200

OK

Response Schema: application/json
object
node
string
Array of CX3 (object) or CX6 (object) or CX8 (object) or CX10 (object) or CX20 (object) or CX30 (object) or CX50 (object)
Array
Any of:

The type code is CX3

typedId
string
createdBy
integer
lastUpdateDate
string <date-time>
name
string <= 255 characters
customerId
string <= 255 characters
attribute1
any
attribute3
any
attribute2
any
version
integer
createDate
string <date-time>
lastUpdateBy
integer
endRow
integer
totalRows
integer
status
integer
Request samples
application/json
{
  • "endRow": 0,
  • "oldValues": null,
  • "operationType": "string",
  • "startRow": 0,
  • "textMatchStyle": "string",
  • "data": {
    • "_constructor": "string",
    • "operator": "string",
    • "criteria": [
      • {
        • "fieldName": "string",
        • "operator": "string",
        • "value": "string"
        }
      ]
    },
  • "sortBy": [
    • { }
    ]
}
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-cb48f6447-qncxw",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "1.CX3",
        • "name": "CustomerClass",
        • "customerId": "CD-0001",
        • "createDate": "2018-03-13T12:21:21",
        • "createdBy": 2147483649,
        • "lastUpdateDate": "2018-03-13T12:21:21",
        • "lastUpdateBy": 2147483649,
        • "attribute1": "High",
        • "attribute2": "15 %",
        • "attribute3": null
        },
      • {
        • "version": 0,
        • "typedId": "2.CX3",
        • "name": "CustomerClass",
        • "customerId": "CD-0002",
        • "createDate": "2018-03-13T12:21:34",
        • "createdBy": 2147483649,
        • "lastUpdateDate": "2018-03-13T12:21:34",
        • "lastUpdateBy": 2147483649,
        • "attribute1": "High",
        • "attribute2": "17 %",
        • "attribute3": null
        },
      • {
        • "version": 0,
        • "typedId": "3.CX3",
        • "name": "CustomerClass",
        • "customerId": "CD-0003",
        • "createDate": "2018-03-13T12:21:47",
        • "createdBy": 2147483649,
        • "lastUpdateDate": "2018-03-13T12:21:47",
        • "lastUpdateBy": 2147483649,
        • "attribute1": "Low",
        • "attribute2": "4 %",
        • "attribute3": null
        },
      • {
        • "version": 0,
        • "typedId": "4.CX3",
        • "name": "CustomerClass",
        • "customerId": "CD-0004",
        • "createDate": "2018-03-13T12:22:00",
        • "createdBy": 2147483649,
        • "lastUpdateDate": "2018-03-13T12:22:00",
        • "lastUpdateBy": 2147483649,
        • "attribute1": "High",
        • "attribute2": "15 %",
        • "attribute3": null
        },
      • {
        • "version": 0,
        • "typedId": "5.CX3",
        • "name": "CustomerClass",
        • "customerId": "CD-0005",
        • "createDate": "2018-03-13T12:22:12",
        • "createdBy": 2147483649,
        • "lastUpdateDate": "2018-03-13T12:22:12",
        • "lastUpdateBy": 2147483649,
        • "attribute1": "Medium",
        • "attribute2": "10 %",
        • "attribute3": null
        },
      • {
        • "version": 0,
        • "typedId": "6.CX3",
        • "name": "CustomerClass",
        • "customerId": "CD-0006",
        • "createDate": "2018-03-13T12:22:22",
        • "createdBy": 2147483649,
        • "lastUpdateDate": "2018-03-13T12:22:22",
        • "lastUpdateBy": 2147483649,
        • "attribute1": "Medium",
        • "attribute2": "10 %",
        • "attribute3": null
        },
      • {
        • "version": 0,
        • "typedId": "14.CX3",
        • "name": "CustomerClass",
        • "customerId": "CD-0020",
        • "createDate": "2019-10-25T12:10:55",
        • "createdBy": 2147483668,
        • "lastUpdateDate": "2019-10-25T12:10:55",
        • "lastUpdateBy": 2147483668,
        • "attribute1": "Low",
        • "attribute2": "10 %",
        • "attribute3": null
        }
      ],
    • "endRow": 7,
    • "totalRows": 7,
    • "status": 0
    }
}