Performance Quoting APIs Change Log - Quote

Overview

Performance Quoting Quote APIs allow to perform operations on quotes.

You will find below a change tracking section to see which and how API changed between versions. View API Documentation

Current version: 1.12.9

Online Access to Documentation (via Swagger)

APIs are available here:

https://quote.YOUR_REALM_URL.proscloud.com/quotex-public-api/docs/index.html?contract=quote &token=TOKEN

Replace YOUR_REALM_URL with your realm URL (ex: us1, eu1, etc.) Generate your token from AppPortal: View API User Access

The role API_USER has to be used to generate the token.

Version Change Tracking

Changes from version 1.12.7 to version 1.12.9

WHAT’S CHANGED

PUT /quote/{quoteId}/filter/admin/{viewId}

Request:

Changed content type : application/json

Added property templateVisibility (string)
Defines the visibility based on line template type:

Enum values:

NO_AGGREGATION_LINE
AGGREGATION_LINE_ONLY
ALL_LINES

POST /quote/{quoteId}/export/json

Request:

Changed content type : application/json

Added property periodExportMode (string)

Period export mode for quotes that have periods. * MAIN_AND_PERIOD - Main line and all periods lines are provided. Only values of the not period related cell are visible on the main row. Only values of period related cell are visible on the period rows. * PERIOD_LEVEL_ONLY - The value of the not period related cell will be set for all period rows along with the specific value for the related period. * MAIN_LEVEL_ONLY - Only main row and values of not period related cell will be exported (period related cell will be provided without values if requested).

Enum values:

MAIN_AND_PERIOD
PERIOD_LEVEL_ONLY
MAIN_LEVEL_ONLY

POST /quote/{quoteId}/export/xlsx

Request:

Changed content type : application/json

Added property periodExportMode (string)

Enum values:

MAIN_AND_PERIOD
PERIOD_LEVEL_ONLY
MAIN_LEVEL_ONLY

POST /quote/{quoteId}/mscrm/synchronizeQuote

Request:

Changed content type : application/json

Changed property exportParams (object)

This object is passed in the body of the [export quote] request and specify the size of export trunks whenever trunks are required.

Added property periodExportMode (string)

Enum values:

MAIN_AND_PERIOD
PERIOD_LEVEL_ONLY
MAIN_LEVEL_ONLY
Changes from version 1.12.5 to version 1.12.7

WHAT’S NEW

POST /quote/{quoteId}/contract/massEditPeriodEndDates

Mass edit period end dates:

WHAT’S CHANGED

POST /quote/session

Parameters:

Added: X-quotex-trackable in header

Use this optional header to enable activity tracking for operations that modify quote data. When set to true, trackable operations (commands that modify the quote) will be logged in the activity tracking system. When omitted or set to false, activities will not be tracked. Note: This header is available on all APIs for consistency, but is only effective for operations that perform trackable actions (e.g., adding/deleting/modifying rows, changing field values, etc.). Read-only operations will ignore this header.

POST /quote/session/clean

Parameters:

Added: X-quotex-trackable in header

Use this optional header to enable activity tracking for operations that modify quote data. When

set to true, trackable operations (commands that modify the quote) will be logged in the activity tracking system. When omitted or set to false, activities will not be tracked. Note: This header is available on all APIs for consistency, but is only effective for operations that perform trackable actions (e.g., adding/deleting/modifying rows, changing field values, etc.). Read-only operations will ignore this header.

POST /quote

Parameters:

Added: X-quotex-trackable in header

DELETE /quote/{quoteId}

Parameters:

Added: X-quotex-trackable in header

HEAD /quote/{quoteId}

Parameters:

Added: X-quotex-trackable in header

POST /quote/delete

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/open

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/status

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/status/activateAndWait

Parameters:

Added: X-quotex-trackable in header

DELETE /quote/{quoteId}/status/deactivate

Parameters:

Added: X-quotex-trackable in header

DELETE /quote/{quoteId}/status/deactivateAndWait

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/step

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/clone

Parameters:

Added: X-quotex-trackable in header

Request:

Changed content type : application/json

Added property keepActivityTrackingMessages (boolean)

This parameter is optional. It indicates if during the clone of the quote, we want to keep the activity tracking messages of the source quote. By default, we don’t keep them.

POST /quote/{quoteId}/migration

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/row

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/row/delete

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/row/move

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/row/massMove

Parameters:

Added: X-quotex-trackable in header

Request:

Changed content type : application/json

Changed property movedRowsInfo (array)
Array of move operations, each containing rows to move and their target position:

Changed items (object):

Information about a group of rows to move and their target position

Changed property rowIds (array)
Row IDs to be moved together:

Changed items (integer -> string):

Changed property insertPoint (integer -> string)
Optional parameter - the rowId to move rows relative to (required when insertPosition is BEFORE or AFTER):

POST /quote/{quoteId}/row/duplicate

Parameters:

Added: X-quotex-trackable in header

Use this optional header to enable activity tracking for operations that modify quote data. When

POST /quote/{quoteId}/row/paste

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/lineTemplate/mapping

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/lineTemplate/resolve

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/row/cp

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/row/cp/update

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/row/cp/merge

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/row/restore

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/row/{rowId}/column/{colId}

Parameters:

Added: X-quotex-trackable in header

DELETE /quote/{quoteId}/row/{rowId}/column/{colId}

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/field/{fieldId}

Parameters:

Added: X-quotex-trackable in header

DELETE /quote/{quoteId}/field/{fieldId}

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/column/{colId}/update

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/businessStatus

Parameters:

Added: X-quotex-trackable in header

PUT /quote/{quoteId}/businessStatus

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/getFields

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/getLines

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/getData

Parameters:

Added: X-quotex-trackable in header

Request:

Changed content type : application/json

Changed property snapIds (object)

Quote and component snap Ids. These Ids can change if quote data are updated. When provided in a getData request the API will compare provided ones with current and return data only if they change.

Added property activityTrackingSnapId (integer)

Activity tracking snap Id. This Id will change if a new activity is tracked on the Quote

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json
- Changed property snapIds (object)

Quote and component snap Ids. These Ids can change if quote data are updated. When provided in a getData request the API will compare provided ones with current and return data only if they change.

Added property activityTrackingSnapId (integer)

Activity tracking snap Id. This Id will change if a new activity is tracked on the Quote

POST /quote/{quoteId}/updateData

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/getConfUserChoices

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/changeDescription

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/changeCrmQuoteId

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/contract/changeDate

Parameters:

Added: X-quotex-trackable in header

Request:

Changed content type : application/json

Changed property changeMode (string)

Change date mode.

CREATE: Create new period between previous date and the new date. EXTEND_REDUCE: Extend or reduce the previous period to the new date. GAP: A missing period will be created between the previous and the new date.

POST /quote/{quoteId}/contract/shiftDate

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/contract/renew

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/contract/amend

Parameters:

Added: X-quotex-trackable in header

PUT /quote/{quoteId}/filter/admin/{viewId}

Parameters:

Added: X-quotex-trackable in header

DELETE /quote/{quoteId}/filter/admin/{viewId}

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/rules

Parameters:

Added: X-quotex-trackable in header

PUT /quote/{quoteId}/rules

Parameters:

Added: X-quotex-trackable in header

DELETE /quote/{quoteId}/rules

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/refreshAction

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/refresh

Parameters:

Added: X-quotex-trackable in header

DELETE /quote/{quoteId}/refresh

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/exchangeRates/refresh

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/customProcess/action

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/customProcess/trigger

Parameters:

Added: X-quotex-trackable in header

GET /quote/context

Parameters:

Added: X-quotex-trackable in header

POST /quote/context

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/catalog/settings

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/export/json

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/export/xlsx

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/export/{exportId}/status

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/export/{exportId}/file

Parameters:

Added: X-quotex-trackable in header

DELETE /quote/{quoteId}/export/{exportId}

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/import

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/importFromSource

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/report

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/report/{reportId}/status

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/report/{reportId}

Parameters:

Added: X-quotex-trackable in header

DELETE /quote/{quoteId}/report/{reportId}

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/reportAction

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/longProcessing/{taskId}/status

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/longProcessing/{taskId}/report

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/command/{correlationId}/status

Parameters:

Added: X-quotex-trackable in header

Return Type:

Changed response : 200 OK

Command status:

Changed content type : application/json
- Changed property additionalInfo (object)
  This object can be returned for some type of commands when the status is Ready:
  - Added property massEditPeriodEndDateSummary (object)
    Summary information for mass edit period end dates operation:
    - Property numberOfShrinkedLines (integer)
      Number of lines where the period was shrinked:
    - Property numberOfExtendedLines (integer)
      Number of lines where the period was extended:
    - Property numberOfDeletedLines (integer)
      Number of lines that were deleted:
    - Property numberOfIgnoredWithoutPeriodLines (integer)
      Number of lines that were ignored because they are on a line template that cannot have period:

DELETE /quote/{quoteId}/command/{correlationId}/status

Parameters:

Added: X-quotex-trackable in header

POST /quote/log

Parameters:

Added: X-quotex-trackable in header

POST /quote/logs

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/debugLog

Parameters:

Added: X-quotex-trackable in header

PUT /quote/{quoteId}/debugLog

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/pushNotification

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/metadata

Parameters:

Added: X-quotex-trackable in header

PUT /quote/{quoteId}/metadata/changeTracking

Parameters:

Added: X-quotex-trackable in header

PUT /quote/{quoteId}/metadata/frozen

Parameters:

Added: X-quotex-trackable in header

GET /quote/{quoteId}/synchronizeAction

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/synchronize

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/mscrm/synchronizeQuote

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/mscrm/synchronizeOppProducts

Parameters:

Added: X-quotex-trackable in header

POST /quote/{quoteId}/mscrm/deleteOppProducts

Parameters:

Added: X-quotex-trackable in header

GET /quote/crm/encryptUserId

Parameters:

Added: X-quotex-trackable in header

POST /quote/subscription/ratePlans

Parameters:

Added: X-quotex-trackable in header

Changes from version 1.12.2 to version 1.12.3

WHAT'S NEW

POST /quote/subscription/ratePlans

This operation gets the list of rate plans with ids.

WHAT'S DELETED

GET /quote/subscription/ratePlans

This operation gets the list of all available rate plan.

Changes from version 1.11.0 to version 1.12.2

WHAT’S CHANGED

POST /quote/{quoteId}/row

Request:

Changed content type : application/json

Changed property rows (array)
All rows must have the same business value type:

Changed items (object):

Row attributes:

New optional properties:

description

POST /quote/{quoteId}/lineTemplate/resolve

Request:

Changed content type : application/json

Changed property values (array)
A columnId/value list to use for line template resolution:

Changed items (object):

Represents a column ID and a grid value as line template value:

POST /quote/{quoteId}/getLines

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json
Changed property rows (array)

Changed items (object):

A Quote line:

Changed property rowType (string)
Item type: * PRODUCT - Item * SPECIFIC - Specific item * FOLDER - Folder * GENERATED_FOLDER - Folder generated from a catalog structure * BUNDLE_PRODUCT - Product bundle * BUNDLE_SPECIFIC - Specific bundle * SUBSCRIPTION - Subscription * CHARGE - Subscription charge item:
Added enum value:
GENERATED_FOLDER
Changed property cells (array)
The row cells:

Changed items (object):

Represents data for a single cell in a row, including column ID, value and input value.

POST /quote/{quoteId}/getData

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json
Changed property rowsData (object)

Contains rows data and metadata for pagination.

Changed property rows (array)

Changed items (object):

Row data including cell values and row error status:

Changed property rowType (string)
Item type: * PRODUCT - Item * SPECIFIC - Specific item * FOLDER - Folder * GENERATED_FOLDER - Folder generated from a catalog structure * BUNDLE_PRODUCT - Product bundle * BUNDLE_SPECIFIC - Specific bundle * SUBSCRIPTION - Subscription * CHARGE - Subscription charge item:
Added enum value:
GENERATED_FOLDER

POST /quote/{quoteId}/getConfUserChoices

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json
Changed property rows (array)
The configured product rows:

Changed items (object):

Represents a single user choice, associating a row ID with a grid value.

POST /quote/{quoteId}/contract/changeDate

Request:

Changed content type : application/json

New required properties:

changeMode
dateType
Changes from version 1.10.4 to version 1.11.0

WHAT’S CHANGED

POST /quote/session

Parameters:

Deleted: X-quotex-environment in header

Deprecated: Environment identifier. This parameter is deprecated, and the environment will be

automatically retrieved. If used, the provided environment value will be checked against the environment value automatically found. This header should NOT be used to pass AppPortal environment values.

POST /quote/session/clean

Parameters:

Deleted: X-quotex-environment in header

Deprecated: Environment identifier. This parameter is deprecated, and the environment will be automatically retrieved. If used, the provided environment value will be checked against the environment value automatically found. This header should NOT be used to pass AppPortal environment values

POST /quote

Parameters:

Deleted: X-quotex-environment in header

DELETE /quote/{quoteId}

Parameters:

Deleted: X-quotex-environment in header

HEAD /quote/{quoteId}

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/open

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/status

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/status/activateAndWait

Parameters:

Deleted: X-quotex-environment in header

DELETE /quote/{quoteId}/status/deactivate

Parameters:

Deleted: X-quotex-environment in header

DELETE /quote/{quoteId}/status/deactivateAndWait

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/step

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/clone

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/migration

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/row

Description:

This operation adds rows to a quote. This operation is asynchronous, so if an error occurs, the client will not be notified.

The returned correlation ID can be used to check the command’s execution status.

You can add many rows with one request, but all rows must have the same type; allowed types are SI, FOLDER, SPECIFIC.

To add configurable product (CP type) rows please use /row/cp API.

Parameters:

Deleted: X-quotex-environment in header

Request:

Changed content type : application/json

Changed property rows (array)
All rows must have the same business value type:

Changed items (object):

Row attributes

Added property path (string)
The product path in the catalog (Optional):

POST /quote/{quoteId}/row/delete

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/row/move

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/row/duplicate

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/row/paste

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/lineTemplate/resolve

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/row/cp

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/row/cp/update

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/row/cp/merge

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/row/restore

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/row/{rowId}/column/{colId}

Parameters:

Deleted: X-quotex-environment in header

DELETE /quote/{quoteId}/row/{rowId}/column/{colId}

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/field/{fieldId}

Parameters:

Deleted: X-quotex-environment in header

DELETE /quote/{quoteId}/field/{fieldId}

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/column/{colId}/update

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/businessStatus

Parameters:

Deleted: X-quotex-environment in header

PUT /quote/{quoteId}/businessStatus

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/getFields

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/getLines

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/updateData

Request:

Changed content type : application/json

Changed property rows (array)
Identifiers of the rows to update and their new content to set:

Changed items (object):

Reference to rows to update and values to set

Changed property rowIdentifier (object)

The identifier of the row to update.

Refer to the definitions of the various UpdateDataRowIdentifier subtypes for more information. Ex. UpdateDataRowIdentifierRowId.

The ‘FullFpk’ and ‘Fpk’ modes (in rowIdType) can only be used for rows with an FPK policy of type ‘No Duplicate’ or ‘Conflicts’. Rows with conflicts will not be updated, but updates to the remaining data will still be processed. In case of ‘No Control’ policy, rows will not be updated.

POST /quote/{quoteId}/getConfUserChoices

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/changeDescription

Parameters:

Deleted: X-quotex-environment in header:

POST /quote/{quoteId}/changeCrmQuoteId

Parameters:

Deleted: X-quotex-environment in header

PUT /quote/{quoteId}/filter/admin/{viewId}

Parameters:

Deleted: X-quotex-environment in header

DELETE /quote/{quoteId}/filter/admin/{viewId}

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/rules

Parameters:

Deleted: X-quotex-environment in header

PUT /quote/{quoteId}/rules

Parameters:

Deleted: X-quotex-environment in header

DELETE /quote/{quoteId}/rules

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/refreshAction

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/refresh

Parameters:

Deleted: X-quotex-environment in header

POST /quote/context

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/catalog/settings

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/export/json

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/export/xlsx

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/export/{exportId}/status

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/export/{exportId}/file

Parameters:

Deleted: X-quotex-environment in header

DELETE /quote/{quoteId}/export/{exportId}

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/import

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/importFromSource

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/report

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/report/{reportId}/status

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/report/{reportId}

Parameters:

Deleted: X-quotex-environment in header

DELETE /quote/{quoteId}/report/{reportId}

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/reportAction

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/longProcessing/{taskId}/status

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/longProcessing/{taskId}/report

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/command/{correlationId}/status

Parameters:

Deleted: X-quotex-environment in header

DELETE /quote/{quoteId}/command/{correlationId}/status

Parameters:

Deleted: X-quotex-environment in header

POST /quote/log

Parameters:

Deleted: X-quotex-environment in header

POST /quote/logs

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/debugLog

Parameters:

Deleted: X-quotex-environment in header

PUT /quote/{quoteId}/debugLog

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/pushNotification

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/metadata

Parameters:

Deleted: X-quotex-environment in header

PUT /quote/{quoteId}/metadata/changeTracking

Parameters:

Deleted: X-quotex-environment in header

PUT /quote/{quoteId}/metadata/frozen

Parameters:

Deleted: X-quotex-environment in header

GET /quote/{quoteId}/synchronizeAction

Parameters:

Deleted: X-quotex-environment in header

POST /quote/{quoteId}/synchronize

Parameters:

Deleted: X-quotex-environment in header

Changes from version 1.8.6 to version 1.10.3

WHAT'S NEW

GET /quote/{quoteId}/catalog/settings

Retrieve catalog settings:

GET /quote/subscription/ratePlans

This operation gets the list of all available rate plans.

WHAT'S CHANGED

POST /quote/{quoteId}/contract/renew

Request:

Changed content type: application/json

Added property keepLastPeriodInfo (boolean)

Indicate if last period information of rows ending at actual contract end date should be kept.

Changes from version 1.8.3 to version 1.8.6

WHAT'S NEW

POST /quote/{quoteId}/row/duplicate

Duplicate quote rows:

POST /quote/{quoteId}/row/paste

Paste quote rows:

WHAT'S CHANGED

POST /quote/{quoteId}/updateData

Request:

Changed content type : application/json

Added property periodPolicy (string)

Policy to apply when Period related values are updated. MERGE (default value) keeps existing Periods, OVERRIDE replaces existing Periods

Enum values:

MERGE
OVERRIDE
Changes from version 1.7.2 to version 1.8.3

WHAT'S DEPRECATED

DELETE /quote/{quoteId}/status/deactivateAndWait

Deactivate Quote and wait for the end of the operation.

CAUTION: Deprecated in Version 13.1 - will be discontinued as of January 2026.

WHAT'S CHANGED

DELETE /quote/{quoteId}/status/deactivateAndWait

Deactivate Quote and wait for the end of the operation.

CAUTION: Deprecated in Version 13.1 - will be discontinued as of January 2026.

Description:

This is equivalent to the deactivate operation. The provided timeout value is ignored.

POST /quote/{quoteId}/row

Request:

Changed content type : application/json

Changed property rows (array)
All rows must have the same business value type:
- Changed items (object):
  Row attributes:
  - Added property periods (array)

Periods definition to create along with the row. If none provided, a default one will be

created if the row line template is period related.

Items (object):

Period data to create during the creation of a given row.

Property period (object)

Period start and end dates of application of value changes.

Property startDate (string)

Period start date. A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day.

Property endDate (string)

Period end date. A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day.

Property userInputs (array)
List of updated cell values:
- Items (object):
  A user input to set for the given column/variableId:
  - Property columnId (string)
    The identifier of the column where the value must be set:
  - Property inputValue (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue

Property valueType (string)
Enum values:
Empty
String
BigDecimal
Boolean
Business
Currency
DateTime
Integer
Json
LocalDate
Locale
Long
Monetary
Multiple
Percentage
UnitOfMeasure:
Xml
Html
Url
ScaleGrid
Attachment
Error
Period
Measure
CurrencyPerQuantity
- MonetaryPerQuantity

Changed property businessValueType (string)
Item type:
SI - Standard item
FOLDER - Folder row
SPECIFIC - Specific row
BUNDLE_SPECIFIC - For specific bundles

Added enum value:

BUNDLE_SPECIFIC

POST /quote/{quoteId}/getData

Return Type:

Changed response: 200 OK

Successful response:

Changed content type : application/json
- Changed property fieldsData (array)

The requested field data. If a provided field Id is not found it will be included with an empty value

Added property dataProviderInformation (object)
optional cell related data provider information:
- Property name (string)
- Property identifier (string)
- Property type (string)

Changed property rowsData (object)

Contains rows data and metadata for pagination.

Changed property rows (array)
Row data including cell values and row error status:
- Changed property cells (array)
  The row cells:

Changed items (object): > Cell content and information

Added property dataProviderInformation (object)
optional cell related data provider information:
- Property name (string)
- Property identifier (string)
- Property type (string)

POST /quote/{quoteId}/updateData

Request:

Changed content type : application/json

Changed property fields (array)
Identifiers of the fields to update and their new content to set:
- Changed items (object):

Field or cell value and identifier. For cells the identifier is for the corresponding column

Changed property id (string)
Field or column identifier (_SYS_ROW_ITEM is supported only for FOLDER / SPECIFIC / BUNDLE_SPECIFIC type):

Changed property rows (array)
Identifiers of the rows to update and their new content to set:
- Changed items (object):
  Reference to rows to update and values to set:
  - Changed property updates (array)

The list of row updates.

For a normal row this will contain only one element, for a row with periods this can contain as many items as periods to update:

Changed items (object):

Row data values updates.

New optional properties:
- cellValues
Changed property period (object)

Period start and end dates of application of value changes. Only if line date

Added property deletePeriod (boolean)

delete the period. only applicable if there's a period definition.

Changed property cellValues (array)
List of updated cell values:
- Changed items (object):

Field or cell value and identifier. For cells the identifier is for the corresponding column

Changed property id (string)
Field or column identifier (_SYS_ROW_ITEM is supported only for FOLDER / SPECIFIC / BUNDLE_SPECIFIC type):

GET /quote/{quoteId}/refreshAction

Return Type:

Changed response: 200 OK

Success:

Changed content type : application/json
- Added property available (boolean)

Action availability status. You can check on this status before starting the action.

GET /quote/{quoteId}/customProcess/action

Return Type:

Changed response: 200 OK

Success:

Changed content type : application/json
- Added property available (boolean)

Action availability status. You can check on this status before starting the action.

GET /quote/{quoteId}/reportAction

Return Type:

Changed response: 200 OK

Success:

Changed content type : application/json
- Added property available (boolean)

Action availability status. You can check on this status before starting the action.

GET /quote/{quoteId}/synchronizeAction

Get salesforce CRM synchronization actions:

Return Type:

Changed response: 200 OK

Success:

Changed content type : application/json
- Added property available (boolean)

Action availability status. You can check on this status before starting the action.

Changes from version 1.6.9 to version 1.7.2

WHAT'S NEW

GET /quote/{quoteId}/customProcess/action

Get custom process trigger actions:

POST /quote/{quoteId}/customProcess/trigger

Trigger a custom process:

WHAT'S DELETED

POST /quote/{quoteId}/sharing/url

Generate a shared Quote URL - BETA version, API signature is subject to change.

GET /quote/sharing/my-quotes

Get list of my Quotes:

GET /quote/sharing/shared-quotes

Get list of Quotes shared with me:

GET /quote/{quoteId}/collaboration/status/targets

Get collaboration status targets:

`POST` /quote/{quoteId}/collaboration/status

Change collaboration status for a Quote:

POST /quote/{quoteId}/collaboration/negociation-rights

Set negociation rights on a Quote:

GET /quote/collaboration/quotes

Get collaboration quotes:

GET /quote/collaboration/quotes/user

Get collaboration quotes for the current user:

WHAT'S CHANGED

DELETE /quote/{quoteId}/status/deactivate

Description:

This will change Quote status to 'Inactive'. Execution of this request is asynchronous

Changes from version 1.6.5 to version 1.6.8

WHAT'S NEW

POST /quote/{quoteId}/row/move

Move rows to quote:

POST /quote/{quoteId}/changeDescription

Update the quote description:

POST /quote/{quoteId}/changeCrmQuoteId

Update the CRM Quote Id:

GET /quote/{quoteId}/collaboration/status/targets:

Get collaboration status targets

POST /quote/{quoteId}/collaboration/status

Change collaboration status for a Quote:

POST /quote/{quoteId}/collaboration/negociation-rights

Set negociation rights on a Quote:

GET /quote/collaboration/quotes

Get collaboration quotes:

GET /quote/collaboration/quotes/user

Get collaboration quotes for the current user:

WHAT'S CHANGED

POST /quote/session

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/session/clean

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Request:

Changed content type : application/json

Added property crmQuoteId (string)

Return Type:

Changed response : 200 OK

Quote creation is successful.

Changed response : default

Error response:

Changed content type : application/json

DELETE /quote/{quoteId}

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

HEAD /quote/{quoteId}

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type :application/json

POST /quote/delete

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/open

Description:

Open a quote. This will activate the quote and open a user session. Quote data can be refreshed if this is specified in the model. If a quote migration is necessary it will be performed. This is an async operation, you must set a RETRY on this operation as it could timeout in case of long refresh time or long migration time. In case of retry you must provide the "processId" value returned by the first API call.

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Request:

Changed content type : application/json

Changed property timeout (integer)

Open operation timeout in seconds. If the process is still in progress after this timeout value the API will provide a process id to retry the operation and to continue where it stopped during the first call. Please notice that this timeout value cannot be precise and is used to limit wait time for a single request : It's not an Http timeout. This value can be majored by network request time and some server internal processing time.

Return Type:

Changed response : 200 OK

Successful response. Quote opening finished. See response content for more information

Changed content type : application/json
Changed property processId (string)
The quote opening operation id, must be returned back when retrying the operation:
Changed property state (string)
The quote opening state:
MIGRATING - Your model evolved and quote is migrating to the new model:

Changed response : 202 Accepted

Successful response. Quote opening in ongoing. See response content for more information

Changed content type : application/json
Changed property processId (string)
The quote opening operation id, must be returned back when retrying the operation:
Changed property state (string)
The quote opening state:

Changed response : default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/status

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/status/activateAndWait

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

DELETE /quote/{quoteId}/status/deactivate

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

DELETE /quote/{quoteId}/status/deactivateAndWait

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/step

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST/quote/{quoteId}/clone

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Request:

Changed content type : application/json

Added property crmQuoteId (string)
The CRM Quote Id:

Return Type:

Changed response : 200 OK

Quote creation is successful.

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/migration

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/row

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Request:

Changed content type : application/json

Changed property insertPoint (string)

Deprecated. Use insertPoints instead. This parameter or its substitute insertPoints is mandatory only if the insert position is set to BEFORE or AFTER, rows will be then added before or after the insert Point. The insertPoint is a rowId, it can be retrieved from the quote export.

Changed property dataProviderName (string)

This parameter is mandatory only if the rows list contains items with business value type SI. The data provider will be used to get the standard item information.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/row/delete

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/lineTemplate/mapping

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/lineTemplate/resolve

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type: application/json

POST /quote/{quoteId}/row/cp

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Request:

Changed content type : application/json

Changed property insertPoints (array)

This parameter is mandatory only if the insert position is set to BEFORE or AFTER, rows will be then added before or after the insert Points. An insertPoint is a rowId, it can be retrieved from the quote export.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/row/cp/update

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/row/cp/merge

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Request:

Changed content type : application/json

Changed property insertPoints (array)

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/row/restore

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/row/{rowId}/column/{colId}

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

DELETE /quote/{quoteId}/row/{rowId}/column/{colId}

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/field/{fieldId}

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : `application/json`

DELETE /quote/{quoteId}/field/{fieldId}

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/column/{colId}/update

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/businessStatus

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

PUT /quote/{quoteId}/businessStatus

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/getFields

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json
Changed property fields (array)

Changed items (object):

The requested fields information. If a provided field Id is not found it will be included with a null value

Changed property isUserInput (boolean)
Indicate whether value is computed or comes from a user input:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/getLines

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header:

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response: default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/getData

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Request:

Changed content type : application/json

Changed property weaklyConsistent (boolean)

Set to true to get the most recent data. This will return partial updates of the quote if there are any before the full propagation of all computations. This is generally for user interface needs.

By default this parameter is set to false and only committed updates will be returned.

Return Type:

Changed response: 200 OK

Successful response:

Changed content type : application/json
- Changed property fieldsData (array)

Changed items (object): > The requested field data. If a provided field Id is not found it will be included with an empty value

Changed property isUserInput (boolean)
Indicate whether value is computed or comes from a user input:

Changed property rowsData (object)

Contains rows data and metadata for pagination.

Changed property rows (array)

Changed items (object): > Row data including cell values and row error status

Changed property rowId (string):

The row identifier

Changed property cells (array)
The row cells:

Changed items (object): > Cell content and information

Changed property isUserInput (boolean)
Indicate whether value is computed or comes from a user input:

Changed response: default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/updateData

Update Quote data including fields and cells values:

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation.

Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response: default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/getConfUserChoices

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response: default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/contract/changeDate

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response: default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/contract/shiftDate

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response: default

Error response:

Changed content type: application/json

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response: default:

Error response

Changed content type: application/json

POST /quote/{quoteId}/contract/renew

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response: default

Error response:

Changed content type: application/json

POST /quote/{quoteId}/contract/amend

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response: default

Error response:

Changed content type: application/json

PUT /quote/{quoteId}/filter/admin/{viewId}

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Request:

Changed content type: application/json

Changed property description (string)

The filter description. This will be associated to the filter in the UI.

Changed property productRestrictions (array)

List of filter restrictions to be applied on single product rows. This is an optional attribute, if no restriction is provided the view filter restriction only will be applied. The list of provided restrictions is executed in the given order.

Changed items (object): > A filter restriction to apply on the grid

Changed property folderRestrictions (array)

List of filter restrictions to be applied on folders.

Changed items (object): > A filter restriction to apply on the grid

Return Type:

Changed response: default

Error response:

Changed content type: application/json

DELETE /quote/{quoteId}/filter/admin/{viewId}

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response: default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/rules

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response: 200 OK

Successful response.

Changed content type : application/json
- Changed property rules (array)
  List of user rules applied on the Quote:

Changed items (object): > A user computation rule

Changed property filterRestrictions (array)
Restrictions list to filter lines on which rules should be applied:

Changed items (object): > A filter restriction to apply on the grid

Changed response: default

Error response:

Changed content type : application/json

PUT /quote/{quoteId}/rules

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Request:

Changed content type : application/json

Changed property rules (array)
List user rules to be applied on the Quote:

Changed items (object): > A user computation rule to apply

Changed property filterRestrictions (array)
Restrictions list to filter lines on which rules should be applied:

Changed items (object): > A filter restriction to apply on the grid

Return Type:

Changed response: default

Error response:

Changed content type : application/json

DELETE /quote/{quoteId}/rules

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response: default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/refreshAction

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/refresh

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : 200 OK

Successful response. The refresh operation started.

Changed response : default

Error response:

Changed content type : application/json

DELETE /quote/{quoteId}/refresh

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/exchangeRates/refresh

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

GET /quote/context

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/context

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Request:

Changed content type : application/json

Changed property refreshContext (boolean)

Starts a refresh of context values in quote. This will trigger a command and the correlationId will be returned in response. If refreshContext equals true, the quoteId must be provided.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/export/json

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/export/xlsx

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/export/{exportId}/status

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/export/{exportId}/file

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/octet-stream
Changed content type : application/json
Changed content type : application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

DELETE /quote/{quoteId}/export/{exportId}

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/import

Parameters

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation.

Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

REQUEST

Changed content type: multipart/form-data

Changed property importFile (string)

File to import must be xlsx or json file. For technical integrations, json format must be used, excel format being reserved for integrations offering direct import via a user interface.

Changed property insertPoint (string)

This parameter is mandatory only if the insert position is set to BEFORE or AFTER, rows will be then added before or after the insert Point. The insertPoint is a rowId, it can be retrieved from the quote export.

Changed property replacementType (string)

Optional. If not set default value NONE will be used

NONE - No replacement
REPLACE - Only replace non eligible products with a replacement product
FORCE - Replace all products with a replacement product

RETURN TYPE

Changed response: default

Error response:

Changed content type: application/json

POST /quote/{quoteId}/importFromSource

PARAMETERS

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

REQUEST

Changed content type: multipart/form-data

Changed property insertPoint (string)

RETURN TYPE

Changed response: default

Error response:

Changed content type: application/json

POST /quote/{quoteId}/sharing/url

PARAMETERS

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

REQUEST

Changed content type: application/json

New required properties:

mailTo
quoteDescription
Added property quoteDescription (string)
The quote description:
Deleted property editPassword (string)
The password used:
Changed property accessMode (string)

The access mode. VIEW view only, without password. VIEW_PASSWORD view only, view is password protected. APP_PORTAL_USER_VIEW view only, app portal protected.

APP_PORTAL_USER_VIEW_EDIT view and edit, app portal protected.

Removed enum values:

VIEW_EDIT
EDIT_PASSWORD
VIEW_EDIT_PASSWORD
- Changed property mailTo (string -> array)
  The email list of the quote recipients, it should contain at least one element:

RETURN TYPE

Changed response: default

Error response:

Changed content type: application/json

GET /quote/sharing/my-quotes

PARAMETERS

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation.

Must be a UUID without "-" characters.

RETURN TYPE

Changed response: 200 OK

Successful response.

Changed content type: application/json
- Changed property allQuotesContributors (array)
  The list of contributors on all my Quotes:
- Changed property quotes (array)

Changed items (object):

Added property lastUpdateDate (string)
The Quote last update date as defined by date-time in RFC3339 format with date-time= full-date 'T' full-time example: '2024-02-21T17:32:28':
Added property highlightedFields (array)
List of additional fields related to the Quote:

Items (object):

Property fieldId (string)
The field identifier:
Property value (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue

Property valueType (string)

Enum values:

Empty
String
BigDecimal
Boolean
Business
Currency
DateTime
Integer
Json
LocalDate
Locale
Long
Monetary
Multiple
Percentage
UnitOfMeasure
Xml
Html
Url
ScaleGrid
Attachment
Error
Period
Measure
CurrencyPerQuantity
MonetaryPerQuantity

Changed response: default

Error response:

Changed content type: application/json

GET /quote/sharing/shared-quotes

PARAMETERS

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

RETURN TYPE

Changed response: 200 OK

Successful response.

Changed content type: application/json
- Changed property quotes (array)

Changed items (object):

Added property lastUpdateDate (string)
The Quote last update date as defined by date-time in RFC3339 format with date-time= full-date 'T' full-time example: '2024-02-21T17:32:28':
Added property highlightedFields (array)
List of additional fields related to the Quote:

Items (object):

Property fieldId (string)
The field identifier:
Property value (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue

Property valueType (string)

Enum values:

Empty
String
BigDecimal
Boolean
Business
Currency
DateTime
Integer
Json
LocalDate
Locale
Long
Monetary
Multiple
Percentage
UnitOfMeasure
Xml
Html
Url
ScaleGrid
Attachment
Error
Period
Measure
CurrencyPerQuantity
MonetaryPerQuantity

Changed response: default

Error response:

Changed content type: application/json

POST /quote/{quoteId}/report

PARAMETERS

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

RETURN TYPE

Changed response: default

Error response:

Changed content type: application/json

GET /quote/{quoteId}/report/{reportId}/status

PARAMETERS

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

RETURN TYPE

Changed response: 200 OK

Report status success response:

Changed content type: application/json
Changed response: default:
Error response
Changed content type: application/json

GET /quote/{quoteId}/report/{reportId}

PARAMETERS

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

RETURN TYPE

Changed response: default

Error response:

**Changed content type: application/octet-stream
**Changed content type: application/json
**Changed content type: application/pdf
**Changed content type: application/msword
**Changed content type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
**Changed content type: application/vnd.ms-excel
**Changed content type: `application/vnd.openxmlformats-officed

Parameters:

Changed: Request-Id in header:

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response: default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/longProcessing/{taskId}/status

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response: default

Error response:

Changed content type: application/json

GET /quote/{quoteId}/longProcessing/{taskId}/report

Description:

This operation retrieves a long processing report file by its taskId. File type can be text or zip. A long processing report is available for every API that returns a taskId (Export/Import/Document Generation). The long processing report can be retrieved only if the long processing status is known.

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response: default

Error response:

Changed content type : application/octet-stream
Changed content type : application/json
Changed content type : text/plain
Changed content type : application/zip

GET /quote/{quoteId}/command/{correlationId}/status

Description:

This operation returns the status of the given command. Warning: As for any status polling API of this kind, a proper waiting strategy between calls is mandatory, see recommendations at the beginning of this document.

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response: default

Error response:

Changed content type : application/json

DELETE /quote/{quoteId}/command/{correlationId}/status

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/log

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/logs

Parameters:

Changed: Request-Id in header:

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/debugLog

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

PUT /quote/{quoteId}/debugLog

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/pushNotification

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/metadata

Return Type:

Changed response : default

Error response:

Changed content type : application/json

PUT /quote/{quoteId}/metadata/changeTracking

Return Type:

Changed response : default

Error response:

Changed content type : application/json

PUT /quote/{quoteId}/metadata/frozen

Return Type:

Changed response : default

Error response:

Changed content type : application/json

GET /quote/{quoteId}/synchronizeAction

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/synchronize

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : default

Error response:

Changed content type : application/json

POST /quote/{quoteId}/mscrm/synchronizeQuote

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : 400 Bad Request

Bad request. Invalid parameters

Changed content type : application/json

Changed response : 404 Not Found

Bad request. The Quote was not found

Changed content type : application/json

Changed response : 409 Conflict

Conflict. The dynamics CRM synchronization is not active for this tenant

Changed content type : application/json

Changed response : 500 Internal Server Error

Error response:

Changed content type : application/json

POST /quote/{quoteId}/mscrm/synchronizeOppProducts

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : 400 Bad Request

Bad request. Invalid parameters

Changed content type : application/json

Changed response : 404 Not Found

Bad request. The Quote was not found

Changed content type : application/json

Changed response : 409 Conflict

Conflict. The dynamics CRM synchronization is not active for this tenant

Changed content type : application/json

Changed response : 500 Internal Server Error

Error response:

Changed content type : application/json

POST /quote/{quoteId}/mscrm/deleteOppProducts

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Changed: X-quotex-modelId in header

Use this optional header to pass modelId retrieved after calling the open quote API.

Return Type:

Changed response : 400 Bad Request

Bad request. Invalid parameters

Changed content type : application/json

Changed response : 404 Not Found

Bad request. The Quote was not found

Changed content type : application/json

Changed response : 409 Conflict

Conflict. The dynamics CRM synchronization is not active for this tenant

Changed content type : application/json

Changed response : 500 Internal Server Error

Error response:

Changed content type : application/json

GET /quote/crm/encryptUserId

Parameters:

Changed: Request-Id in header

Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Return Type:

Changed response : 400 Bad Request

Bad request. Invalid parameters

Changed content type : application/json

Changed response : 500 Internal Server Error

Error response:

Changed content type : application/json
Changes from version 1.5.9 to version 1.6.2

WHAT'S NEW

POST /quote/{quoteId}/updateData

Update Quote data including fields and calls values:

POST /quote/{quoteId}/sharing/url

Generate a shared Quote URL - BETA version, API signature is subject to change.

GET /quote/sharing/my-quotes

Get a list of my Quotes:

GET /quote/sharing/shared-quotes

Get list of Quotes shared with me:

POST /quote/{quoteId}/mscrm/synchronizeQuote

This operation synchronizes the quote content with an MS dynamics CRM.

POST /quote/{quoteId}/mscrm/synchronizeOppProducts

This operation synchronizes opportunity products with an MS dynamics CRM.

POST /quote/{quoteId}/mscrm/deleteOppProducts

This operation synchronizes opportunity products with an MS Dynamics CRM.

WHAT'S DELETED

GET /quote/{quoteId}/getErrors

Get quote errors and warnings - BETA version, API signature is subject to change.

GET /quote/{quoteId}/domain/{id}

Retrieve a cell or field domain - BETA version, API signature is subject to change.

POST /quote/{quoteId}/collaborationPortal/url

Generate a new collaboration portal URL - BETA version, API signature is subject to change.

GET /quote/{quoteId}/accessRights

Retrieve Quote Access Rights - BETA version, API signature is subject to change.

GET /quote/{quoteId}/sessionStates

Retrieve Quote session states - BETA version, API signature is subject to change.

WHAT'S CHANGED

POST /quote/{quoteId}/open

Description:

Open a quote. This will activate the quote and open a user session. Quote data can be refreshed if this is specified in the model. If a quote migration is necessary it will be performed. This is an async operation, you must set a RETRY on this operation as it could timeout in case of a long refresh time or a long migration time. In case of a retry you must provide the "processId" value returned by the first API call.

DELETE /quote/{quoteId}/status/deactivateAndWait

Description:

This operation deactivates a quote and waits for the end of the operation during a defined:

timeout.

If timeout is reached, the quote deactivation may still be in progress and the client may retry this call.

The default timeout if not provided will be 5s or the maximum default value accepted by the server

POST /quote/{quoteId}/getData

Return Type:

Changed response: 200 OK

Successful response:

Changed content type : application/json
- Changed property fieldsData (array)

Changed items (object):

The requested field data. If a provided field ID is not found it will be included with an empty value

New required properties:

visible
Added property visible (boolean)
- True if the field can be viewed by the user

Changed property rowsData (object)
- Contains rows data and metadata for pagination.
- Changed property rows (array)
  Changed items (object):
  Row data including cell values and row error status
  The row cells
  Changed items (object):
  Cell content and information
  New required properties:
  visible
  Added property visible (boolean)
  true if cell can be viewed by user

GET /quote/{quoteId}/synchronizeAction

Description:

This operation returns the list of synchronization actions that can be executed on the quote. Actions are retrieved from the quote model and concern Salesforce CRM.

POST /quote/{quoteId}/synchronize

This operation synchronizes the quote with a salesforce CRM.

POST /quote/{quoteId}/export

Request:

Changed content type : application/json

Added property exportHistoricalPeriods (boolean)

True if historical periods, periods before amendment date, will be exported.

POST /quote/{quoteId}/export/json

Request:

Changed content type : application/json

Added property exportHistoricalPeriods (boolean)

True if historical periods, periods before amendment date, will be exported.

POST /quote/{quoteId}/export/xlsx

Request:

Changed content type : application/json

Added property exportHistoricalPeriods (boolean)

True if historical periods, periods before amendment date, will be exported.

GET /quote/{quoteId}/command/{correlationId}/status

Return Type:

Changed response: 200 OK

Command status:

Changed content type : application/json
- Changed property additionalInfo (object)
  - This object can be returned for some type of commands when the status is Ready
- Added property nbrUpdatedFields (integer)
  - Number of updated fields. This information is available only for update of data operation status
- Added property nbrFailedFields (integer)
  - Number of failed fields. This information is available only for update of data operation status
- Added property nbrUpdatedRows (integer)
  - Number of updated rows. This information is available only for update of data operation status
- Added property nbrPartlyUpdatedRows (integer)
  - Number of partly updated rows, this means that all requested updates were not applied. This information is available only for update of data operation status
- Changed property rowIds (array)
  - List of added rowId in case of Add rows operation
- Changed property nbrFailedRows (integer)
  - Number of failed rows. This information is available only for import operation and update data status
    Changes from version 1.4.8 to version 1.5.9

WHAT’S NEW

GET /quote/{quoteId}/lineTemplate/mapping

Get mappings for line template resolution.

POST /quote/{quoteId}/collaborationPortal/url

Generate a new collaboration portal URL - BETA version, API signature is subject to change.

GET /quote/{quoteId}/debugLog

Get debug log status:

PUT /quote/{quoteId}/debugLog

Update debug log status:

GET /quote/{quoteId}/sessionStates

Retrieve Quote session states - BETA version, API signature is subject to change.

WHAT’S CHANGED

DELETE /quote/session

Close multiple Quotes session. Deprecated in Version 12.13 - will be discontinued as of May 2024. Can be replaced by POST /quote/session/clean.

POST /quote/{quoteId}/rows

Add rows to quote. Deprecated before Version 12.13 - will be discontinued as of May 2024. Can be replaced by POST /quote/{quoteId}/row

DELETE /quote/{quoteId}/row

Delete rows from a quote. Deprecated before Version 12.13 - will be discontinued as of May 2024. Can be replaced by POST /quote/{quoteId}/row/delete.

POST /quote/{quoteId}/getData

Request:

Changed content type : application/json

Changed property pageNumber (integer)

The page number, pages start at index 1. If set to 0, rows will not be requested unless specific rows are requested with their Ids

POST /quote/{quoteId}/contract/shiftDate

Description:

This operation can be used to shift contract dates by a provided number of days, to the future or to the past.

For example shift contract start and end dates by 20 days forward. It also shifts all period values of the quote.

Request:

Changed content type : application/json

New required properties:

shiftDaysNumber

New optional properties:

shiftValue
temporalUnit
Added property shiftDaysNumber (integer)

Number of days to shift contract dates with. For example 2 to shift dates 2 days in the future. Can be negative to shift to the past.

Deleted property shiftValue (integer)

Value to shift contract dates with. For example 2 to shift dates with 2 DAYS, 2 MONTHS or 2 YEARS

Deleted property temporalUnit (string)

Temporal unit to shift dates with.

PUT /quote/{quoteId}/filter/admin/{viewId}

Request:

Changed content type : application/json

Changed property productRestrictions (array)

Changed items (object):

A filter resctriction to apply on the grid

Changed property operator (string)

FilterOperator to apply for the restriction. Must be compatible with the column type.

In case of multiple values OR logic is used between values. Each operator value has a defined number of value elements. For columns of type Business or URL StringGridValue should be used for the restriction with valueProperty or urlProperty. Here are details for each operator

CONTAINS - Can be used with multiple values. Supported grid values : String
EQUAL - Can be used with multiple values. BigDecimal, Boolean, CURRENCY, DateTime, Integer, LocalDate, Long, Monetary, Percentage, String, UnitOfMeasure
NOT_EQUAL - Can be used with multiple values. BigDecimal, Boolean, CURRENCY, DateTime, Integer, LocalDate, Long, Monetary, Percentage, String, UnitOfMeasure
STARTS_WITH - Can be used with multiple values. Supported grid values : String
ENDS_WITH - Can be used with multiple values. Supported grid values : String
CONTAINS_ALL - Can be used with multiple values. Supported grid values : String
CONTAINS_ANY - Can be used with multiple values. Supported grid values : String
GREATER_THAN - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
GREATER_THAN_OR_EQUAL - Can be used with a single value. Supported grid values :
BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage:
LOWER_THAN - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
LOWER_THAN_OR_EQUAL - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
BETWEEN - Can be used with multiple values. Each time with two elements (lower bound and upper bound). Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
IS_EMPTY - Should not provide a value for this filter operator
IS_IN_ERROR - Should not provide a value for this filter operator
IS_IN_WARNING - Should not provide a value for this filter operator

List of filter values.

Changed items (object):

A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator. See operator doc for more information.
See ‘GridValue’ subtypes for list of available value element types.
If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in ‘valueProperty’ for a business column and in ‘urlProperty’ for an url column
- Changed property urlProperty (string)

If the column is of type url. A StringValue can be used for the restriction value and set here the url value property to use

Changed property folderRestrictions (array)

List of filter restrictions to be applied on folders.

Changed items (object):

A filter resctriction to apply on the grid

Changed property operator (string)

FilterOperator to apply for the restriction. Must be compatible with the column type.

CONTAINS - Can be used with multiple values. Supported grid values : String
EQUAL - Can be used with multiple values. BigDecimal, Boolean, CURRENCY, DateTime, Integer, LocalDate, Long, Monetary, Percentage, String, UnitOfMeasure
NOT_EQUAL - Can be used with multiple values. BigDecimal, Boolean, CURRENCY, DateTime, Integer, LocalDate, Long, Monetary, Percentage, String, UnitOfMeasure
STARTS_WITH - Can be used with multiple values. Supported grid values : String
ENDS_WITH - Can be used with multiple values. Supported grid values : String
CONTAINS_ALL - Can be used with multiple values. Supported grid values : String
CONTAINS_ANY - Can be used with multiple values. Supported grid values : String
GREATER_THAN - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
GREATER_THAN_OR_EQUAL - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
LOWER_THAN - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
LOWER_THAN_OR_EQUAL - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
BETWEEN - Can be used with multiple values. Each time with two elements (lower bound and upper bound). Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
IS_EMPTY - Should not provide a value for this filter operator
IS_IN_ERROR - Should not provide a value for this filter operator
IS_IN_WARNING - Should not provide a value for this filter operator:

Changed property values (array)

List of filter values.

Changed items (object):

A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator. See operator doc for more information.
See ‘GridValue’ subtypes for list of available value element types.
If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in ‘valueProperty’ for a business column and in ‘urlProperty’ for an url column
- Changed property urlProperty (string)

If the column is of type url. A StringValue can be used for the restriction value and set here the url value property to use

GET /quote/{quoteId}/rules

Return Type:

Changed response : 200 OK

Successful response.

Changed content type : application/json
- Changed property rules (array)
  List of user rules applied on the Quote:

Changed items (object):

A user computation rule
- Changed property filterRestrictions (array)
  Restrictions list to filter lines on which rules should be applied:

Changed items (object):

A filter resctriction to apply on the grid
- Changed property operator (string)

FilterOperator to apply for the restriction. Must be compatible with the column type.

CONTAINS - Can be used with multiple values. Supported grid values : String
- EQUAL - Can be used with multiple values. BigDecimal, Boolean, CURRENCY, DateTime, Integer, LocalDate, Long, Monetary, Percentage, String, UnitOfMeasure
- NOT_EQUAL - Can be used with multiple values. BigDecimal, Boolean, CURRENCY, DateTime, Integer, LocalDate, Long, Monetary, Percentage, String, UnitOfMeasure
STARTS_WITH - Can be used with multiple values. Supported grid values : String
ENDS_WITH - Can be used with multiple values. Supported grid values : String
CONTAINS_ALL - Can be used with multiple values. Supported grid values : String
CONTAINS_ANY - Can be used with multiple values. Supported grid values : String
- GREATER_THAN - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
GREATER_THAN_OR_EQUAL - Can be used with a single value. Supported grid values

: BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage

LOWER_THAN - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage

LOWER_THAN_OR_EQUAL - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
BETWEEN - Can be used with multiple values. Each time with two elements (lower bound and upper bound). Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage

IS_EMPTY - Should not provide a value for this filter operator
IS_IN_ERROR - Should not provide a value for this filter operator
IS_IN_WARNING - Should not provide a value for this filter operator
- Changed property values (array)

List of filter values.

Changed items (object):

A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator. See operator doc for more information.
See ‘GridValue’ subtypes for list of available value element types.
If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in ‘valueProperty’ for a business column and in ‘urlProperty’ for an url column
- Changed property urlProperty (string)

If the column is of type url. A StringValue can be used for the restriction value and set here the url value property to use

PUT /quote/{quoteId}/rules

Request:

Changed content type : application/json

Changed property rules (array)
List user rules to be applied on the Quote:

Changed items (object):

A user computation rule to apply
- Changed property filterRestrictions (array)
  Restrictions list to filter lines on which rules should be applied:

Changed items (object):

A filter resctriction to apply on the grid
- Changed property operator (string)

FilterOperator to apply for the restriction. Must be compatible with the column type.

CONTAINS - Can be used with multiple values. Supported grid values : String
EQUAL - Can be used with multiple values. BigDecimal, Boolean, CURRENCY, DateTime, Integer, LocalDate, Long, Monetary, Percentage, String, UnitOfMeasure
NOT_EQUAL - Can be used with multiple values. BigDecimal, Boolean, CURRENCY,
DateTime, Integer, LocalDate, Long, Monetary, Percentage, String, UnitOfMeasure:
STARTS_WITH - Can be used with multiple values. Supported grid values : String
ENDS_WITH - Can be used with multiple values. Supported grid values : String
CONTAINS_ALL - Can be used with multiple values. Supported grid values : String
CONTAINS_ANY - Can be used with multiple values. Supported grid values : String
GREATER_THAN - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
GREATER_THAN_OR_EQUAL - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
LOWER_THAN - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
LOWER_THAN_OR_EQUAL - Can be used with a single value. Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
BETWEEN - Can be used with multiple values. Each time with two elements (lower bound and upper bound). Supported grid values : BigDecimal, DateTime, Integer, LocalDate, Long, Monetary, Percentage
IS_EMPTY - Should not provide a value for this filter operator
IS_IN_ERROR - Should not provide a value for this filter operator
IS_IN_WARNING - Should not provide a value for this filter operator
Changed property values (array)
List of filter values.

Changed items (object):

A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator. See operator doc for more information.
See ‘GridValue’ subtypes for list of available value element types.
If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in ‘valueProperty’ for a business column and in ‘urlProperty’ for an url column
- Changed property urlProperty (string)

If the column is of type url. A StringValue can be used for the restriction value and set here the url value property to use

POST /quote/{quoteId}/export

Export quote content. Deprecated before Version 12.13 - will be discontinued as of May 2024. Can be replaced by POST /quote/{quoteId}/export/json.

Request:

Changed content type : application/json

New optional properties:

linesPerPart
Changed property linesPerPart (integer)

The quote grid will be exported in many parts depending on the specified number of lines to export per part. The minimal value is 100 but for large quotes it’s strongly recommended to use 200 or more to limit the number of pages to 50.

POST /quote/{quoteId}/export/json

Request:

Changed content type : application/json

New optional properties:

linesPerPart
Changed property linesPerPart (integer)

Changes from version 1.4.4 to version 1.4.8

WHAT'S NEW

POST /quote/{quoteId}/getData

Get Quote data including fields and lines values:

DELETE /quote/{quoteId}/refresh

Clear/Cancel a refresh command:

WHAT'S DELETED

GET /quote/{quoteId}/export/{exportId}

Get Export. Deprecated before Version 12.13 - will be discontinued as of september 2023. Can be replaced by POST /quote/{quoteId}/export/{export}/file.

WHAT'S CHANGED

POST /quote/{quoteId}/lineTemplate/resolve

Request:

Changed content type : application/json

Changed property values (array)
A columnId/value list to use for line template resolution:

Changed items (object):
* Changed property `value` (object)
See different GridValue subtypes definitions for more information.
Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

POST /quote/{quoteId}/rows

Request:

Changed content type : application/json

Changed property rows (array)
All rows must have the same business value type:

Changed items (object):
Row attributes
* Changed property `userInputs` (array)
Inputs to set or override when adding an item: Can be a mix of resolution/local variables and user inputs: <br> <ul> <li>Resolution and local variables: can change if product is refreshed. Have no access right check. </li> <li>User inputs: Will not change if product is refreshed.
Access rights are checked. </li> </ul> Changed items (object):
A user input to set for the given column/variableId
* Changed property `inputValue` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

POST /quote/{quoteId}/row

Request:

Changed content type : application/json

Changed property rows (array)

All rows must have the same business value type

Changed items (object):
Row attributes
* Changed property `userInputs` (array)

Inputs to set or override when adding an item: Can be a mix of resolution/local variables and user inputs: <br> <ul> <li>Resolution and local variables: can change if product is refreshed. Have no access right check. </li> <li>User inputs: Will not change if product is refreshed.

Access rights are checked. </li> </ul> Changed items (object):

A user input to set for the given column/variableId

* Changed property `inputValue` (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue
- Changed property `valueType` (string) Added enum values:
  - `Measure`
  - `CurrencyPerQuantity`
  - `MonetaryPerQuantity`

POST /quote/{quoteId}/row/cp

Request:

Changed content type : application/json

Changed property rootRow (object)

Row attributes

* Changed property `userInputs` (array)
Inputs to set or override when adding an item: Can be a mix of resolution/local variables and user inputs: <br> <ul> <li>Resolution and local variables: can change if product is refreshed. Have no access right check. </li> <li>User inputs: Will not change if product is refreshed.
Access rights are checked. </li> </ul>

Changed items (object):
A user input to set for the given column/variableId
* Changed property `inputValue` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

POST /quote/{quoteId}/row/cp/update

Request:

Changed content type : application/json

Changed property rootRow (object)

Row attributes

* Changed property `userInputs` (array)
Inputs to set or override when adding an item: Can be a mix of resolution/local variables and user inputs: <br> <ul> <li>Resolution and local variables: can change if product is refreshed. Have no access right check. </li> <li>User inputs: Will not change if product is refreshed.
Access rights are checked. </li> </ul> Changed items (object):
A user input to set for the given column/variableId
* Changed property `inputValue` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue

Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

POST /quote/{quoteId}/row/cp/merge

Request:

Changed content type : application/json

Changed property rootRow (object)

Row attributes

* Changed property `userInputs` (array)
Inputs to set or override when adding an item: Can be a mix of resolution/local variables and user inputs: <br> <ul> <li>Resolution and local variables: can change if product is refreshed. Have no access right check. </li> <li>User inputs: Will not change if product is refreshed.
Access rights are checked. </li> </ul> Changed items (object):
A user input to set for the given column/variableId
* Changed property `inputValue` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

POST /quote/{quoteId}/row/{rowId}/column/{colId}

Request:

Changed content type : application/json

Changed property inputValue (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue

Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

POST /quote/{quoteId}/field/{fieldId}

Request:

Changed content type : application/json

Changed property inputValue (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue

* Changed property `valueType` (string) Added enum values:

`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

POST /quote/{quoteId}/column/{colId}/update

Request:

Changed content type : application/json

Changed property value (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue

Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

POST /quote/{quoteId}/getFields

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json

* Changed property `fields` (array) Changed items (object):
The requested fields information. If a provided field Id is not found it will be included with a null value
* Changed property `value` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

POST /quote/{quoteId}/getLines

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json

* Changed property `rows` (array) Changed items (object):
A Quote line
* Changed property `cells` (array)
The row cells
Changed items (object):
* Changed property `value` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
* Changed property `valueType` (string)

Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`
* Changed property `inputValue` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

POST /quote/{quoteId}/getConfUserChoices

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json

* Changed property `rows` (array)
The configured product rows Changed items (object):
* Changed property `value` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`

* `MonetaryPerQuantity`

GET /quote/{quoteId}/getErrors

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json

* Changed property `fieldErrors` (array)
Field errors details Changed items (object):
Contains Cell error details
* Changed property `value` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`
* Changed property `rowErrors` (array)
Line error details Changed items (object):
Contains Row error details
* Changed property `cellErrors` (array)
Cell error details Changed items (object):
Contains Cell error details
* Changed property `value` (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue
- Changed property `valueType` (string) Added enum values:
  - `Measure`
  - `CurrencyPerQuantity`
  - `MonetaryPerQuantity`

* Changed property `periodErrors` (array)

Error details related to a period Changed items (object):
- Contains error details related to a period

* Changed property `period` (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue
- Changed property `valueType` (string) Added enum values:
  - `Measure`
  - `CurrencyPerQuantity`
  - `MonetaryPerQuantity`
- Changed property `startDate` (object)
  - See different GridValue subtypes definitions for more information. Example: StringGridValue
    - Changed property `valueType` (string) Added enum values:
      - `Measure`
      - `CurrencyPerQuantity`
      - `MonetaryPerQuantity`
- Changed property `endDate` (object)
  - See different GridValue subtypes definitions for more information. Example: StringGridValue
    - Changed property `valueType` (string) Added enum values:
      - `Measure`
      - `CurrencyPerQuantity`
      - `MonetaryPerQuantity`

* Changed property `cellErrors` (array)
Cell error details Changed items (object):
Contains Cell error details
* Changed property `value` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

PUT /quote/{quoteId}/filter/admin/{viewId}

Request:

Changed content type : application/json

Changed property productRestrictions (array)

List of filter restrictions to be applied on single product rows. This is an optional attribute, if no restriction is provided the view filter restriction only will be applied. The list of provided restrictions is executed in the given order.

Changed items (object):
A filter resctriction to apply on the grid
* Changed property `values` (array)
List of filter values. Changed items (object):
A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator.

See operator doc for more information.
See 'GridValue' subtypes for list of available value element
types.
If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in 'valueProperty' for a business column and in 'urlProperty' for an url column
* Changed property `valueElements` (array) Changed items (object):
See different GridValue subtypes definitions for more information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

Changed property folderRestrictions (array)

List of filter restrictions to be applied on folders.

Changed items (object):
A filter resctriction to apply on the grid
Changed property `values` (array)
List of filter values. Changed items (object):
A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator. See operator doc for more information.
See 'GridValue' subtypes for list of available value element
types.
If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in

'valueProperty' for a business column and in 'urlProperty' for an url column
* Changed property `valueElements` (array) Changed items (object):
See different GridValue subtypes definitions for more information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

GET /quote/{quoteId}/rules

Return Type:

Changed response : 200 OK

Successful response.

Changed content type : application/json

* Changed property `rules` (array)
List of user rules applied on the Quote Changed items (object):
A user computation rule
* Changed property `value` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`

* `MonetaryPerQuantity`

* Changed property `filterRestrictions` (array)

Restrictions list to filter lines on which rules should be

applied

Changed items (object):

A filter resctriction to apply on the grid

Changed property `values` (array)

List of filter values. Changed items (object):

A filter value may be composed of one or many elements.

The number of accepted elements and accepted types depends on the operator. See operator doc for more information.

See 'GridValue' subtypes for list of available value

element types.

If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in 'valueProperty' for a business column and in 'urlProperty' for an url column

* Changed property `valueElements` (array) Changed items (object):

See different GridValue subtypes definitions for more information. Example: StringGridValue

Changed property `valueType` (string) Added enum values:

`Measure`

`CurrencyPerQuantity`

`MonetaryPerQuantity`

PUT /quote/{quoteId}/rules

Request:

Changed content type : application/json

Changed property rules (array)
List user rules to be applied on the Quote:

Changed items (object):

A user computation rule to apply
- Changed property `value` (object)
  - See different GridValue subtypes definitions for more information.

Example: StringGridValue

Changed property `valueType` (string) Added enum values:
- `Measure`
- `CurrencyPerQuantity`
- `MonetaryPerQuantity`
- Changed property `filterRestrictions` (array)
  - Restrictions list to filter lines on which rules should be applied Changed items (object):
    - A filter resctriction to apply on the grid
    - Changed property `values` (array)
      - List of filter values. Changed items (object):
    - A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator.

See operator doc for more information.

See 'GridValue' subtypes for list of available value element types.
If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in 'valueProperty' for a business column and in 'urlProperty' for an url column

* Changed property `valueElements` (array) Changed items (object):

See different GridValue subtypes definitions for more

information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

GET /quote/context

Return Type:

Changed response : 200 OK

Successful response.

Changed content type : application/json

* Changed property `contexts` (array) Changed items (object):
* Changed property `context` (array)
An array to hold context data. The context is a list of key/value pairs
Changed items (object):
* Changed property `value` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

POST /quote/context

Request:

Changed content type : application/json

Changed property context (array)

An array to hold context data to push into a data provider. The context is a list of key/value pairs

Changed items (object):
* Changed property `value` (object)
See different GridValue subtypes definitions for more information.
Example: StringGridValue
Changed property `valueType` (string) Added enum values:
`Measure`
`CurrencyPerQuantity`
`MonetaryPerQuantity`

POST /quote/{quoteId}/export/xlsx

Request:

Changed content type : application/json

Added property exportRowId (boolean)
Set to true to export rowIds:
Changes from version 1.3.25 to version 1.4.4

WHAT'S NEW

POST /quote/{quoteId}/exchangeRates/refresh

Start a refresh of exchange rates:

WHAT’S DELETED

GET /quote/{quoteId}/migration/status

Get quote migration status:

WHAT’S CHANGED

DELETE /quote/session

Close multiple Quotes session. Deprecated in Version 12.13 - will be discontinued as of june 2024. Can be replaced by POST /quote/session/clean.

POST /quote/{quoteId}/lineTemplate/resolve

Request:

Changed content type : application/json

Changed property values (array)

A columnId/value list to use for line template resolution

Changed items (object):
*Changed property `value` (object)
See different GridValue subtypes definitions for more information.
Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

POST /quote/{quoteId}/rows

Add rows to quote. Deprecated before Version 12.13 - will be discontinued as of june 2024. Can be replaced by POST /quote/{quoteId}/row

Request:

Changed content type : application/json

Changed property rows (array)

All rows must have the same business value type Changed items (object):
Row attributes
Changed property `userInputs` (array)
Inputs to set or override when adding an item Changed items (object):
A user input to set for the given column/variableId
*Changed property `inputValue` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

POST /quote/{quoteId}/row

Request:

Changed content type : application/json

Changed property rows (array)

All rows must have the same business value type Changed items (object):
Row attributes
Changed property `userInputs` (array)
Inputs to set or override when adding an item Changed items (object):
A user input to set for the given column/variableId
*Changed property `inputValue` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

DELETE /quote/{quoteId}/row

Delete rows from a quote. Deprecated before Version 12.13 - will be discontinued as of june 2024. Can be replaced by POST /quote/{quoteId}/row/delete.

POST /quote/{quoteId}/row/cp

Request:

Changed content type : application/json

Changed property rootRow (object)

Row attributes
Changed property `userInputs` (array)
Inputs to set or override when adding an item Changed items (object):
A user input to set for the given column/variableId
*Changed property `inputValue` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

POST /quote/{quoteId}/row/cp/update

Request:

Changed content type : application/json

Changed property rootRow (object)

Row attributes
Changed property `userInputs` (array)
Inputs to set or override when adding an item Changed items (object):
A user input to set for the given column/variableId
*Changed property `inputValue` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

POST /quote/{quoteId}/row/cp/merge

Request:

Changed content type : application/json

Changed property rootRow (object)

Row attributes
Changed property `userInputs` (array)
Inputs to set or override when adding an item Changed items (object):
A user input to set for the given column/variableId
*Changed property `inputValue` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

POST /quote/{quoteId}/row/{rowId}/column/{colId}

Request:

Changed content type : application/json

Changed property inputValue (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

POST /quote/{quoteId}/field/{fieldId}

Request:

Changed content type : application/json

Changed property inputValue (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

POST /quote/{quoteId}/column/{colId}/update

Request:

Changed content type : application/json

Changed property value (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

POST /quote/{quoteId}/getFields

Return Type:

Changed response : 200 OK:

Successful response

Changed content type : application/json

*Changed property `fields` (array) Changed items (object):
The requested fields information. If a provided field Id is not found it will be included with a null value
*Changed property `value` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

POST /quote/{quoteId}/getLines

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json

*Changed property `rows` (array) Changed items (object):
A Quote line
*Changed property `cells` (array)
The row cells
Changed items (object):
*Changed property `value` (object)
See different GridValue subtypes definitions for more

information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`
*Changed property `inputValue` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

POST /quote/{quoteId}/getConfUserChoices

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json

*Changed property `rows` (array)
The configured product rows Changed items (object):
*Changed property `value` (object)
See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

GET /quote/{quoteId}/getErrors

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json

Changed property `fieldErrors` (array)

Field errors details Changed items (object):

Contains Cell error details

*Changed property `value` (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue

*Changed property `valueType` (string) Added enum value:

*`Period`

Changed property `rowErrors` (array)

Line error details Changed items (object):

Contains Row error details

Added property `periodErrors` (array)

Error details related to a period Items (object):

Contains error details related to a period

*Property `period` (object)

A representation of a period value

Property `valueType` (string) Enum values:

`Empty`

`String`

`BigDecimal`

`Boolean`
`Business`
`Currency`
`DateTime`
`Integer`
`Json`
`LocalDate`
`Locale`
`Long`
`Monetary`
`Multiple`
`Percentage`
`UnitOfMeasure`
`Xml`
`Html`
`Url`
`ScaleGrid`
`Attachment`
`Error`
`Period`
Property `startDate` (object)
A representation of a local date value
Property `valueType` (string) Enum values:
- `Empty`
- `String`
- `BigDecimal`
- `Boolean`
- `Business`
- `Currency`
- `DateTime`
- `Integer`
- `Json`
- `LocalDate`
- `Locale`
- `Long`
- `Monetary`
- `Multiple`
- `Percentage`
- `UnitOfMeasure`
- `Xml`
- `Html`
- `Url`
- `ScaleGrid`
- `Attachment`
- `Error`
- `Period`
Property `value` (string)
- A date as defined by full-date in RFC3339 format with full-date = date-fullyear “-” date-month “-” date-mday

*Property `endDate` (object)

A representation of a local date value
- Property `valueType` (string) Enum values:
  - `Empty`
  - `String`
  - `BigDecimal`
  - `Boolean`
  - `Business`
  - `Currency`
  - `DateTime`
  - `Integer`
  - `Json`
  - `LocalDate`
  - `Locale`
  - `Long`
  - `Monetary`
  - `Multiple`
  - `Percentage`
  - `UnitOfMeasure`
  - `Xml`
  - `Html`
  - `Url`
  - `ScaleGrid`
  - `Attachment`
  - `Error`
  - `Period`
- Property `value` (string)
  - A date as defined by full-date in RFC3339 format with full-date = date-fullyear “-” date-month “-” date-mday
    - Property `cellErrors` (array)
    - Cell error details Items (object):
      - Contains Cell error details
    - Property `id` (string)
      - Cell identifier
    - Property `value` (object)
    - See different GridValue subtypes definitions for more information. Example: StringGridValue
    - Property `valueType` (string) Enum values:
      - `Empty`
      - `String`
      - `BigDecimal`
      - `Boolean`
      - `Business`
      - `Currency`
      - `DateTime`
      - `Integer`
      - `Json`
      - `LocalDate`
      - `Locale`
      - `Long`
      - `Monetary`
      - `Multiple`
      - `Percentage`
      - `UnitOfMeasure`
      - `Xml`
      - `Html`
      - `Url`
      - `ScaleGrid`
      - `Attachment`
      - `Error`
      - `Period`
      - Property `errors` (array)
      - List of errors for a cell Items (string):
      - * INCONSISTENT - error when the cell value is NOT consistent (relative to Dynamic Domains) * UNKNOWN - error when the cell value is unknown from its related data provider * VALUE - error when the cell value is of ErrorValue type

Enum values:

*`INCONSISTENT`

*`UNKNOWN`

*`VALUE`

*Changed property `cellErrors` (array)

Cell error details Changed items (object):
Contains Cell error details

*Changed property `value` (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue

*Changed property `valueType` (string) Added enum value:

*`Period`

GET /quote/{quoteId}/domain/{id}

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json

*Changed property `partial` (boolean)
true if only a part of the domain is returned. This specifies whether the returned domain contains or not all the possible values.

PUT /quote/{quoteId}/filter/admin/{viewId}

Request:

Changed content type : application/json

Changed property productRestrictions (array)
- List of filter restrictions to be applied on single product rows. This is an optional attribute, if no restriction is provided the view filter restriction only will be applied. The list of provided restrictions is executed in the given order.

Changed items (object):

A filter resctriction to apply on the grid
- Changed property `values` (array)
- List of filter values. Changed items (object):
- A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator. See operator doc for more information.
  - See ‘GridValue’ subtypes for list of available value element types.
- If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in

‘valueProperty’ for a business column and in ‘urlProperty’ for an url column

*Changed property `valueElements` (array) Changed items (object):

See different GridValue subtypes definitions for more information. Example: StringGridValue

*Changed property `valueType` (string) Added enum value:

*`Period`

Changed property folderRestrictions (array)

List of filter restrictions to be applied on folders. Changed items (object):

A filter resctriction to apply on the grid

Changed property `values` (array)

List of filter values. Changed items (object):

A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator. See operator doc for more information.

See ‘GridValue’ subtypes for list of available value element types.

If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in ‘valueProperty’ for a business column and in ‘urlProperty’ for an url column

*Changed property `valueElements` (array) Changed items (object):

See different GridValue subtypes definitions for more information. Example: StringGridValue

*Changed property `valueType` (string) Added enum value:

*`Period`

GET /quote/{quoteId}/rules

Return Type:

Changed response : 200 OK

Successful response.

Changed content type : application/json

Changed property `rules` (array)

List of user rules applied on the Quote Changed items (object):

A user computation rule

*Changed property `value` (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue

*Changed property `valueType` (string) Added enum value:

*`Period`

Changed property `filterRestrictions` (array)

Restrictions list to filter lines on which rules should be

applied

Changed items (object):

A filter resctriction to apply on the grid

Changed property `values` (array)

List of filter values. Changed items (object):

A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator.

See operator doc for more information.

See ‘GridValue’ subtypes for list of available value element

types.

If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set

in ‘valueProperty’ for a business column and in ‘urlProperty’ for an url column
*Changed property `valueElements` (array) Changed items (object):
See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

PUT /quote/{quoteId}/rules

Request:

Changed content type : application/json

Changed property rules (array)

List user rules to be applied on the Quote Changed items (object):
A user computation rule to apply
*Changed property `value` (object)
See different GridValue subtypes definitions for more information.
Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`
Changed property `filterRestrictions` (array)
Restrictions list to filter lines on which rules should be applied Changed items (object):
A filter resctriction to apply on the grid
Changed property `values` (array)
List of filter values. Changed items (object):
A filter value may be composed of one or many elements. The

number of accepted elements and accepted types depends on the operator. See operator doc for more information.
See ‘GridValue’ subtypes for list of available value element
types.
If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in ‘valueProperty’ for a business column and in ‘urlProperty’ for an url column
*Changed property `valueElements` (array) Changed items (object):
See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

GET /quote/context

Return Type:

Changed response : 200 OK

Successful response.

Changed content type : application/json

*Changed property `contexts` (array) Changed items (object):
*Changed property `context` (array)
An array to hold context data. The context is a list of key/value pairs
Changed items (object):
*Changed property `value` (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

POST /quote/context

Request:

Changed content type : application/json

Changed property context (array)

An array to hold context data to push into a data provider. The context is a list of key/value pairs
Changed items (object):
*Changed property `value` (object)
See different GridValue subtypes definitions for more information.
Example: StringGridValue
*Changed property `valueType` (string) Added enum value:
*`Period`

POST /quote/{quoteId}/export

Export quote content. Deprecated before Version 12.13 - will be discontinued as of june 2024. Can be replaced by POST /quote/{quoteId}/export/json.

GET /quote/{quoteId}/export/{exportId}

Get Export. Deprecated before Version 12.13 - will be discontinued as of september 2023. Can be replaced by POST /quote/{quoteId}/export/{export}/file.

Changes form version 1.1.15 to 1.2.18

WHAT'S NEW

GET /quote/{quoteId}/getErrors

Get quote errors and warnings - BETA version, API signature is subject to change.

POST /quote/{quoteId}/contract/changeDate

Update contract dates:

POST /quote/{quoteId}/contract/shiftDate

Shift contract dates:

POST /quote/{quoteId}/contract/renew

Renew contract:

POST /quote/{quoteId}/contract/amend

Amend contract:

WHAT'S CHANGED

POST /quote

Request:

Changed content type : application/json

Added property startDate (string)

A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day . This parameter should be provided to define a contract start date. If quote is related to a model with a period column this parameter is mandatory.

Added property endDate (string)

A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day . TODO This parameter should be provided to define a contract end date. If quote is related to a model with a period column this parameter is mandatory.

Added property amendmentDate (string)

A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day . This parameter should be provided to define a contract amendment date. This parameter is optional even if quote is related to a model with a period column

DELETE /quote/{quoteId}/status/deactivateAndWait

Parameters:

Deleted: X-quotex-sessionId in header

Session identifier. Call initSession API to get a session Id

POST /quote/{quoteId}/column/{colId}/update

Request:

Changed content type : application/json

Added property updateSubsequentPeriods (boolean)

Set true to force update of subsequent periods if the column is linked to a period.

Added property applicationDate (string)

A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day . This must be provided if the column is linked to a period. Otherwise it's optional. It should be between contract start and end date

PUT /quote/{quoteId}/filter/admin/{viewId}

Request:

Changed content type : application/json

Changed property productRestrictions (array)

List of filter restrictions to be applied on single product rows. This is an optional attribute, if no restriction is provided the view filter restriction only will be applied. The list of provided restrictions is

executed in the given order.Changed items (object):> A filter resctriction to apply on the grid* Changed property `values` (array)> List of filter values.Changed items (object):> A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator. See operator doc for more information.> See 'GridValue' subtypes for list of available value element types.> If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in 'valueProperty' for a business column and in 'urlProperty' for an url column* Added property `urlProperty` (string)

If the column is of type url. A StringValue can be user for the restriction value and set here the url value property to useEnum values:* `URL`* `TOOLTIP`* `LABEL`* Changed property `valueProperty` (string)> If the column is of type business. A StringValue can be used for the restriction value and set here the business value property to use (Id or Description)
- Changed property folderRestrictions (array)
List of filter restrictions to be applied on folders.Changed items (object):> A filter resctriction to apply on the grid* Changed property `values` (array)> List of filter values.Changed items (object):> A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator. See operator doc for more information.> See 'GridValue' subtypes for list of available value element types.> If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in 'valueProperty' for a business column and in 'urlProperty' for an url column* Added property `urlProperty` (string)> If the column is of type url. A StringValue can be user for the restriction value and set here the url value property to useEnum values:* `URL`

* `TOOLTIP`* `LABEL`* Changed property `valueProperty` (string)> If the column is of type business. A StringValue can be used for the restriction value and set here the business value property to use (Id or Description)

GET /quote/{quoteId}/rules

Return Type:

Changed response : 200 OK

Successful response.

Changed content type : application/json
- Changed property `rules` (array)> List of user rules applied on the QuoteChanged items (object):> A user computation rule* Changed property `filterRestrictions` (array)> Restrictions list to filter lines on which rules should be appliedChanged items (object):> A filter resctriction to apply on the grid* Changed property `values` (array)> List of filter values.

Changed items (object):> A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator. See operator doc for more information.

See 'GridValue' subtypes for list of available value element types.
If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in 'valueProperty' for a business column and in 'urlProperty' for an url column* Added property `urlProperty` (string)> If the column is of type url. A StringValue can be user for the restriction value and set here the url value property to use

Enum values:* `URL`* `TOOLTIP`

`LABEL`* Changed property `valueProperty` (string)
- If the column is of type business. A StringValue can be used for the restriction value and set here the business value property to use (Id or Description)

PUT /quote/{quoteId}/rules

Request:

Changed content type : application/json

Changed property rules (array)
- List user rules to be applied on the QuoteChanged items (object):> A user computation rule to apply* Changed property `filterRestrictions` (array)> Restrictions list to filter lines on which rules should be appliedChanged items (object):> A filter resctriction to apply on the grid* Changed property `values` (array)> List of filter values.Changed items (object):> A filter value may be composed of one or many elements. The number of accepted elements and accepted types depends on the operator. See operator doc for more information.> See 'GridValue' subtypes for list of available value element types.> If the column is of type business or url, the restriction value elements must be of type string, it will filter on the property set in 'valueProperty' for a business column and in 'urlProperty' for an url column* Added property `urlProperty` (string)> If the column is of type url. A StringValue can be user for the restriction value and set here the url value property to use Enum values:* `URL`* `TOOLTIP`*

`LABEL`* Changed property `valueProperty` (string)> If the column is of type business. A StringValue can be used for the restriction value and set here the business value property to use (Id or Description)

POST /quote/{quoteId}/export

Request:

Changed content type : application/json

Changed property exportMode (string)

The type of JSON export to launch. If not provided EXCLUDE_NO_VALUES will be used by default _EXCLUDE_NO_VALUES - Only exports true values (excluding noValue). This export can be re-imported on an empty quote but may badly behave for data cleaning when merging on an existing quote (use FORCE_USER_INPUTS instead in this case)._ FORCE_USER_INPUTS - Export all user inputs including noValue to ensure a proper cleaning if used for import to merge inputs on an existing quote. On JSON, pure user inputs are registered on both cells and userInputCells section to enforce import on another model definition.

POST /quote/{quoteId}/export/json

Request:

Changed content type : application/json

Changed property exportMode (string)

The type of JSON export to launch. If not provided EXCLUDE_NO_VALUES will be used by default _EXCLUDE_NO_VALUES - Only exports true values (excluding noValue). This export can be re-imported on an empty quote but may badly behave for data cleaning when merging on an existing quote (use FORCE_USER_INPUTS instead in this case)._ FORCE_USER_INPUTS - Export all user inputs including noValue to ensure a proper cleaning if used for import to merge inputs on an existing quote. On JSON, pure user inputs are registered on both cells and userInputCells section to enforce import on another model definition.

POST /quote/{quoteId}/export/xlsx

Request:

Changed content type : application/json

Changed property exportMode (string)

The type of JSON export to launch. If not provided EXCLUDE_NO_VALUES will be used by default _EXCLUDE_NO_VALUES - Only exports true values (excluding noValue). This export can be re-imported on an empty quote but may badly behave for data cleaning when merging on an existing quote (use FORCE_USER_INPUTS instead in this case)._ FORCE_USER_INPUTS - Export all user inputs including noValue to ensure a proper cleaning if used for import to merge inputs on an existing quote. On JSON, pure user inputs are registered on both cells and userInputCells section to enforce import on another model definition.

Changes from version 1.1.12 to version 1.1.14

WHAT’S CHANGED

DELETE /quote/{quoteId}

Return Type:

New response : 400 Bad Request

Bad request, invalid quote id:

POST /quote/delete

Return Type:

Changed response : 400 Bad Request

Bad request, invalid quote id:

POST /quote/{quoteId}/clone

Request:

Changed content type : application/json

Added property ttl (integer)
Time to live (in seconds), If attribute is not provided or value is -1 the created Quote is permanent:

PUT /quote/{quoteId}/filter/admin/{viewId}

Request:

Changed content type : application/json

Changed property productRestrictions (array)

Changed items (object):

A filter resctriction to apply on the grid:

New optional properties:

columnId
Changed property operator (string)

FilterOperator to apply for the restriction. Must be compatible with the column type.

Here are details for each operator:

CONTAINS - Can be used with multiple values. Supported grid values : STRING, BUSINESS, HTML.

EQUAL -

NOT_EQUAL -

STARTS_WITH -

ENDS_WITH -

CONTAINS_ALL -

CONTAINS_ANY -

GREATER_THAN -

GREATER_THAN_OR_EQUAL -

LOWER_THAN -

LOWER_THAN_OR_EQUAL -

BETWEEN -

IS_EMPTY -

IS_IN_ERROR -

IS_IN_WARNING

Added enum values:

IS_IN_ERROR
IS_IN_WARNING
Changed property folderRestrictions (array)

List of filter restrictions to be applied on folders.

Changed items (object):

A filter resctriction to apply on the grid:

New optional properties:

columnId
Changed property operator (string)

FilterOperator to apply for the restriction. Must be compatible with the column type. Here are details for each operator

CONTAINS - Can be used with multiple values. Supported grid values : STRING, BUSINESS, HTML.
EQUAL -
NOT_EQUAL -
STARTS_WITH -
ENDS_WITH -
CONTAINS_ALL -
CONTAINS_ANY -
GREATER_THAN -
GREATER_THAN_OR_EQUAL -
LOWER_THAN -
LOWER_THAN_OR_EQUAL -
BETWEEN -
IS_EMPTY -
IS_IN_ERROR -
IS_IN_WARNING

Added enum values:

IS_IN_ERROR
IS_IN_WARNING

GET /quote/{quoteId}/rules

Return Type:

Changed response : 200 OK

Successful response.

Changed content type : application/json
Changed property rules (array)
List of user rules applied on the Quote:

Changed items (object):

A user computation rule:

Changed property filterRestrictions (array)
Restrictions list to filter lines on which rules should be applied:

Changed items (object):

A filter resctriction to apply on the grid:

New optional properties:

columnId
Changed property operator (string)

FilterOperator to apply for the restriction. Must be compatible with the column type. Here are details for each operator

CONTAINS - Can be used with multiple values. Supported grid values : STRING, BUSINESS, HTML.
EQUAL -
NOT_EQUAL -
STARTS_WITH -
ENDS_WITH -
CONTAINS_ALL -:
CONTAINS_ANY -
GREATER_THAN -
GREATER_THAN_OR_EQUAL -
LOWER_THAN -
LOWER_THAN_OR_EQUAL -
BETWEEN -
IS_EMPTY -
IS_IN_ERROR -
IS_IN_WARNING

Added enum values:

IS_IN_ERROR
IS_IN_WARNING

PUT /quote/{quoteId}/rules

Request:

Changed content type : application/json

Changed property rules (array)
List user rules to be applied on the Quote:

Changed items (object):

A user computation rule to apply:

Changed property filterRestrictions (array):

Restrictions list to filter lines on which rules should be applied

Changed items (object):

A filter resctriction to apply on the grid:

New optional properties:

columnId
Changed property operator (string)

FilterOperator to apply for the restriction. Must be compatible with the column type. Here are details for each operator

CONTAINS - Can be used with multiple values. Supported grid values : STRING, BUSINESS, HTML.
EQUAL -
NOT_EQUAL -
STARTS_WITH -
ENDS_WITH -
CONTAINS_ALL -
CONTAINS_ANY -
GREATER_THAN -
GREATER_THAN_OR_EQUAL -
LOWER_THAN -
LOWER_THAN_OR_EQUAL -
BETWEEN -
IS_EMPTY -
IS_IN_ERROR -
IS_IN_WARNING

Added enum values:

IS_IN_ERROR
IS_IN_WARNING

POST /quote/{quoteId}/import

Request:

Changed content type : multipart/form-data

Added property updateConflictPolicy (string)

Optional. This import policy is used when the import action matches on FPK (Functional primary key) and the FPK policy is CONFLICTS. If not precised ALWAYS_ADD is used by default

KEEP_WHEN_SINGLE_MATCH: If there is at least one match, the line from the import file is ignored.
CLEAN_WHEN_SINGLE_MATCH: The line is replaced by the one from the import file if there is only one match. If several matches have been found, the line is ignored.
MERGE_WHEN_SINGLE_MATCH: The line is merged with the one from the import file if there is only one match. If several matches have been found, the line is ignored.
ALWAYS_ADD: Add the line.

Enum values:

KEEP_WHEN_SINGLE_MATCH
CLEAN_WHEN_SINGLE_MATCH
MERGE_WHEN_SINGLE_MATCH
ALWAYS_ADD
Changed property updatePolicy (string)

Optional. This import policy is used when the import action matches on RowId OR matches on FPK and the FPK policy is NO_DUPLICATE. If not precised MERGE is used by default

KEEP - If an existing line is found, nothing is changed (only import).
CLEAN - If an existing line is found, then original line is deleted, then the data are imported
MERGE - Existing line is merged (replacement of import provided columns data only). If the
column is a computed column with user input, it’s the user input that will be modified and the value of the column will then be forced with this value:

POST /quote/{quoteId}/importFromSource

Request:

Changed content type : multipart/form-data

Added property updateConflictPolicy (string)

Optional. This import policy is used when the import action matches on FPK (Functional primary key) and the FPK policy is CONFLICTS. If not precised ALWAYS_ADD is used by default

KEEP_WHEN_SINGLE_MATCH: If there is at least one match, the line from the import file is ignored.
CLEAN_WHEN_SINGLE_MATCH: The line is replaced by the one from the import file if there is only one match. If several matches have been found, the line is ignored.
MERGE_WHEN_SINGLE_MATCH: The line is merged with the one from the import file if there is only one match. If several matches have been found, the line is ignored.
ALWAYS_ADD: Add the line.

Enum values:

KEEP_WHEN_SINGLE_MATCH
CLEAN_WHEN_SINGLE_MATCH
MERGE_WHEN_SINGLE_MATCH
ALWAYS_ADD
Changed property updatePolicy (string)

Optional. This import policy is used when the import action matches on RowId OR matches on FPK and the FPK policy is NO_DUPLICATE. If not precised MERGE is used by default

KEEP - If an existing line is found, nothing is changed (only import).
CLEAN - If an existing line is found, then original line is deleted, then the data are imported:
MERGE - Existing line is merged (replacement of import provided columns data only). If the column is a computed column with user input, it’s the user input that will be modified and the value of the column will then be forced with this value
Changes from version 1.1.11 to version 1.1.12

WHAT’S NEW

GET /quote/context

Get Contexts:

WHAT’S CHANGED

PUT /quote/{quoteId}/filter/admin/{viewId}

Request:

Changed content type : application/json

Changed property show (string)
Type of rows to show:
ALL - Show all rows (products and folders)
PRODUCTS - Show products only
FOLDERS - Show folders only
FLAT_MODE - Show all matching products without hierarchy. If selected, subRows attribute value will be ignored. The filter will not show folders with this option
FLAT_MODE_ALL - Show all matching products and folders without hierarchy. If selected, subRows attribute value will be ignored
Added enum value:
FLAT_MODE_ALL

POST /quote/context

Request:

Changed content type : application/json

Changed property modelName (string)

The quote model name for a non existing quote. If this paramater is provided there is no need to set the quoteId

Changed property quoteId (string)

The quoteId if the pushContext concerns an existing quote. If modelName is provided, there is no need set the quoteId

Changes from version 1.1.9 to 1.1.10

WHAT'S NEW?

POST /quote/{quoteId}/export

Request:

Changed content type : application/json

Added property exportMode (string)

The type of JSON export to launch. * EXCLUDE_NO_VALUES - Only exports true values (excluding noValue). This export can be re-imported on an

empty quote but may badly behave for data cleaning when merging on an existing quote (use FORCE_USER_INPUTS instead in this case). * FORCE_USER_INPUTS - Export all user inputs including noValue to ensure a proper cleaning if used for import to merge inputs on an existing quote. On JSON, pure user inputs are registered on both cells and userInputCells section to enforce import on another model definition.Enum values:*
`EXCLUDE_NO_VALUES`*`FORCE_USER_INPUTS`

POST /quote/{quoteId}/export/json

Request:

Changed content type : application/json

Added property exportMode (string)

The type of JSON export to launch. * EXCLUDE_NO_VALUES - Only exports true values (excluding noValue). This export can be re-imported on an empty quote but may badly behave for data cleaning when merging on an existing quote (use FORCE_USER_INPUTS instead in this case). * FORCE_USER_INPUTS - Export all user inputs including noValue to ensure a proper cleaning if used for import to merge inputs on an existing quote. On JSON, pure user inputs are registered on both cells and userInputCells section to enforce import on another model definition.Enum values:*
`EXCLUDE_NO_VALUES`*`FORCE_USER_INPUTS`

POST /quote/{quoteId}/export/xlsx

Request:

Changed content type : application/json

Added property exportMode (string)

The type of JSON export to launch. * EXCLUDE_NO_VALUES - Only exports

true values (excluding noValue). This export can be re-imported on an empty quote but may badly behave for data cleaning when merging on an existing quote (use FORCE_USER_INPUTS instead in this case). * FORCE_USER_INPUTS - Export all user inputs including noValue to ensure a proper cleaning if used for import to merge inputs on an existing quote. On JSON, pure user inputs are registered on both cells and userInputCells section to enforce import on another model definition.Enum values:*
`EXCLUDE_NO_VALUES`*`FORCE_USER_INPUTS`

Changes from version 1.1.6 to version 1.1.8

WHAT'S NEW

POST /quote/delete

Delete multiple Quotes:

WHAT'S DEPRECATED

GET /quote/{quoteId}/migration/status

Get quote migration status:

WHAT'S CHANGED

POST /quote/session

DELETE /quote/session

POST /quote/session/clean

POST /quote

DELETE /quote/{quoteId}

Return Type:

New response : 404 Not Found

The quote does not exist:

HEAD /quote/{quoteId}

GET /quote/{quoteId}/migration/status

GET /quote/{quoteId}/export/{exportId}/status

Parameters:

Changed: partNumber in query

Export part number. Checks the global export status if export part number is 0

GET /quote/{quoteId}/report/{reportId}/status

Return Type:

Changed response : 200 OK

Report status success response:

Changed content type : application/json

*Added property `errorMessage` (string) > If status is failed, this attribute will contain the error message

Changes from version 1.1.2 to version 1.1.4

WHAT'S CHANGED

POST /quote/session

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

Environment identifier. This parameter is deprecated and the environment will be automatically retrieved. If used the provided environment value will be checked against the the environment value automatically found. This header should NOT be used to pass AppPortal environment value.

DELETE /quote/session

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/session/clean

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

DELETE /quote/{quoteId}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

HEAD /quote/{quoteId}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/open

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

Request:

Changed content type : application/json

Added property disableDPContext (boolean) > This parameter is optional and can be used to open the Quote with ignoring related context data providers. > This option is only authorized for some specific roles (API_SUPER_USER)

GET /quote/{quoteId}/status

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/status/activateAndWait

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this

option):

Changed: X-quotex-environment in header

DELETE /quote/{quoteId}/status/deactivate

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

DELETE /quote/{quoteId}/status/deactivateAndWait

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/step

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/clone

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/migration

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/migration/status

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/lineTemplate/resolve

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/rows

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/row

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

DELETE /quote/{quoteId}/row

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/row/delete

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/row/cp

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/row/cp/update

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/row/cp/merge

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/row/restore

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/row/{rowId}/column/{colId}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

DELETE /quote/{quoteId}/row/{rowId}/column/{colId}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/field/{fieldId}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

DELETE /quote/{quoteId}/field/{fieldId}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/column/{colId}/update

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/businessStatus

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

PUT /quote/{quoteId}/businessStatus

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/getFields

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/getLines

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/getConfUserChoices

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

PUT /quote/{quoteId}/filter/admin/{viewId}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

DELETE /quote/{quoteId}/filter/admin/{viewId}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/rules

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

PUT /quote/{quoteId}/rules

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

DELETE /quote/{quoteId}/rules

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/refreshAction

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/refresh

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/synchronizeAction

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/synchronize

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/context

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/export

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/export/json

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/export/xlsx

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/export/{exportId}/status

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/export/{exportId}/file

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/export/{exportId}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

DELETE /quote/{quoteId}/export/{exportId}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/import

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/importFromSource

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/report

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/report/{reportId}/status

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/report/{reportId}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

DELETE /quote/{quoteId}/report/{reportId}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/reportAction

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/longProcessing/{taskId}/status

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/longProcessing/{taskId}/report

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/command/{correlationId}/status

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

DELETE /quote/{quoteId}/command/{correlationId}/status

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/log

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/logs

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

POST /quote/{quoteId}/pushNotification

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

GET /quote/{quoteId}/metadata

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

PUT /quote/{quoteId}/metadata/changeTracking

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

PUT /quote/{quoteId}/metadata/frozen

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run the API in system mode. ARMs are by-passed during the request processing when this option is enabled. (Note : API_SUPER_USER role is required to enable this option)

Changed: X-quotex-environment in header

Request:

Changed content type : application/json

Added property disableDPContext (boolean) > This parameter is optional and can be used to unfreeze the Quote while ignoring related context data providers (disableDPContext=true) > This option is only authorized for some specific roles (API_SUPER_USER), and will be only used when unfreezing a Quote
Changes from version 1.1.1 to version 1.1.2

WHAT'S CHANGED

POST /quote/{quoteId}/refresh

Request:

Changed content type : application/json

Added property rowIds (array)

List of row ids to refresh. This is mandatory only for actions of type "Refresh selected rows". For other refresh action types rowsIds should not be provided and will be ignored.Items (string):> Row identifier

Changes from version 1.0.1 to version 1.1.1

WHAT'S NEW

POST /quote/{quoteId}/column/{colId}/update

Cells mass update. Change/Clear a value on a column.

POST /quote/{quoteId}/getLines

Get lines values:

POST /quote/{quoteId}/getConfUserChoices

Get configured product row user's choices:

WHAT'S CHANGED

GET /quote/{quoteId}/status

DELETE /quote/{quoteId}/status/deactivate

GET /quote/{quoteId}/migration/status

POST /quote/{quoteId}/lineTemplate/resolve

Request:

Changed content type : application/json

Changed property values (array)

A columnId/value list to use for line template resolutionChanged items (object):*Changed property `value` (object)
GridValue subtypes definitions for more information. Example:

StringGridValue
enum values:

*
*

Changed property `valueType` (string)

Added

`Attachment`

*

`Error`

POST /quote/{quoteId}/rows

Request:

Changed content type : application/json

Changed property rows (array)

All rows must have the same business value typeChanged items (object):>
Row attributes*Changed property `userInputs` (array)

or override when adding an itemChanged items (object):

Inputs to set
A user

input to set for the given column/variableId*Changed property
`inputValue` (object)* Changed property `valueType` (string)Added enum values:
*`Attachment`*`Error`

POST /quote/{quoteId}/row

Request:

Changed content type : application/json

Changed property rows (array)

All rows must have the same business value typeChanged items (object):>
Row attributes*Changed property `userInputs` (array)

or override when adding an itemChanged items (object):

Inputs to set
A user

input to set for the given column/variableId*Changed property
`inputValue` (object)* Changed property `valueType` (string)Added enum values:
*`Attachment`*`Error`

POST /quote/{quoteId}/row/cp

Request:

Changed content type : application/json

Changed property rootRow (object)

Row attributes*Changed property `userInputs` (array)

Inputs to

set or override when adding an item A user input to set for the given column/variableId*Changed property
`inputValue` (object)* Changed property `valueType` (string)Added enum values:
*`Attachment`*`Error`

POST /quote/{quoteId}/row/cp/update

Request:

Changed content type : application/json

Changed property rootRow (object)

Row attributes*Changed property `userInputs` (array)

Inputs to

set or override when adding an item A user input to set for the given column/variableId*Changed property
`inputValue` (object)* Changed property `valueType` (string)Added enum values:
*`Attachment`*`Error`

POST /quote/{quoteId}/row/cp/merge

Request:

Changed content type : application/json

Changed property rootRow (object)

Row attributes*Changed property `userInputs` (array)

Inputs to

set or override when adding an item A user input to set for the given column/variableId*Changed property
`inputValue` (object)* Changed property `valueType` (string)Added enum values:
*`Attachment`*`Error`

POST /quote/{quoteId}/row/{rowId}/column/{colId}

Request:

Changed content type : application/json

New required properties: - inputValue

Changed property inputValue (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue*Added enum values:*`Attachment`*`Error`

POST /quote/{quoteId}/field/{fieldId}

Request:

Changed content type : application/json

New required properties: - inputValue

Changed property inputValue (object)

See different GridValue subtypes definitions for more information. Example: StringGridValue*Added enum values:*`Attachment`*`Error`

GET /quote/{quoteId}/businessStatus

POST /quote/{quoteId}/getFields

Return Type:

Changed response : 200 OK

Successful response:

Changed content type : application/json

*Changed property `fields` (array)

Changed items (object):

The

requested fields information. If a provided field Id is not found it will be included with a null value*Added property `isUserInput` (boolean)> Indicate wether value is computed or comes from a user input*Changed property `value` (object)
GridValue subtypes definitions for more information. Example:

StringGridValue
Added enum values:

*

Changed property `valueType` (string)

*

`Attachment`

*

`Error`

PUT /quote/{quoteId}/filter/admin/{viewId}

Request:

Changed content type : application/json

Changed property productRestrictions (array)
List of filter restrictions to be applied on single product rows. This is an optional attribute, if no restriction is provided the view filter restriction only will be applied. The list of provided restrictions is executed in the given order.Changed items (object):> A filter resctriction to apply on the grid*Changed property `values` (array)> List of filter values.Changed items (object):> A filter value may be composed of one or many elements. The number of accepted elements and accepted types depend on the operator. See operator doc for more information. See 'GridValue' subtypes for list of available value element types. If your column is of type business, the restriction value elements must be of type string, it will filter on the business value property you set in 'valueProperty'*Changed property `valueElements` (array) Changed items (object):> See different GridValue subtypes definitions for more information. Example: StringGridValue* Changed property `valueType` (string)Added enum values:

*`Attachment`*`Error`

Changed property folderRestrictions (array)

List of filter restrictions to be applied on folders.Changed items (object):> A filter resctriction to apply on the grid* property
`values` (array)> List of filter values.Changed items (object):
A filter value may be composed of one or many elements. The number of accepted elements and accepted types depend on the operator. See operator doc for more information. See 'GridValue' subtypes for list of available value element types. If your column is of type business, the restriction value elements must be of type string, it will filter on the business value property you set in 'valueProperty'*Changed property
`valueElements` (array) GridValue subtypes definitions for more information. Example: StringGridValue*Changed property `valueType` (string)

Added enum values:

*`Attachment`

*`Error`

GET /quote/{quoteId}/rules

Return Type:

Changed response : 200 OK

Successful response.

Changed content type : application/json
- Changed property `rules` (array)> List of user rules applied on the QuoteChanged items (object):> A user computation rule* Changed property `value` (object)> See different GridValue subtypes definitions for more information. Example: StringGridValue
- Changed property `valueType` (string)Added enum values:
- `Attachment`*`Error`*Changed property

`filterRestrictions` (array)> Restrictions list to filter lines on which rules should be appliedChanged items (object):> A filter resctriction to apply on the grid*Changed property

`values` (array)> List of filter values.Changed items (object):> A filter value may be composed of one or many elements. The number of accepted elements and accepted types depend on the operator. See operator doc for more information. See 'GridValue' subtypes for list of available value element types. If your column is of type business, the restriction value elements must be of type string, it will filter on the business value property you set in 'valueProperty'

Changed property `valueElements` (array)Changed items (object):> See different GridValue subtypes definitions for more information. Example: StringGridValue*Changed property `valueType` (string)Added enum values:
`Attachment`*`Error`

PUT /quote/{quoteId}/rules

Request:

Changed content type : application/json

Changed property rules (array)
- List user rules to be applied on the QuoteChanged items (object):> A user computation rule to apply*Changed property `value` (object)> See different GridValue subtypes definitions for more information.

Example: StringGridValue*Changed property `valueType` (string) Added enum values:*`Attachment`*`Error`*Changed property `filterRestrictions` (array)> Restrictions list to filter lines on which rules should be appliedChanged items (object):> A filter resctriction to apply on the grid*Changed property `values` (array)> List of filter values.Changed items (object):

A filter value may be composed of one or many elements. The number of accepted elements and accepted types depend on the operator. See operator doc for more information. See 'GridValue' subtypes for list of available value element types. If your column is of type business, the restriction value elements must be of type string, it will filter on the business value property you set in 'valueProperty'*Changed property

`valueElements` (array)Changed items (object):> See different GridValue subtypes definitions for more information.

Example: StringGridValue*Changed property `valueType` (string)Added enum values:*`Attachment`

`Error`

POST /quote/context

Request:

Changed content type : application/json

Changed property context (array)

An array to hold context data to push into a data provider. The context is a list of key/value pairsChanged items (object):*
`value` (object) See different GridValue subtypes definitions for more information. Example: StringGridValue*Changed property
`valueType` (string)Added enum values:*`Attachment`
*`Error`

GET /quote/{quoteId}/export/{exportId}/status

GET /quote/{quoteId}/export/{exportId}/file

GET /quote/{quoteId}/report/{reportId}/status

GET /quote/{quoteId}/longProcessing/{taskId}/status

GET /quote/{quoteId}/command/{correlationId}/status

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Performance Quoting APIs Change Log - Quote

Overview

Online Access to Documentation (via Swagger)

Version Change Tracking

Footer Section

Explore