Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Delete a User Group
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
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
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
Delete a User Group
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}
Bodyapplication/json
Set to true to assign the user to the business role. Set false to remove the business role from the user.
TypedId of the business role you want to assign or revoke. Either typedId or uniqeName is required.
Example: "8.R"
uniqueName of the business role you want to assign or revoke. Either typedId or uniqeName is required.
Example: "DASHBOARDADMIN"
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.assignbusinessrole
- URL:https://companynode.pricefx.com/pricefx/companypartition/accountmanager.assignbusinessrole
- 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.assignbusinessrole \
-H 'Content-Type: application/json' \
-d '{
"data": {
"assign": true,
"typedId": "8.R",
"uniqueName": "DASHBOARDADMIN",
"users": [
"2147491023.U",
"john.doe"
]
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0 } }
Request
Deletes a User Group. The general datasource /delete operation should NOT be used for the User Group object as this special command (/accountmanager.deletegroup) 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.deletegroup
- URL:https://companynode.pricefx.com/pricefx/companypartition/accountmanager.deletegroup
- 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.deletegroup \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "15667.UG"
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.copyuser/{userid}
- URL:https://companynode.pricefx.com/pricefx/companypartition/accountmanager.copyuser/{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.copyuser/{userid}'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