Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Delete a User
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
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
Get a User Audit Report
Delete a User
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
Updates details of the specified user.
Information: Note that Update a User should not be used for role or group assignments. For these operations, use APIs such as Assign a Business Role to a User or Assign a User Group to Users.
Security
basic or X-PriceFx-jwt
Specify the user by typedId and define the new value of the field you want to update in the data object.
Values before the update.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/update/U
- URL:https://companynode.pricefx.com/pricefx/companypartition/update/U
- 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/update/U \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "2147491062.U",
"email": "j.price@pricingacademy.com"
},
"oldValues": {
"version": 1,
"typedId": "2147491062.U",
"loginName": "john.pricer",
"firstName": "Tim",
"lastName": "Smith",
"email": "non@existent33.com",
"groups": [],
"businessRoles": [],
"activated": true,
"workflowEmailingActivated": true,
"noSession": true,
"requireTFA": true,
"receiveAdminEmail": true,
"ssoOnly": true,
"wizardDashboardName": null,
"firstLogin": false,
"additionalInfo1": null,
"additionalInfo2": null,
"additionalInfo3": null,
"additionalInfo4": null,
"emailLocale": null,
"defaultUserGroupEdit": "Administrators",
"defaultUserGroupViewDetails": "Administrators",
"productFilterCriteria": null,
"customerFilterCriteria": null,
"roleNames": [],
"allRoleNames": [],
"allGroups": [],
"createDate": "2021-12-12T12:59:07",
"createdBy": 2147490696,
"lastLogin": null,
"lastUpdateBy": 2147490696,
"extendedData": null,
"passwordExpiry": null,
"_key": "2147491062.U",
"_level": 0
},
"operationType": "update",
"textMatchStyle": "exact"
}'Response
application/json
{ "response": { "node": "e2e-templates-node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/U
- URL:https://companynode.pricefx.com/pricefx/companypartition/delete/U
- 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/delete/U \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "2147491062.U"
}
}'Response
application/json
{ "response": { "node": "e2e-templates-node", "data": [ … ], "status": 0 } }
Security
basic or X-PriceFx-jwt
Path
Bodyapplication/jsonSpecify whether you want to retrieve a report based on user roles (R), user groups (UG), or business roles (BR).
Enum"R""UG""BR"
Example: R
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.audit/{TypeCode}/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/accountmanager.audit/{TypeCode}/{id}
- 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.audit/R/2 \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "string", "startRow": 0, "data": [ … ], "endRow": 0, "totalRows": 0, "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