Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Change a User Password
List Users
Change a Current User Password
Assign a User to a User Group
List User's User Groups
List User's Roles
List User's Business Roles
List Roles of the Business Role
List Groups of the Business Role
Delete a Business Role
Copy Roles
Generate a JWT Token
Generate a JWT Token (time limited)
Assign a Role to Users
Assign a User Group to Users
Assign a Role to a User
Assign a Business Role to a User
Assign a Business Role
Delete a User Group
Copy a User
Assign a Role to a Business Role
Assign a Group to a Business Role
Get a One Time Token
Add a User
Update a User
Delete a User
Get a User Audit Report
Change a User Password
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 a list of users.
Information: If the authenticated user does not have the explicit
USER_FETCHpermission, the fields are reduced to a minimum.
Security
basic or X-PriceFx-jwt
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.
Default 300
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.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.fetchusers
- URL:https://companynode.pricefx.com/pricefx/companypartition/accountmanager.fetchusers
- 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/accountmanager.fetchusers \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "workflowEmailingActivated",
"operator": "notEqual",
"value": true
}
]
}
}'Response
application/json
{ "response": { "node": "string", "startRow": 0, "data": [ … ], "endRow": 0, "totalRows": 0, "status": 0 } }
Request
Changes a specified user's password.
The authenticated user needs the ADMIN (including USERADMIN) permissions to perform this action. To change your own password, use the /accountmanager.changepassword endpoint instead.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.changepassword/{userId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/accountmanager.changepassword/{userId}
- 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/accountmanager.changepassword/2147490806 \
-H 'Content-Type: application/json' \
-d '{
"data": {
"newPassword": "eqweqweqwQW112131FF*"
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.changepassword
- URL:https://companynode.pricefx.com/pricefx/companypartition/accountmanager.changepassword
- 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/accountmanager.changepassword \
-H 'Content-Type: application/json' \
-d '{
"data": {
"newPassword": "eqweqweqwQW112131FF*",
"oldPassword": "12345678pwdd9876543"
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "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