Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- List Internationalization Messages
Delete Internationalization Messages
Add a New Internationalization Message
List Internationalization...
The Pricefx Backend API
Download OpenAPI description
Overview
URL
Pricefx
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}
Request
Retrieves internationalization messages. Each i18n message contains key, value, and overriddenValue.
Required roles
I18NADMINSUPPORT
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/i18nmanager.fetchWithExtraData
- URL:https://companynode.pricefx.com/pricefx/companypartition/i18nmanager.fetchWithExtraData
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/i18nmanager.fetchWithExtraData \
-H 'Content-Type: application/json' \
-d '{
"data": {
"partitionWideOverride": true
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/i18nmanager.deleteKeys
- URL:https://companynode.pricefx.com/pricefx/companypartition/i18nmanager.deleteKeys
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/i18nmanager.deleteKeys \
-H 'Content-Type: application/json' \
-d '{
"data": {
"messages": [
"testKey"
],
"partitionWideOverride": true
}
}'Request
Adds overridden internationalization messages to the existing collection.
Required roles
I18NADMINSUPPORT
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/i18nmanager.put
- URL:https://companynode.pricefx.com/pricefx/companypartition/i18nmanager.put
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/i18nmanager.put \
-H 'Content-Type: application/json' \
-d '{
"data": {
"messages": {
"testKey": "testValue"
},
"partitionWideOverride": true
}
}'Response
application/json
{ "response": { "node": "string", "data": {}, "errors": { … }, "status": 0 } }
See the Key-Value Database Storage Knowledge Base article for more details.
Operations
Here you can find all fields of the corresponding entity (represented by the type code).
Use the /metadata.describe endpoint to find out the correct data type of the field that is used in your partition.
Comments