Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Assign a Business Role

The Pricefx Backend API

Pricefx REST API Reference

Download OpenAPI description
pricefx-server_openapi.json
pricefx-server_openapi.yaml
Overview
URL
https://www.pricefx.com
Pricefx
documentation@pricefx.com
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}

General

Operations

Products

Operations

Product Extensions

Operations

Product Image

Operations

Customers

Operations

Customer Extensions

Operations

Sellers

Operations

Seller Extensions

Operations

Condition Records

Operations

Competition Data

Operations

Imports

Operations

Data Change Requests

Operations

Lookup Tables / Company Parameters

Operations

User Admin

Operations

Assign a Business Role to a User

Request

Assigns a business role to a user.

Security
basic or X-PriceFx-jwt
Path
userIdstringrequired

The ID of the user you want to assign a role to. The userId is the typedId without the U suffix. For example, userId of the 2147490806.U is 2147490806.

Bodyapplication/json
dataobjectrequired
data.​assignbooleanrequired

Set to true to assign the business role to the user. Set false to remove the business role from the user.

data.​typedIdstringnon-emptyrequired

TypedId of the business role you want to assign or revoke. Either typedId or uniqeName is required.

Example: "8.R"
data.​uniqueNamestringnon-emptyrequired

uniqueName of the role you want to assign or revoke. Either typedId or uniqeName is required.

Example: "DASHBOARDADMIN"
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.assignbusinessrole/{userId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "assign": true,
      "typedId": "8.R",
      "uniqueName": "DASHBOARDADMIN",
      "users": [
        "2147491023.U",
        "john.doe"
      ]
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "string",
    "data": null,
    "status": 0
  }
}

Assign a Business Role

Request

Assigns a business role to multiple users.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
dataobjectrequired
data.​assignbooleanrequired

Set to true to assign the user to the business role. Set false to remove the business role from the user.

data.​typedIdstringnon-emptyrequired

TypedId of the business role you want to assign or revoke. Either typedId or uniqeName is required.

Example: "8.R"
data.​uniqueNamestringnon-emptyrequired

uniqueName of the business role you want to assign or revoke. Either typedId or uniqeName is required.

Example: "DASHBOARDADMIN"
data.​usersArray of stringsrequired

The list of users' typedIds or loginName. Can be mixed.

Example: ["2147491023.U"]
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"
      ]
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "string",
    "data": null,
    "status": 0
  }
}

Delete a User Group

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
Bodyapplication/json
dataobjectrequired

data must contain the typedId of the user group object you want to delete or all business key fields of that object type.'

data.​typedIdstringnon-emptyrequired
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"
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "string",
    "data": [ … ],
    "status": 0
  }
}

Authentication

Operations

Admin Tools

Operations

Logics

Operations

Logs

Operations

Custom Forms

Operations

Calculated Field Sets

Operations

Jobs & Tasks

Operations

Data Manager

Operations

Actions

Operations

Action Types

Operations

Price Lists

Operations

Manual Price Lists

Operations

Live Price Grids

Operations

Calculation Grids

Operations

Visual Configuration

Operations

Quotes

Operations

Contracts (Agreements & Promotions)

Operations

Visual Configuration

Operations

Rebate Agreements

Operations

Rebate Calculations

Operations

Rebate Record Group

Operations

Sales Compensations

Operations

Claim Types

Operations

Claims

Operations

Optimization

Operations

Workflow

Operations

Workflow Delegation

Operations

Attachments

To upload a file you need to perform the following actions using endpoints in this category:

  1. Create an Upload Slot
  2. Upload a File
  3. Delete an Upload Slot
Operations

Product Image

Operations

Configuration

Operations

Internationalization

Operations

Metadata

Operations

Clicmanager

Clicmanager (CLIC = "Calculable Line Item Collection") endpoints are used in the REACT version to manipulate Quote/Agreements & Promotions (Contract)/Rebate Agreement/Compensation Plan objects.

Operations

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

See the Key-Value Database Storage Knowledge Base article for more details.

Operations

Entities

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.

otherSchemas

Schemas