Skip to content
Pricefx REST API
/Pricefx API Reference/
/
step

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

Authentication

Operations

Admin Tools

Operations

Logics

Operations

Logs

Operations

Custom Forms

Operations

Calculated Field Sets

Operations

Jobs & Tasks

Operations

Advanced Configuration Options

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

Operations

Product Image

Operations

Configuration

Operations

Internationalization

Operations

Metadata

Operations

MCP

Operations

Clicmanager

Operations

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

Operations

Entities

otherSchemas

Schemas

tab

namestring(Tab unique name)required

Tab unique name. It can be used in URL, use URL-safe letters.

labelTranslationsobject(labelTranslations)

Object with custom translations with structure. It tries to pick label according to your language, otherwise it pick label from "" key. After that translationKey is used.

translationKeystring(Key used to find build-in translation for Tab name)

Key used to find build-in translation for Tab name. If such key exist, the translation will be used. Otherwise this string will show up on the screen.

Example: "sfdc_quotes_tabs_header"
userGroupViewDetailsstring(User group view permissions)

User group view permissions. The list of user groups which can view the tab.

Example: "admins"
userGroupEditstring(User group edit permissions)

User group edit permissions. The list of user groups which can edit the tab.

iconstring(icon)

The icon is provided by DynamicIcon component, so the icon has to be defined there

Enum"angle-double-left""angle-down""angle-down-b""angle-right""arrow-down""arrow-right""arrow-up""bars""bell""blue"
typestring(Component specifier)required

Name of the widget you would like to see on the tab. In case of dashboard, if you can specify the dashboard name via typeReference attribute.

Enum"header""items""attachments""actions""notes""customForms""workflow""workflowHistory""messages""dashboard"
typeReferencestring(Unique identifier for dashboard or logic.)

Unique identifier for dashboard or logic. The value here depends on the widget used on the Tab.

disableCheckgroup (object) or rule (object)(filter)

Filter can be a rule or a group of rules with a combining operator.

One of:

Filter Group for hiding or disabling steps or tabs.

hiddenCheckgroup (object) or rule (object)(filter)

Filter can be a rule or a group of rules with a combining operator.

One of:

Filter Group for hiding or disabling steps or tabs.

parametersobject(Static parameters for the tab.)

Static parameters for the tab. Will be passed to the tab logic (e.g. dashboard) without any changes. They can be extracted by DynamicTabs.getParameters(tab, entity) in TabComponent.

parameterMappingobject
{
  "name": "string",
  "labelTranslations": {
    "additionalProperties": "string",
    """": "string",
    "fr": "string",
    "en": "string"
  },
  "translationKey": "sfdc_quotes_tabs_header",
  "userGroupViewDetails": "admins",
  "userGroupEdit": "string",
  "icon": "angle-double-left",
  "type": "header",
  "typeReference": "string",
  "disableCheck": {
    "criteria": [null],
    "operator": "and",
    "_constructor": "AdvancedCriteria"
  },
  "hiddenCheck": {
    "criteria": [null],
    "operator": "and",
    "_constructor": "AdvancedCriteria"
  },
  "parameters": {},
  "parameterMapping": {
    "additionalProperties": "Year: inputs.Year.value",
    "property1": "string",
    "property2": "string"
  }
}

step

namestring(Step unique name)

It can be used in URL, so use URL-safe letters

labelTranslationsobject(labelTranslations)

Object with custom translations with structure. It tries to pick label according to your language, otherwise it pick label from "" key. After that translationKey is used.

translationKeystring(Key used to find build-in translation for Step name)

If such key exist, the translation will be used. Otherwise this string will show up on the screen.

userGroupViewDetailsstring(User group view permissions)

List of user groups names (separated by comma), which can view the step

userGroupEditstring(User group edit permissions)

List of user groups names (separated by comma), which can edit the step

disableCheckgroup (object) or rule (object)(filter)

Filter can be a rule or a group of rules with a combining operator.

One of:

Filter Group for hiding or disabling steps or tabs.

hiddenCheckgroup (object) or rule (object)(filter)

Filter can be a rule or a group of rules with a combining operator.

One of:

Filter Group for hiding or disabling steps or tabs.

iconstring(icon)

The icon is provided by DynamicIcon component, so the icon has to be defined there

Enum"angle-double-left""angle-down""angle-down-b""angle-right""arrow-down""arrow-right""arrow-up""bars""bell""blue"
tabsArray of objects(tab)
{
  "name": "string",
  "labelTranslations": {
    "additionalProperties": "string",
    """": "string",
    "fr": "string",
    "en": "string"
  },
  "translationKey": "string",
  "userGroupViewDetails": "string",
  "userGroupEdit": "string",
  "disableCheck": {
    "criteria": [null],
    "operator": "and",
    "_constructor": "AdvancedCriteria"
  },
  "hiddenCheck": {
    "criteria": [null],
    "operator": "and",
    "_constructor": "AdvancedCriteria"
  },
  "icon": "angle-double-left",
  "tabs": [
    { … }
  ]
}

configuration

Schema for definition of steps and tabs. This object can contains tabs array with tabs specifications or steps array (categories) with tabs inside.

namestring

Text to describe the configuration.

layoutstring

DynamicTabs can have several types of layout. Default is stepper for config with steps and tabs for only tabs.

Enum"auto""stepper""tabs""menu""wizard"
Example: "tabs"
stepsArray of objects(step)
tabsArray of objects(tab)
{
  "name": "string",
  "layout": "tabs",
  "steps": [
    { … }
  ],
  "tabs": [
    { … }
  ]
}