Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Copy Roles
List Users
Change a User Password
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
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
Copy Roles
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
Deletes a Business Role. The general datasource /delete operation (/delete/BR) should NOT be used for Business Role object as this special command (/accountmanager.deletebusinessrole) also performs a cleanup of related objects (objects that have this business role assigned).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.deletebusinessrole
- URL:https://companynode.pricefx.com/pricefx/companypartition/accountmanager.deletebusinessrole
- 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.deletebusinessrole \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "53.BR"
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.copyroles
- URL:https://companynode.pricefx.com/pricefx/companypartition/accountmanager.copyroles
- 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.copyroles \
-H 'Content-Type: application/json' \
-d '{
"data": {
"from": "2147490696.U",
"to": [
"2147490806.U"
]
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0 } }
Request
Generates and returns a non-expiring JSON Web Token for the authenticated user. Allows to restrict the scope of the token by a list of permissions. Used for integration purposes.
Information: The request header must contain real credentials (i.e. not just a session cookie).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.getjsonwebtoken
- URL:https://companynode.pricefx.com/pricefx/companypartition/accountmanager.getjsonwebtoken
- 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.getjsonwebtoken \
-H 'Content-Type: application/json' \
-d '{
"data": {
"permissions": [
"CUSTOMER_ADD",
"CUSTOMER_FETCH"
]
}
}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [ … ], "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