PROS Performance Quoting - Quote public API (1.7.2)

Download OpenAPI specification:Download

PROS Support: support@pros.com URL: https://connect.pros.com/ Terms of Service

The Quote Public API provides operations to create, query, export quotes content or meta-data along with operations related to data providers.

Warnings:

Clients consuming this API, or servers implementing this API, must assume that JSON objects are open for extension. Client and Server must not reject new fields that are not part of the Open API contract. This is consistent with the OpenAPI 2.0 specification that is based on the JSON schema specification: Open API object definitions are considered open for extension by default, an additionalProperties directive is not required to make an object definition extensible. OpenAPI specification: https://swagger.io/specification/v2/

When using any public API (even polling ones):
- One may be aware of the different "Governor Limits" of the product and API: See https://connect.pros.com/products/pros-smart-cpq/help-topics/ section "General" link "Governor Limits" for details.
- As a general rule, to cope with transient slowdowns, we recommend using a socket read timeout of at least:
  - 3 minutes in general
  - 1 minute in the particular case of an Azure Function customization called by the quote
- One should ensure that his/her code handles "Too many requests" 429 and "Service unavailable" 503 http errors due to "rate limiting" governor limits or transient errors.
  1. One should use the Retry-After response header when received.
  2. When this response header is not received, there must be a minimal waiting time of 0.5 sec before any retry. The recommended approach is to use the following exponential backoff retry logic: 0.5 sec before first retry then 1-2-4-8-etc. sec between subsequent calls.

When using any status polling API:
- There must be a minimal waiting time of 100 ms between two consecutive status polling API call.
- The recommended approach is to use the following exponential backoff retry logic: 50 ms before first status polling call then 100-200-400-800-etc. ms between subsequent calls.
- Example of status polling API: /quote/{quoteId}/status, /quote/{quoteId}/status/deactivate, /quote/{quoteId}/export/{exportId}/status, /quote/{quoteId}/report/{reportId}/status, /quote/{quoteId}/longProcessing/{taskId}/status, /quote/{quoteId}/command/{correlationId}/status, etc.

When using any timeout polling API:
- There must be a minimal waiting time of 1 sec between two consecutive timeout polling API call.
- The recommended approach is to use the following exponential backoff retry logic: 1 sec before first timeout polling call then 2-4-8-16-etc. sec between subsequent calls.
- Example of timeout polling API: /quote/{quoteId}/open, /quote/{quoteId}/status/activateAndWait, /quote/{quoteId}/status/deactivateAndWait, etc.

API deprecation policy

As the Smart CPQ API evolves, APIs are periodically reorganized or upgraded. Wherever possible, APIs are updated so that they are compatible with earlier versions (according to the OpenAPI standard).
When the changes don’t allow a backward compatibility and the old API can't be supported indefinitely, the old API is deprecated and guidance is provided to help replace the deprecated API.
The deprecation period is 12 months. During this time, the deprecated API will be supported. The first major version following the 12 month deprecation period will be the end of life: the deprecated API will be removed and no longer supported.
To check automatically for API deprecation and sunset you can check for 'Deprecation' and 'Sunset' HTTP response standard headers, they contain both an HTTP date to indicate when the API was deprecated and when it will be deleted (sunset), if sunset date is known. You can find more information on API replacement on the deprecated API documentation
All public APIs can send both or one of these headers if they are deprecated.

Example:
Deprecation: Sat, 01 Jan 2022 00:00:00 GMT
Sunset: Sun, 31 Dec 2023 23:59:59 GMT

No additional delay can and will be granted. Please read here ( https://connect.pros.com/products/smart-configure-price-quote/guides/developer-guide/138511) ** for more details, including how to get deprecation notification.

How to work with the Quote APIs?

Here is the global workflow when working with a Quote using Quote APIs. This workflow may vary depending on the use case (New or existing Quote, With or without context,....)

Initialize a Quote session

Any Operation on the Quote is related to a session. You should get first a session Id using Init Session API
=> POST /quote/session

Note: Quote session creation is not recommended if your code is called by the quote itself through a custom process and you plan to call again the same quote, as the session is already created and transmitted through a header field to the custom process.
.

Push a context

You may need to attach a context to your session, this is useful to push a set of key/value pairs to a context data source defined in the model to be used then when opening a Quote
=> POST /quote/context

Note: Pushing a context is not useful if you call the Open Quote API with the option disableDPContext. This option is only authorized for some specific roles (API_SUPER_USER).

Create a Quote

If you don't work on a an existing Quote you will need to create a new one. The Quote should be created based on a existing model. The Quote can be permanent or temporary if you set a TTL during the Quote creation.
=> POST /quote

Activate Quote

Quote may not be active when using it for the first time after a period of inactivity. You should activate it first. Activation is meant to load Quote resources before using it
You can call any Quote API without activating the Quote, but the first call may be slow or timeout because of the activation process, the activate and wait API ensure activation is done correctly and returns the Quote status.
=> GET /quote/{quoteId}/status/activateAndWait

Note: Quote activation is not useful if you call the Open Quote API. It activates the Quote before opening. See bellow for more information about Open Quote API.
Note: Quote activation is not recommended if your code is called by the quote itself through a custom process and you plan to call again the same quote, as the quote is already activated.
.

Open the Quote

The open Quote operation is important to ensure Quote is up to date before making any operation on it. Open Quote operation do following

Activate the Quote if not already active
Migrate the Quote to the latest model version if a new version is available
Open the Quote and call data sources according to the model logic. If a context was pushed on the session (identified by the session Id) it will be used during the open operation.

=> POST /quote/{quoteId}/open

Note: The open Quote API returns a model identifier that should be passed in header to any called operation.
Note: Open Quote takes a timeout value (See API documentation) and you can retry the operation using the returned process Id if necessary.
Note: Quote opening is not recommended if your code is called by the quote itself through a custom process and you plan to call again the same quote, as the quote is already opened.

Call any Quote API

After Quote is active and open, you can call any Quote public API
Use the provided model Id from Open Quote API with any Quote API.
To read Quote data, APIs are synchronous and result is returned immediately , but for most of data write APIs processing is asynchronous and API user can check for operation status and result depending on the use case.

Quote data editing

When calling an API to change/edit Quote data, a command correlation id is returned in the response and command processing will be done asynchronously. The command correlation id can be then used to check for the command status and get some additional information is some cases.
Checking for command status is important before starting another operation on the Quote of before Quote deactivation. It will ensure that update operation processing is finished before. Example: Add rows to a Quote
Call addRows API or import API. It returns a command correlation Id

=> POST /quote/{quoteId}/row
=> POST /quote/{quoteId}/import

Call getCommandStatus API to check for process execution status and get list of impacted rowIds.

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

In case of some long processing operations like import your can use the taskId returned in the command status to get more information about the import like warning or functional errors using the long processing status and report

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

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

Quote export

Quote export is asynchronous and export can be paginated. The export operation will return an exportId
ExportId can be used to check export global status (by default) or status of an export part

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

=> GET /quote/{quoteId}/export/{exportId}/status?1

Quote report

A report can be generated based on the Quote content and a PDF or docx template. Quote report generation is asynchronous and generation status can be checked using the report status API.

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

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

Release Quote Resources

After working with a Quote and making different API calls, you must release used resources. If not done then you are at risk of violating governor limits and your script beeing throttled or banned because used ressources will not be freed. This is a good practice with following benefits:

Avoid reaching governor limits for your tenant. For example number of max active Quotes.
Release Catalog or Configurator session and improve their performance.
Remove any temporary resource created during the Quote session.

To release Quote resources use following APIs:

Clean session

=> POST /quote/session/clean

Note: Cleaning a session you haven't created is always strongly discouraged. For example if your code is called by the quote itself through a custom process that sent you its own session identifier, as you will clean the session of a quote already in use by an active user or process.

Deactivate Quote

Before deactivating a Quote you should ensure no update operation is ongoing on the Quote, if any update operation was started before (add rows, set field....) you can check for their status first as described above.
Asynchronously: Deactivation will be done in background.

=> DELETE /quote/{quoteId}/status/deactivate

Synchronously: to make sure deactivation is done, this is useful when working with many Quotes in the same time in a batch for example or data migration to avoid reaching governor limits and opening too many Quotes in the same time.

=> DELETE /quote/{quoteId}/status/deactivateAndWait

Note: Deactivating a quote you haven't activated is always strongly discouraged. For example if your code is called by the quote itself through a custom process and you plan to deactivate this quote, as you will deactivate a quote already in use by an active user or process.

Delete a Quote

It's possible to delete a Quote when it's no more useful or for any other reason.
When creating a Quote it can be permanent (TTL < 0) or temporary if it's created with a positive TTL. A temporary Quote will be deleted automatically after it's TTL but a permanent Quote should be deleted manually if necessary using the delete or mass delete APIs

Delete a single Quote

=> DELETE /quote/{quoteId}

Delete multiple Quotes

=> POST /quote/delete

Global API parameters

X-quotex-sessionId

Session identifier. Call initSession API to get a session Id.
This is a mandatory header parameter for all Quote APIs.
It's important to Open the Quote and use it after that with same session Id to keep the context during the work session.

X-quotex-userId

The user identifier -> Optional user email or identifier.
It will replace the authenticated service account id for certain API roles if provided.

X-quotex-modelId

Use this optional header to pass modelId retrieved after calling the open quote API.
This will ensure Quote operations are done with the right model version, and break if the model version changes a Quote session.

X-quotex-customer-correlation-context

Use this optional header to pass external context information.

X-quotex-system-mode

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

Request-Id

Use this optional header to correlate or group many calls to the public API for the same external operation.
On every Quote API you will find a header 'Request-Id' that allows associating different calls to the same workflow.
If you have for example a given workflow (from user point of view) that consist of several APIs calls (for example, InitSession, OpenQuote, addRow, checkCommandStatus), it is recommended to generate a new 'Request-id' for every execution of this workflow, and to use this value of the Request-Id as header for every API call of the sequence. This will allow to to associate those calls to a given workflow execution by the request Id set in the header and will facilitate logging and debugging. The Request-Id header must contain a UUID without '-' characters.

Quote session

Session operations

Initialize a Quote session

Initializes a Quote session and returns a session identifier which is required for any further call to the Quote API.

Authorizations:

Token

header Parameters

X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
X-quotex-customer-correlation-context	string Use this optional header to pass external context information.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

200
default

Content type

application/json

{"sessionId": "string"
}

Clean/close a Quote user session

Cleans all resources related to a Quote user session. The session to clean is not considered as a resource and must be provided in the X-quotex-sessionId header like all other public APIs.

Authorizations:

Token

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Quote operations

Quote operations (Operations on the quote structure)

Create a Quote

This operation asynchronously creates a quote.

Authorizations:

Token

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Request Body schema: application/json

modelName required	string
description required	string
language required	string (Language) The language code in lowercase
country required	string (Country) The country code in uppercase.
currency required	string (Currency) The currency code.
ttl	integer <int64> Default: -1 Time to live (in seconds), If attribute is not provided or value is -1 the created Quote is permanent
startDate	string <datetime> 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.
endDate	string <datetime> 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.
amendmentDate	string <datetime> 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
crmQuoteId	string

Responses

Request samples

Payload

Content type

application/json

{"modelName": "string",
"description": "string",
"language": "fr",
"country": "FR",
"currency": "EUR",
"ttl": -1,
"startDate": "2022-11-26",
"endDate": "2022-11-26",
"amendmentDate": "2022-11-26",
"crmQuoteId": "string"
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Check if the Quote with the Id in parameter exists

Check if a Quote exists

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Delete quote by id. The delete will force the Quote TTL to 0. The delete API will also try to deactivate the Quote, so there is no need to call deactivate API separately

Delete a quote by id

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Delete multiple Quotes

This operation deletes quotes with given ids and tries to deactivate them in the same time to release resources. If a Quote is not found it will be ignored without error.

Authorizations:

Token

header Parameters

X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Request Body schema: application/json

quoteIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"quoteIds": ["string"
]
}

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Open a quote

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.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Request Body schema: application/json

timeout	integer [ 1 .. 20 ] Default: 5 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.
processId	string This parameter must be provided if you retry the open operation. It will allow the API to check the open quote state and continue the process.
disableDPContext	boolean Default: false 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)

Responses

Request samples

Payload

Content type

application/json

{"timeout": 5,
"processId": "string",
"disableDPContext": false
}

Response samples

200
202
default

Content type

application/json

{"processId": "string",
"state": "INITIALIZING",
"modelId": "string",
"errorMessage": "string",
"errorCorrelationId": "string"
}

Check the Quote status (Ready, InProgress ...)

This operation returns the status of a quote. It could be invoked right after a quote creation request :The creation process being asynchronous, the quote cannot be opened until this process is complete. The Quote is then marked as 'Ready'. Otherwise, the quote opener has to wait until the Quote is Ready. It is preferable to retry with waitForQuoteReady operation than polling with this get Status operation. 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.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

200
default

Content type

application/json

{"status": "InProgress"
}

Get quote status. Activate quote before if necessary.

This operation activates a quote and waits for it to be ready. The quote status is returned if the quote is ready or in a failed status or if the timeout is reached (In Progress). If timeout is reached, the quote may still be in the process of activation and the client may retry to call this method. It is preferable to retry with this method than polling with simple get Status operation The default timeout if not provided will be 30s or the maximum default value accepted by the server

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

query Parameters

timeout

integer [ 0 .. 30 ]

The maximum time to wait for the operation to finish

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

200
default

Content type

application/json

{"status": "InProgress"
}

Deactivate Quote.

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

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Deactivate Quote and wait for the end of the operation

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 client may retry this call. The default timeout if not provided will be 5s or the maximum default value accepted by the server

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

query Parameters

timeout

integer [ 0 .. 30 ]

The maximum time to wait for the operation to finish

header Parameters

X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Get quote steps

This operation retrieves the list of steps of an existing quote along with their translated labels.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

query Parameters

language required	string The language code in lowercase
country required	string The country code in uppercase

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

200
default

Content type

application/json

{"quoteId": "string",
"quoteModelName": "string",
"description": "string",
"steps": [{"id": "string",
"description": "string"
}
]
}

Clone a Quote

This operation clones a quote and all its related data.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Request Body schema: application/json

description required	string The description of the new quote to create
ttl	integer <int64> Default: -1 Time to live (in seconds), If attribute is not provided or value is -1 the created Quote is permanent
crmQuoteId	string The CRM Quote Id

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"ttl": -1,
"crmQuoteId": "string"
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Migrate a quote

This operation migrates a given quote to a new quote model. The version of the target model is retrieved from the model matrix

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

modelName required	string The target quote model name
disableDPContext	boolean Default: false This parameter is optional and can be used to migrate the Quote while ignoring related context data providers (disableDPContext=true) This option is only authorized for some specific roles (API_SUPER_USER)

Responses

Request samples

Payload

Content type

application/json

{"modelName": "string",
"disableDPContext": false
}

Response samples

202
default

Content type

application/json

{"id": "string"
}

Quote data

Quote data (Operations on rows, cells, fields, ...)

Add rows to quote

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/hierarchical.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

insertPosition required	string Enum: "INSIDE_TOP" "INSIDE_BOTTOM" "BEFORE" "AFTER" Insert position: * INSIDE_TOP - At the top of the grid, or at the top of a folder if it's rowId is specified in the insert point * INSIDE_BOTTOM - At the bottom of the grid, or at the bottom of a folder if it's rowId is specified in the insert point * BEFORE - Before an insert point, in this case you must set a value in the insertPoints parameter * AFTER - After an insert point, in this case you must set a value in the insertPoints
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.
insertPoints	Array of strings Optional parameter to add rows before or after the indicated insert Points.
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.
lineTemplateId	string The line template identifier. It's mandatory for items with the type FOLDER or SPECIFIC
required	Array of objects (A quote row definition) All rows must have the same business value type

Responses

Request samples

Payload

Content type

application/json

{"insertPosition": "INSIDE_TOP",
"insertPoint": "string",
"insertPoints": ["string"
],
"dataProviderName": "string",
"lineTemplateId": "string",
"rows": [{"businessValueType": "SI",
"name": "string",
"namespace": "string",
"quantity": 1,
"description": "string",
"userInputs": [{"columnId": "string",
"inputValue": {"valueType": "Empty"
}
}
]
}
]
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Delete rows from a quote

This operation deletes rows from a quote. This operation is asynchronous so if an error occurs the client will not be notified. The correlation id returned can be used to check the command's execution status

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

rowIds

Array of strings (Row id)

Responses

Request samples

Payload

Content type

application/json

{"rowIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Move rows to quote

This operation moves existing rows inside 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.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

rowIds required	Array of strings (Row id) All rows that must be moved
insertPosition required	string Enum: "INSIDE_TOP" "INSIDE_BOTTOM" "BEFORE" "AFTER" Insert position: * INSIDE_TOP - At the top of the grid, or at the top of a folder if it's rowId is specified in the insert point * INSIDE_BOTTOM - At the bottom of the grid, or at the bottom of a folder if it's rowId is specified in the insert point * BEFORE - Before an insert point, in this case you must set a value in the insertPoint parameter * AFTER - After an insert point, in this case you must set a value in the insertPoint
insertPoint	string Optional parameter to move rows inside, before or after the indicated insert point.

Responses

Request samples

Payload

Content type

application/json

{"rowIds": ["string"
],
"insertPosition": "INSIDE_TOP",
"insertPoint": "string"
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Get mappings for line template resolution.

Retrieve the mapping to use for line templates resolution. This mapping can be used then to call /resolve API.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

query Parameters

dataProviderName

required

string

Data provider name

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

200
default

Content type

application/json

{"resolutionMappings": [{"columnId": "string",
"key": "string",
"type": "string"
}
],
"noValueColumnIds": ["string"
]
}

Resolve line template for a data provider and provided columns/values map

This method can resolve a RowTemplate using the provided map of columnId/value, and when the RowTemplate is found, it parses all row templates of allowed children to find underlying columnId/value mappings If multiple insert points are provided, the line template resolution will be done for each of them and the resulting line template mappings will be a merge of all insertPoint line template mappings.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

query Parameters

dataProviderName

required

string

Data provider name

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

required	Array of objects A columnId/value list to use for line template resolution
insertPosition required	string Enum: "INSIDE_TOP" "INSIDE_BOTTOM" "BEFORE" "AFTER" Insert position: * INSIDE_TOP - At the top of the grid, or at the top of a folder if it's rowId is specified in the insert point * INSIDE_BOTTOM - At the bottom of the grid, or at the bottom of a folder if it's rowId is specified in the insert point * BEFORE - Before an insert point, in this case you must set a value in the insertPoints parameter * AFTER - After an insert point, in this case you must set a value in the insertPoints
insertPoints	Array of strings
name required	string
namespace required	string
description required	string
type required	string Enum: "SI" "CP" Item type: * SI - Standard item * CP - Configurable product

Responses

Request samples

Payload

Content type

application/json

{"values": [{"columnId": "string",
"value": {"valueType": "Empty"
}
}
],
"insertPosition": "INSIDE_TOP",
"insertPoints": ["string"
],
"name": "string",
"namespace": "string",
"description": "string",
"type": "SI"
}

Response samples

200
default

Content type

application/json

{"rootMappings": [{"columnId": "string",
"type": "string",
"key": "string"
}
],
"globalMappings": [{"columnId": "string",
"type": "string",
"key": "string"
}
]
}

Add a Configurable Product to quote

This operation adds a configurable product 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 only one configurable product (CP) with one request, this will create as many rows as necessary to add the product

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

status required	string Enum: "UNCOMPLETED" "COMPLETED" "ERROR" Indicate the status of the configuration you are trying to add.
quantity	number Default: 1 Indicate the quantity of the given hierarchical product to add.
insertPosition required	string Enum: "INSIDE_TOP" "INSIDE_BOTTOM" "BEFORE" "AFTER" Insert position: * INSIDE_TOP - At the top of the grid, or at the top of a folder if it's rowId is specified in the insert point * INSIDE_BOTTOM - At the bottom of the grid, or at the bottom of a folder if it's rowId is specified in the insert point * BEFORE - Before an insert point, in this case you must set a value in the insertPoints parameter * AFTER - After an insert point, in this case you must set a value in the insertPoints
insertPoints	Array of strings 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.
dataProviderName required	string The data provider will be used to get the configurable product item information.
cpName required	string The configurable product name
cpNamespace required	string The configurable product namespace
cpDescription required	string The configuration product description
configurationData required	string configuration data. Must be an xml encoded in base64
required	object (A quote hierarchical row definition) Row attributes

Responses

Request samples

Payload

Content type

application/json

{"status": "UNCOMPLETED",
"quantity": 1,
"insertPosition": "INSIDE_TOP",
"insertPoints": ["string"
],
"dataProviderName": "string",
"cpName": "string",
"cpNamespace": "string",
"cpDescription": "string",
"configurationData": "string",
"rootRow": {"name": "string",
"namespace": "string",
"imageURL": "string",
"description": "string",
"userInputs": [{"columnId": "string",
"inputValue": {"valueType": "Empty"
}
}
],
"children": [{ }
]
}
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Update a Configurable Product in the quote

This operation update a configurable product in 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 update only one configurable product (CP) with one request.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

status required	string Enum: "UNCOMPLETED" "COMPLETED" "ERROR" Indicate the status of the configuration you are trying to add.
rowId required	string Id of the Configurable Product row to modify
configurationData required	string configuration data. Must be an xml encoded in base64
required	object (A quote hierarchical row definition) Row attributes

Responses

Request samples

Payload

Content type

application/json

{"status": "UNCOMPLETED",
"rowId": "string",
"configurationData": "string",
"rootRow": {"name": "string",
"namespace": "string",
"imageURL": "string",
"description": "string",
"userInputs": [{"columnId": "string",
"inputValue": {"valueType": "Empty"
}
}
],
"children": [{ }
]
}
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Merge configurable product

This operation creates updates a configurable product in a quote based on the FPK. 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 merge only one configurable product (CP) with one request.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

status required	string Enum: "UNCOMPLETED" "COMPLETED" "ERROR" Indicate the status of the configuration you are trying to add.
quantity	number Default: 1 Indicate the quantity of the given hierarchical product to add.
insertPosition required	string Enum: "INSIDE_TOP" "INSIDE_BOTTOM" "BEFORE" "AFTER" Insert position: * INSIDE_TOP - At the top of the grid, or at the top of a folder if it's rowId is specified in the insert point * INSIDE_BOTTOM - At the bottom of the grid, or at the bottom of a folder if it's rowId is specified in the insert point * BEFORE - Before an insert point, in this case you must set a value in the insertPoints parameter * AFTER - After an insert point, in this case you must set a value in the insertPoints
insertPoints	Array of strings 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.
dataProviderName required	string The data provider will be used to get the configurable product item information.
cpName required	string The configurable product name
cpNamespace required	string The configurable product namespace
cpDescription required	string The configuration product description
configurationData required	string configuration data. Must be an xml encoded in base64
required	object (A quote hierarchical row definition) Row attributes

Responses

Request samples

Payload

Content type

application/json

{"status": "UNCOMPLETED",
"quantity": 1,
"insertPosition": "INSIDE_TOP",
"insertPoints": ["string"
],
"dataProviderName": "string",
"cpName": "string",
"cpNamespace": "string",
"cpDescription": "string",
"configurationData": "string",
"rootRow": {"name": "string",
"namespace": "string",
"imageURL": "string",
"description": "string",
"userInputs": [{"columnId": "string",
"inputValue": {"valueType": "Empty"
}
}
],
"children": [{ }
]
}
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Restore rows in a quote

This operation restores rows that are marked as DELETED in a quote with change-tracking turned on. This operation is asynchronous so if an error occurs the client will not be notified. The correlation id returned can be used to check the command's execution status

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

rowIds

Array of strings (Row id)

Responses

Request samples

Payload

Content type

application/json

{"rowIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Set a cell value

This operation sets a value in a grid cell. A cell is defined by a row Id and column Id. This operation is asynchronous so if an error occurs the client will not be notified. The correlation id returned can be used to check the command's execution status. Warning: This API is aimed at unitary cell update. If one has to update a large number of cells, the import API should be used instead.

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
rowId required	string Row identifier
colId required	string Column identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

required

object (GridValue)

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

Responses

Request samples

Payload

Content type

application/json

{"inputValue": {"valueType": "Empty"
}
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Clear a cell value

This operation clears a cell value (delete value). A cell is defined by a row Id and column Id. This operation is asynchronous so if an error occurs the client will not be notified. The correlation id returned can be used to check the command's execution status

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
rowId required	string Row identifier
colId required	string Column identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

200
default

Content type

application/json

{"id": "string"
}

Set a field value

This operation sets a value in a field. A field is defined by a field Id, the field Id can normally be found in the model. This operation is asynchronous so if an error occurs the client will not be notified. The correlation id returned can be used to check the command's execution status

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
fieldId required	string Field identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

required

object (GridValue)

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

Responses

Request samples

Payload

Content type

application/json

{"inputValue": {"valueType": "Empty"
}
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Clear a field value

This operation clears a cell value (delete value). A field is defined by a field Id. The field Id can be found in the model. This operation is asynchronous so if an error occurs the client will not be notified. The correlation id returned can be used to check the command's execution status

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
fieldId required	string Field identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

200
default

Content type

application/json

{"id": "string"
}

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

This operation sets a value on a column for the given rows of a view/component. The column Id is defined in the quote model. This operation is asynchronous so if an error occurs the client will not be notified. The correlation id returned can be used to check the command's execution status

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
colId required	string Column identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

rowIds	Array of strings (Row id) Identifiers of the rows to update. This is an optional attribute, if no row identifiers are provided, all rows of the view are updated.
useAdminView	boolean Default: true true if API has to use the admin view, false to use the user's view
viewId required	string The quote view identifier
componentId required	string The quote component identifier
updateMode required	string Enum: "CLEAR" "COPY_FROM" "REPLACE" "DIFFERENTIAL" "PERCENTAGE" Update policy CLEAR - Clear the values of the column referenced in request path COPY_FROM - Copy the value of the column referenced by SourceColumnId to the column referenced in request path REPLACE - Replace the values of the column referenced in request path by the given value DIFFERENTIAL - Add/Subtract the value to the values of the column referenced in request path PERCENTAGE +/- - The values of the column referenced in request path are incremented/decremented by a percentage represented by the given value The percentage value should be already divided by 100. For example 0.5 to add 50% or -0.5 to subtract 50%
	object (GridValue) See different GridValue subtypes definitions for more information. Example: StringGridValue
srcColId	string Source column identifier
updateSubsequentPeriods	boolean Default: false Set true to force update of subsequent periods if the column is linked to a period.
applicationDate	string <datetime> 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

Responses

Request samples

Payload

Content type

application/json

{"rowIds": ["string"
],
"useAdminView": true,
"viewId": "string",
"componentId": "string",
"updateMode": "CLEAR",
"value": {"valueType": "Empty"
},
"srcColId": "string",
"updateSubsequentPeriods": false,
"applicationDate": "2022-11-26"
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Get quote business status

This operation gets the quote business status. This operation retrieves the value of the status in addition to number of errors and warnings in the Quote.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

200
default

Content type

application/json

{"status": "string",
"nbrErrors": 0,
"nbrWarnings": 0
}

Change quote business status value

This operation sets a new status. The quote status is a system field, so, this API can change its current value. This operation is asynchronous, if an error occurs the client will not be notified. The correlation id returned can be used to check the command's execution status

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

businessStatus

string

The new quote business status value

Responses

Request samples

Payload

Content type

application/json

{"businessStatus": "string"
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Get field values

This operation retrieves a snapshot of requested field values of the Quote.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

fieldIds

required

Array of strings

The list of field ids to retrieve

Responses

Request samples

Payload

Content type

application/json

{"fieldIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"fields": [{"fieldId": "string",
"value": {"valueType": "Empty"
},
"isUserInput": true
}
]
}

Get lines values

This operation retrieves a snapshot of lines of the Quote.

If a list of rows identifiers is provided, only those rows are returned. A single call to the API is needed in that case.

Otherwise, all rows are returned in a paginated mode, the size of the page being given as a request attribute (default 1000). In the response of the first call to the API, the total number of pages is returned, computed based on given page size. There must be as many calls to the API as the total of pages. The number of lines in the result can be different from number of requested lines. The API returns only found lines even if rowIds are set in the request. To ensure results consistency, a snapshot identifier is provided in the response. It represents the state of quote structure and quote data. This snapshot identifier varies when quote data is modified or when structure changes (lines are moved, added or deleted) When requesting a new page of rows, this identifier should be compared with previous one.

Returned rows can be differently filtered and sorted depending on the combination of three request body attributes: type of the given componentId, value of the rowIds attribute and value of the useAdminView attribute. Expected behavior is detailed below:

if componentId identifies a grid component
- rowIds contains one single row identifier
  - useAdminView = true: row is returned except if it is filtered by model view filter
  - useAdminView = false: row is returned except if it is filtered by user or model view filter
- rowIds contains a list of row identifiers
  - useAdminView = true: rows are returned in numeric increasing order and filtered by model view
  - useAdminView = false: rows are returned in numeric increasing order and filtered by user and model view
- rowIds is empty (to get a range of rows)
  - useAdminView = true: rows range is returned sorted by model component sort if any and filtered by model view
  - useAdminView = false: rows range is returned sorted by user sort if any, otherwise by model component sort (if any) and filtered by user and model view
if componentId identifies a non grid component or a fields component
- rowIds contains one single row identifier
  - useAdminView = true or false: row is returned (no filter applied)
- rowIds contains a list of row identifiers
  - useAdminView = true: rows are returned in numeric increasing order and filtered by model view
  - useAdminView = false: empty result
- rowIds is empty (to get a range of rows)
  - useAdminView = true: rows range is returned filtered by model view
  - useAdminView = false: empty result

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

query Parameters

page	integer >= 1 The page number
maxLines	integer [ 1 .. 1000 ] The maximum number of lines to retrieve by page

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

viewId required	string The quote view identifier
componentId required	string The quote component identifier
rowIds	Array of strings (Row id) Identifiers of the rows to retrieve. This is an optional attribute, if no row identifiers are provided, the rows within the range of the current page are returned.
columnIds	Array of strings (Column id) Identifiers of the columns to retrieve for each line. This is an optional attribute, if no column identifiers are provided, all columns of the component will be returned.
useAdminView	boolean Default: true true if API has to use the admin view, false to use the user's view
snapId	integer <int64> The snapshot identifier. Returned after each call to the API, the value must be provided on subsequent calls to ensure results consistency.

Responses

Request samples

Payload

Content type

application/json

{"viewId": "string",
"componentId": "string",
"rowIds": ["string"
],
"columnIds": ["string"
],
"useAdminView": true,
"snapId": 0
}

Response samples

200
default

Content type

application/json

{"rows": [{"rowId": "string",
"lineItemTemplateId": "string",
"rowParents": ["string"
],
"rowType": "PRODUCT",
"cells": [{"columnId": "string",
"value": {"valueType": "Empty"
},
"inputValue": {"valueType": "Empty"
}
}
]
}
],
"metadata": {"snapId": 0,
"pageNumber": 0,
"totalPages": 0,
"totalRows": 0
}
}

Get Quote data including fields and lines values

This operation retrieves a snapshot of data of the Quote.

If a list of rows identifiers is provided, only those rows are returned. A single call to the API is needed in that case. Otherwise, all rows are returned in a paginated mode, the size of the page being given as a request attribute (default 1000). In the response of the first call to the API, the total number of pages is returned, computed based on given page size. There must be as many calls to the API as the total of pages. In following calls you can avoid requesting fields as they will be all returned in the first call The number of lines in the result can be different from number of requested lines. The API returns only found lines even if rowIds are set in the request.

Field ids should be provided in the request to get field values, if no field id is provided the API will return only request rows or rows related to the given view and component.

To ensure results consistency, some snapshot identifiers are provided in the response. They represent the state of quote structure and quote data. These snapshot identifiers vary when quote data are modified or when structure changes (lines are moved, added or deleted, field values change,....) When requesting a new page of rows, these identifiers should be provided in the request to be compared with current states.

Returned rows can be differently filtered and sorted depending on the combination of three request body attributes: type of the given componentId, value of the rowIds attribute and value of the useAdminView attribute. Expected behavior is detailed below:

if componentId identifies a grid component
- rowIds contains one single row identifier
  - useAdminView = true: row is returned except if it is filtered by model view filter
  - useAdminView = false: row is returned except if it is filtered by user or model view filter
- rowIds contains a list of row identifiers
  - useAdminView = true: rows are returned in numeric increasing order and filtered by model view
  - useAdminView = false: rows are returned in numeric increasing order and filtered by user and model view
- rowIds is empty (to get a range of rows)
  - useAdminView = true: rows range is returned sorted by model component sort if any and filtered by model view
  - useAdminView = false: rows range is returned sorted by user sort if any, otherwise by model component sort (if any) and filtered by user and model view
if componentId identifies a non grid component or a fields component
- rowIds contains one single row identifier
  - useAdminView = true or false: row is returned (no filter applied)
- rowIds contains a list of row identifiers
  - useAdminView = true: rows are returned in numeric increasing order and filtered by model view
  - useAdminView = false: empty result
- rowIds is empty (to get a range of rows)
  - useAdminView = true: rows range is returned filtered by model view
  - useAdminView = false: empty result

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

viewId required	string The quote view identifier
componentId required	string The quote component identifier
fieldIds	Array of strings The list of field ids to retrieve. If field Ids are not provided the request will only return requested rows and no fields.
rowIds	Array of strings (Row id) Identifiers of the rows to retrieve. This is an optional attribute, if no row identifiers are provided, the rows within the range of the current page are returned.
columnIds	Array of strings (Column id) Identifiers of the columns to retrieve for each line. This is an optional attribute, if no column identifiers are provided, all columns of the component will be returned.
pageNumber	integer >= 0 Default: 1 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
maxLinesPerPage	integer [ 1 .. 1000 ] Default: 1000 The maximum number of lines to retrieve by page
useAdminView	boolean Default: true true if API has to use the admin view, false to use the user's view
	object (Snap Ids) 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.
weaklyConsistent	boolean Default: false 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 updated will be returned.

Responses

Request samples

Payload

Content type

application/json

{"viewId": "string",
"componentId": "string",
"fieldIds": ["string"
],
"rowIds": ["string"
],
"columnIds": ["string"
],
"pageNumber": 1,
"maxLinesPerPage": 1000,
"useAdminView": true,
"snapIds": {"sessionStateSnapId": 0,
"dataSnapId": 0,
"metadataSnapId": 0,
"indexSnapId": 0,
"nodeId": "string",
"weakDataSnapId": 0,
"weakMetadataSnapId": 0,
"weakIndexSnapId": 0
},
"weaklyConsistent": false
}

Response samples

200
default

Content type

application/json

{"fieldsData": [{"fieldId": "string",
"value": {"valueType": "Empty"
},
"isUserInput": true,
"updatable": true,
"visible": true,
"status": "OK",
"errors": ["string"
],
"warnings": ["string"
]
}
],
"rowsData": {"rows": [{"rowId": "string",
"lineItemTemplateId": "string",
"rowParents": ["string"
],
"rowType": "PRODUCT",
"cells": [{"columnId": "string",
"value": {"valueType": "Empty"
},
"isUserInput": true,
"updatable": true,
"visible": true,
"status": "OK",
"errors": ["string"
],
"warnings": ["string"
]
}
],
"status": "OK",
"errors": ["string"
],
"warnings": ["string"
]
}
],
"pageNumber": 0,
"totalPages": 0,
"totalRows": 0
},
"snapIds": {"sessionStateSnapId": 0,
"dataSnapId": 0,
"metadataSnapId": 0,
"indexSnapId": 0,
"nodeId": "string",
"weakDataSnapId": 0,
"weakMetadataSnapId": 0,
"weakIndexSnapId": 0
}
}

Update Quote data including fields and cells values

This operation updates the Quote content by updating fields and cells values

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

	Array of objects (Update data value) Identifiers of the fields to update and their new content to set
	Array of objects (Update data row) Identifiers of the rows to update and their new content to set

Responses

Request samples

Payload

Content type

application/json

{"fields": [{"id": "string",
"value": {"valueType": "Empty"
}
}
],
"rows": [{"rowIdentifier": {"idType": "RowId"
},
"updates": [{"period": {"startDate": "2022-11-26",
"endDate": "2022-11-27"
},
"cellValues": [{"id": "string",
"value": {"valueType": "Empty"
}
}
]
}
]
}
]
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Get configured product row user's choices

This operation retrieves the configuration user's choices for the configured products of a view.

If a list of rows identifiers is provided, only those rows are returned (if they are of type configured product). A maximum of 100 rows is returned.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

viewId required	string The quote view identifier
componentId required	string The quote component identifier
rowIds	Array of strings (Row id) Identifiers of the rows to retrieve. This is an optional attribute, if no row identifiers are provided, all rows of type configured product are returned.
useAdminView	boolean Default: true true if API has to use the admin view, false to use the user's view

Responses

Request samples

Payload

Content type

application/json

{"viewId": "string",
"componentId": "string",
"rowIds": ["string"
],
"useAdminView": true
}

Response samples

200
default

Content type

application/json

{"rows": [{"rowId": "string",
"value": {"valueType": "Empty"
}
}
]
}

Update the quote description

This operation updates the quote description.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

description

required

string

The description value

Responses

Request samples

Payload

Content type

application/json

{"description": "string"
}

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Update the CRM Quote Id

This operation updates the CRM Quote Id.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

crmQuoteId

required

string

The CRM Quote Id

Responses

Request samples

Payload

Content type

application/json

{"crmQuoteId": "string"
}

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Quote contracts

Quote contract dates management

Update contract dates

This operation helps update contract start, end and amendment dates in the Quote

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

date required	string <datetime> A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day .
dateType	string Enum: "START_DATE" "END_DATE" Choose date to change between start or end date. The start date must be strictly before current end date and current amendment date. The end date must be strictly after the current start date and the current amendment date.
changeMode	string Enum: "CREATE" "EXTEND_REDUCE" "GAP" Change date mode. CREATE: Create new period between previous date and the new date. EXTEND: Extend the previous period to the new date. GAP: A missing period will be created between the previous and the new date.

Responses

Request samples

Payload

Content type

application/json

{"date": "2022-11-26",
"dateType": "START_DATE",
"changeMode": "CREATE"
}

Response samples

202
default

Content type

application/json

{"id": "string"
}

Shift contract dates

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.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

shiftDaysNumber

required

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.

Responses

Request samples

Payload

Content type

application/json

{"shiftDaysNumber": "30"
}

Response samples

202
default

Content type

application/json

{"id": "string"
}

Renew contract

This operation renews contract by providing the new contract start and end dates.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

startDate required	string <datetime> Contract start date. A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day .
endDate required	string <datetime> Contract end date. A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day .

Responses

Request samples

Payload

Content type

application/json

{"startDate": "2022-11-26",
"endDate": "2022-11-27"
}

Response samples

202
default

Content type

application/json

{"id": "string"
}

Amend contract

This operation amend contract by providing the new contract amendment date.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

amendmentDate

required

string <datetime>

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

Responses

Request samples

Payload

Content type

application/json

{"amendmentDate": "2022-11-26"
}

Response samples

202
default

Content type

application/json

{"id": "string"
}

Quote filters and rules

Quote filter and rules operations

Set an admin filter on a view.

Applies a custom admin filter that will override the admin filter from the model for this same view. The admin filter restrictions have priority over user filters. The operation is idempotent and can be called many times

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
viewId required	string View identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

show required	string Default: "ALL" Enum: "ALL" "FOLDERS" "PRODUCTS" "FLAT_MODE" "FLAT_MODE_ALL" 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
subRows required	string Default: "ALL" Enum: "ALL" "MATCHING" "NONE" Defines how to show sub rows in their hierarchy ALL - All product hierarchy for matching sub rows MATCHING - Only matching sub rows and their parents NONE - The root only of the matching sub rows
description	string The filter description. This will be associated to the filter in the UI.
required	Array of objects (Filter restriction) 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.
required	Array of objects (Filter restriction) List of filter restrictions to be applied on folders.

Responses

Request samples

Payload

Content type

application/json

{"show": "ALL",
"subRows": "ALL",
"description": "string",
"productRestrictions": [{"columnId": "string",
"operator": "CONTAINS",
"values": [{"valueElements": [{"valueType": "Empty"
}
],
"valueProperty": "ID",
"urlProperty": "URL"
}
]
}
],
"folderRestrictions": [{"columnId": "string",
"operator": "CONTAINS",
"values": [{"valueElements": [{"valueType": "Empty"
}
],
"valueProperty": "ID",
"urlProperty": "URL"
}
]
}
]
}

Response samples

202
default

Content type

application/json

{"id": "string"
}

Reset an admin filter on a view.

Remove any applied admin filter and resets the default admin filter from the model.

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
viewId required	string View identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

202
default

Content type

application/json

{"id": "string"
}

Set a list of user rules on the Quote

Applies a list a list of user computation rules on the Quote. This is a mass API that can add rules on many views of the Quote. Each request will override all existing rules on the quote. All rules will be applied or marked as invalid if they cannot be applied for any reason. Rules status can be verified with get rules API.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

required

Array of objects (User rules)

List user rules to be applied on the Quote

Responses

Request samples

Payload

Content type

application/json

{"rules": [{"description": "string",
"viewId": "string",
"componentId": "string",
"columnId": "string",
"sourceColumnId": "string",
"value": {"valueType": "Empty"
},
"filterRestrictions": [{"columnId": "string",
"operator": "CONTAINS",
"values": [{"valueElements": [{"valueType": "Empty"
}
],
"valueProperty": "ID",
"urlProperty": "URL"
}
]
}
]
}
]
}

Response samples

202
default

Content type

application/json

{"id": "string"
}

Get list of user rules and their status

Retrieves the list of user rules applied on the Quote and their status

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

200
default

Content type

application/json

{"rules": [{"description": "string",
"viewId": "string",
"componentId": "string",
"columnId": "string",
"sourceColumnId": "string",
"value": {"valueType": "Empty"
},
"filterRestrictions": [{"columnId": "string",
"operator": "CONTAINS",
"values": [{"valueElements": [{"valueType": "Empty"
}
],
"valueProperty": "ID",
"urlProperty": "URL"
}
]
}
],
"ruleStatus": "OK",
"errorMessage": "string"
}
]
}

Reset all user rules on a Quote.

Remove any applied user computation rules on a Quote.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

202
default

Content type

application/json

{"id": "string"
}

Quote refresh

Quote grid refresh

Get refresh actions

This operation returns the list of refresh actions that can be executed on the quote. Actions are retrieved from the quote model

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

query Parameters

language required	string The language code in lowercase
country required	string The country code in uppercase

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

200
default

Content type

application/json

{"actions": [{"name": "string",
"label": "string",
"type": "string"
}
]
}

Start a refresh action

This operation triggers a quote refresh operation. The operation executes asynchronously.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

actionName required	string The refresh action name from the model
rowIds	Array of strings 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.

Responses

Request samples

Payload

Content type

application/json

{"actionName": "string",
"rowIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Clear/Cancel a refresh command

This operation cancels any refresh command by it's commandId or all ongoing refresh commands on the Quote if no commandId is provided.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

query Parameters

commandId

string

Optional param with the refresh commandId to clear. If not provided all ongoing refresh commands on the Quote will be cleared.

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

202
default

Content type

application/json

{"id": "string"
}

Start a refresh of exchange rates

This operation triggers a refresh on exchange rates. The operation executes asynchronously.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

effectiveDate

string <dateTime>

A date to use to retrieve exchange rates as defined by date-time in RFC3339 format, with date-time= full-date "T" full-time. This is an optional parameter, if not provided the current date (now) will be used.

Responses

Request samples

Payload

Content type

application/json

{"effectiveDate": "2023-02-21T17:32:28"
}

Response samples

202
default

Content type

application/json

{"id": "string"
}

Quote customization

Quote customization triggers

Get custom process trigger actions

Get list of available custom process trigger actions. Actions are retrieved from the quote model

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

query Parameters

language required	string The language code in lowercase
country required	string The country code in uppercase

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

200
default

Content type

application/json

{"actions": [{"name": "string",
"label": "string",
"type": "string"
}
]
}

Trigger a custom process

This operation triggers a custom process action. List of available actions can be retrieved by API. The operation executes asynchronously.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

actionName required	string The custom process action name from the model
updatedRowIds	Array of strings List of updated row ids to send to the custom process.
createdRowIds	Array of strings List of added row ids to send to the custom process.
deletedRowIds	Array of strings List of deleted row ids to send to the custom process.

Responses

Request samples

Payload

Content type

application/json

{"actionName": "string",
"updatedRowIds": ["string"
],
"createdRowIds": ["string"
],
"deletedRowIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Quote context

Operations on the quote context

Push a Context

This operation pushes a context map into a Context Data Provider.

Authorizations:

Token

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

modelName	string The quote model name for a non existing quote. If this paramater is provided there is no need to set the quoteId
quoteId	string The quoteId if the pushContext concerns an existing quote. If modelName is provided, there is no need set the quoteId
dataProviderName required	string The data provider name in quote model
refreshContext	boolean Default: false Starts a refresh of context values is quote. This will trigger a command and the correlationId will be returned in response. If refreshContext equals true, the quoteId must be provided
required	Array of objects (Context key/value pair.) An array to hold context data to push into a data provider. The context is a list of key/value pairs

Responses

Request samples

Payload

Content type

application/json

{"modelName": "string",
"quoteId": "string",
"dataProviderName": "string",
"refreshContext": false,
"context": [{"key": "my key",
"value": {"valueType": "Empty"
}
}
]
}

Response samples

200
default

Content type

application/json

{"id": "string"
}

Get Contexts

Get all contexts related to the given session and model or quote. This operation is only authorized for role API_SUPER_USER and will return context map for each context configured in the given model or in the model associated to the given Quote

Authorizations:

Token

query Parameters

modelName	string The Quote model name. Better use the modelName to get contexts than using the quoteId, one of the two parameters should be provided at least.
quoteId	string The Quote identifier. Better use the modelName to get contexts than using the quoteId, one of the two parameters should be provided at least.

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

200
default

Content type

application/json

{"contexts": [{"contextName": "string",
"context": [{"key": "my key",
"value": {"valueType": "Empty"
}
}
]
}
]
}

Quote Export/Import

Export and Import operations on quote data

Export quote content in JSON format

This operation triggers an export of the content of a quote Grid in json format. The operation executes asynchronously. Once completed, the export can be retrieved later using the Get Export operation.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

viewId required	string The quote view identifier
componentId required	string The quote component identifier
linesPerPart	integer Default: 200 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.
dataType	string Default: "JSON" Enum: "JSON" "JSON_CUSTOM" The type of JSON export to launch. * JSON - Export grid in standard JSON format. * JSON_CUSTOM - Export grid in custom JSON for CRM integrations. This is a simplified and lightweight format.
language	string (Language) The language code in lowercase
country	string (Country) The country code in uppercase.
reloadable	boolean Default: true If true the export can be reused for an import. The export file will then contain all necessary data for a later import. This will also force the export of FPK variables.
useAdminView	boolean Default: true true if export has to use the admin view, false otherwise
overrideColumns	Array of strings List of columns to export (column names). If not set, all the component/view columns will be exported
overrideFields	Array of strings List of fields to export (column names). If not set, all the component/view fields will be exported
exportMode	string Default: "EXCLUDE_NO_VALUES" Enum: "EXCLUDE_NO_VALUES" "FORCE_USER_INPUTS" 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.
exportHistoricalPeriods	boolean Default: true True if historical periods, periods before amendment date, will be exported.

Responses

Request samples

Payload

Content type

application/json

{"viewId": "string",
"componentId": "string",
"linesPerPart": 200,
"dataType": "JSON",
"language": "fr",
"country": "FR",
"reloadable": true,
"useAdminView": true,
"overrideColumns": ["string"
],
"overrideFields": ["string"
],
"exportMode": "EXCLUDE_NO_VALUES",
"exportHistoricalPeriods": true
}

Response samples

200
default

Content type

application/json

{"exportId": "4c248185-480b-4fc1-9609-fb1e76d7d276",
"totalNumberOfParts": 1,
"taskId": "string"
}

Export quote content in XLSX format

This operation triggers an export of the content of a quote Grid in xlsx format. The operation executes asynchronously. Once completed, the export can be retrieved later using the Get Export file operation.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

viewId required	string The quote view identifier
componentId required	string The quote component identifier
dataType required	string Enum: "XLSX_ID" "XLSX_DESCR" "XLSX_ID_DESCR" The type of XLSX export to launch. * XLSX_ID - Export grid in XLSX format. Business values will be identified by their name in the export. The export locale (language and country are required for this type of export) * XLSX_DESCR - Export grid in XLSX format. Business values will be identified by their description in the export (language and country are required for this type of export) * XLSX_ID_DESCR - Export grid in XLSX format. Business values will be identified by their name and description in the export (language and country are required for this type of export)
language	string (Language) The language code in lowercase
country	string (Country) The country code in uppercase.
reloadable	boolean Default: true If true the export can be reused for an import
useAdminView	boolean Default: true true if export has to use the admin view, false otherwise
overrideColumns	Array of strings List of columns to export (column names). If not set, all the component/view columns will be exported
overrideFields	Array of strings List of fields to export (column names). If not set, all the component/view fields will be exported
exportMode	string Default: "EXCLUDE_NO_VALUES" Enum: "EXCLUDE_NO_VALUES" "FORCE_USER_INPUTS" 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.
exportRowId	boolean Default: false Set to true to export rowIds
exportHistoricalPeriods	boolean Default: true True if historical periods, periods before amendment date, will be exported.

Responses

Request samples

Payload

Content type

application/json

{"viewId": "string",
"componentId": "string",
"dataType": "XLSX_ID",
"language": "fr",
"country": "FR",
"reloadable": true,
"useAdminView": true,
"overrideColumns": ["string"
],
"overrideFields": ["string"
],
"exportMode": "EXCLUDE_NO_VALUES",
"exportRowId": false,
"exportHistoricalPeriods": true
}

Response samples

200
default

Content type

application/json

{"exportId": "4c248185-480b-4fc1-9609-fb1e76d7d276",
"totalNumberOfParts": 1,
"taskId": "string"
}

Get Export status

This operation returns the status of an export of the status of an export part if the part number is provided. It can be invoked after an export creation to check if the export is ready. 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.

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
exportId required	string Quote Export identifier

query Parameters

partNumber

integer >= 0

Default: 0

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

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

200
default

Content type

application/json

{"status": "InProgress"
}

Get Export file

This operation retrieves export parts of a quote in a file format depending on the operation used previously: export xlsx or export json. The first part number is 1. Warning: Parallel calls to this API for a given user on a given export to retrieve multiple pages at the same time is strictly forbidden.

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
exportId required	string Quote Export identifier

query Parameters

partNumber

integer >= 1

Default: 1

Export part number.

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

200
default

Content type

application/octet-stream

No sample

Delete export

This operation removes a quote export from the repository.

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
exportId required	string Quote Export identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Import data into a quote

This operation uploads an import file and starts a job that analyses the file and imports data in the Quote. If a row can't be imported for some reason (error) it will be ignored. You can check import result with the getCommandStatus operation by providing the returned correlationId.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: multipart/form-data

importFile required	string <binary> 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.
insertPosition	string Default: "INSIDE_TOP" Enum: "INSIDE_TOP" "INSIDE_BOTTOM" "BEFORE" "AFTER" Optional. If not set lines will be imported in the top of the grid INSIDE_TOP - At the top of the grid, or at the top of a folder if it's rowId is specified in the insert point * INSIDE_BOTTOM - At the bottom of the grid, or at the bottom of a folder if it's rowId is specified in the insert point * BEFORE - Before an insert point, in this case you must set a value in the insertPoints parameter * AFTER - After an insert point, in this case you must set a value in the insertPoints
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.
country	string Country for locale. The country and language params will be used if they are not found in the import file for a line.
language	string Language for locale. The country and language params will be used if they are not found in the import file for a line.
dataProviderName	string The optional data provider name. Will be used if the data provider is not found in the import file for some lines.
replacementType	string Default: "NONE" Enum: "NONE" "REPLACE" "FORCE" 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
matchOnRowId	string Default: false Optional field. If set to true, it would make the line matching to be done on the row id instead of the fpk (Functional primary key)
updatePolicy	string Default: "MERGE" Enum: "KEEP" "CLEAN" "MERGE" 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
updateConflictPolicy	string Default: "ALWAYS_ADD" Enum: "KEEP_WHEN_SINGLE_MATCH" "CLEAN_WHEN_SINGLE_MATCH" "MERGE_WHEN_SINGLE_MATCH" "ALWAYS_ADD" 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.
defaultWorkspace	string Optional field to set the default import workspace
defaultFolderRowTemplate	string Optional : Default row template for FOLDER line type. Will be used if not provided inside the import file for some lines.
defaultSpecificRowTemplate	string Optional : Default row template for SPECIFIC line type. Will be used if not provided inside the import file for some lines.

Responses

Response samples

200
default

Content type

application/json

{"id": "string"
}

Import data into a quote from an existing export

This operation starts an import from an existing Quote export without providing the export file.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: multipart/form-data

sourceQuoteId required	string The quote Id of the source export
sourceExportId required	string The source export id
insertPosition	string Default: "INSIDE_TOP" Enum: "INSIDE_TOP" "INSIDE_BOTTOM" "BEFORE" "AFTER" Optional. If not set lines will be imported in the top of the grid INSIDE_TOP - At the top of the grid, or at the top of a folder if it's rowId is specified in the insertPosition INSIDE_TOP - At the top of the grid, or at the top of a folder if it's rowId is specified in the insert point * INSIDE_BOTTOM - At the bottom of the grid, or at the bottom of a folder if it's rowId is specified in the insert point * BEFORE - Before an insert point, in this case you must set a value in the insertPoints parameter * AFTER - After an insert point, in this case you must set a value in the insertPoints
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.
country	string Country for locale. The country and language params will be used if they are not found in the import file for a line.
language	string Language for locale. The country and language params will be used if they are not found in the import file for a line.
dataProviderName	string The optional data provider name. Will be used if the data provider is not found in the import file for some lines.
replacementType	string Default: "NONE" Enum: "NONE" "REPLACE" "FORCE" Optional. If not set default value NONE will be used NONE - No replacement REPLACE - Only replace non elligible products with a replacement product FORCE - Replace all products with a replacement product
matchOnRowId	string Default: false Optional field. If set to true, it would make the line matching to be done on the row id instead of the fpk (Functional primary key)
updatePolicy	string Default: "MERGE" Enum: "KEEP" "CLEAN" "MERGE" 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
updateConflictPolicy	string Default: "ALWAYS_ADD" Enum: "KEEP_WHEN_SINGLE_MATCH" "CLEAN_WHEN_SINGLE_MATCH" "MERGE_WHEN_SINGLE_MATCH" "ALWAYS_ADD" 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.
defaultWorkspace	string Optional field to set the default import workspace
defaultFolderRowTemplate	string Optional : Default row template for FOLDER line type. Will be used if not provided inside the import file for some lines.
defaultSpecificRowTemplate	string Optional : Default row template for SPECIFIC line type. Will be used if not provided inside the import file for some lines.

Responses

Response samples

200
default

Content type

application/json

{"id": "string"
}

Quote document generation

Document generation and retrieval operations

Generate a quote report

This operation triggers a quote report generation. The operation executes asynchronously. Once completed, the report can be retrieved later using the Get report operation.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

actionName

required

string

The report action name from the model

Responses

Request samples

Payload

Content type

application/json

{"actionName": "string"
}

Response samples

200
default

Content type

application/json

{"reportId": "4c248185-480b-4fc1-9609-fb1e76d7d276",
"taskId": "string"
}

Get report status

This operation returns the status of a report generation. It can be invoked after a generate report operation to check if the report is ready. 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.

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
reportId required	string Quote Report identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

200
default

Content type

application/json

{"status": "InProgress",
"errorMessage": "string",
"contentInfo": {"contentSize": 0
}
}

Get Report

This operation retrieves an already generated quote report. The report format depends on the report template and action type. Report format can be json, pdf, word, xslx, html, rtf, csv.

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
reportId required	string Quote Report identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

200
default

Content type

application/octet-stream

No sample

Delete report

This operation removes a quote report from the repository.

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
reportId required	string Quote Report identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Get report actions

This operation returns the list of report/print actions related to the given quote

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

query Parameters

language required	string The language code in lowercase
country required	string The country code in uppercase

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

200
default

Content type

application/json

{"actions": [{"name": "string",
"label": "string",
"type": "string"
}
]
}

Long processing

Long processing reports

Get long processing report status

This operation returns the status of a long processing. A long processing report is available for every API that returns a taskId (Export/Import/Document Generation). 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.

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
taskId required	string Long treatment task id

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

200
default

Content type

application/json

{"status": "CREATED",
"reportName": "string",
"description": "string",
"message": "string",
"errorMessage": "string"
}

Get a long processing report file

This operation retrieves a long processing report file by it's 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.

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
taskId required	string Long treatment task id

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

200
default

Content type

application/octet-stream

No sample

Quote command status

Command status operations

Get command status

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.

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
correlationId required	string Command correlation identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

200
default

Content type

application/json

{"status": "Failed",
"taskId": "string",
"additionalInfo": {"rowIds": ["string"
],
"nbrUpdatedFields": 0,
"nbrFailedFields": 0,
"nbrUpdatedRows": 0,
"nbrPartlyUpdatedRows": 0,
"nbrFailedRows": 0
},
"errorMessage": {"logCorrelationId": "string",
"code": 0,
"message": "string"
}
}

Delete command status

This operation removes the status of the given command.

Authorizations:

Token

path Parameters

quoteId required	string Quote identifier
correlationId required	string Command correlation identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Quote telemetry

Post a log

This operation logs a message with a level and an optional request Id header to correlate the message to log with other API calls.

Authorizations:

Token

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Request Body schema: application/json

logLevel required	string Enum: "INFO" "WARN" "ERROR" The message to log.
message required	string The log level to use

Responses

Request samples

Payload

Content type

application/json

{"logLevel": "INFO",
"message": "string"
}

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Post a list of logs and dependencies

This operation logs a list of log entries and dependencies. It's useful to correlate external dependencies to other public API requests using the same request Id.

Authorizations:

Token

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Request Body schema: application/json

	Array of objects (Log message operation Request.)
	Array of objects (Log dependency operation Request.)

Responses

Request samples

Payload

Content type

application/json

{"messages": [{"logLevel": "INFO",
"message": "string"
}
],
"dependencies": [{"targetName": "Pricing service",
"targetType": "HTTP",
"commandName": "Get price",
"commandDescription": "Get price for product \"MyProduct\"",
"startDate": "2020-02-21T17:32:28",
"duration": 10,
"success": true,
"resultCode": 200
}
]
}

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Get debug log status

This operation retrieves the debug log status of the given quote. The operation is only authorized for role API_SUPER_USER.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

200
default

Content type

application/json

{"debugLogActivated": true,
"logCellChanges": true,
"sessionEndTime": "2023-02-21T17:32:28"
}

Update debug log status

This operation activates or deactivates a debug log session for the given quote. The operation is only authorized for role API_SUPER_USER.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

activateDebugLog required	boolean Set to true to activate a debug log session, false to deactivate it.
logCellChanges	boolean Default: false This parameter is optional and can be used to log the cell changes during debug log session.

Responses

Request samples

Payload

Content type

application/json

{"activateDebugLog": true,
"logCellChanges": false
}

Response samples

202
default

Content type

application/json

{"id": "string"
}

Quote notifications

Push a notification on the Quote

Push a notification to users that are working on the given Quote.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Request Body schema: application/json

Request for pushNotification API method

type required	string Enum: "INFO" "WARN" "ERROR" Notification type, must be one of INFO/WARN/ERROR
businessCode	string Optional customer business code of the notification
defaultMessage required	string Message to use if translations are not available or user locale is not known
	Array of objects (LocalizedMessage)

Responses

Request samples

Payload

Content type

application/json

{"type": "INFO",
"businessCode": "string",
"defaultMessage": "string",
"translations": [{"language": "en",
"country": "US",
"message": "string"
}
]
}

Response samples

default

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

Quote meta-data

Quote meta-data operations

retrieve meta-data of a quote

This operation retrieves meta-data of a quote.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
X-quotex-system-mode	boolean 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)

Responses

Response samples

200
default

Content type

application/json

{"changeTracking": true,
"frozen": true
}

update changes tracking flag of a quote

This operation change tracking flag of a quote. The operation result can be verified by calling GET /metadata API to ensure change tracking flag is updated.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
X-quotex-system-mode	boolean 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)

Request Body schema: application/json

changeTracking

required

boolean

The new change tracking indicator value

Responses

Request samples

Payload

Content type

application/json

{"changeTracking": true
}

Response samples

202
default

Content type

application/json

{"id": "string"
}

Update frozen flag of a quote

This operation changes frozen flag of a quote. The unfreeze operation will also start an open user session operation (open quote) and a migration if the model changed while Quote was in frozen status. The operation result can be verified by calling GET /metadata API to ensure frozen flag is updated.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
X-quotex-system-mode	boolean 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)

Request Body schema: application/json

frozen required	boolean The new frozen indicator value
disableDPContext	boolean Default: false 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

Responses

Request samples

Payload

Content type

application/json

{"frozen": true,
"disableDPContext": false
}

Response samples

202
default

Content type

application/json

{"id": "string"
}

Quote CRM

Quote CRM operations

Get synchronization actions

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

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

query Parameters

language required	string The language code in lowercase
country required	string The country code in uppercase

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Responses

Response samples

200
default

Content type

application/json

{"actions": [{"name": "string",
"label": "string",
"type": "string"
}
]
}

This operation synchronizes the quote with a salesforce CRM.

Start a synchronization of the quote data with a CRM. The synchronization process will start an export of the grid and will provid back an exportId that can be used to get a status using the getExportStatus operation. The operation executes asynchronously.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string 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 the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

actionName

required

string

The synchronization action name from the model

Responses

Request samples

Payload

Content type

application/json

{"actionName": "string"
}

Response samples

202
default

Content type

application/json

{"exportId": "4c248185-480b-4fc1-9609-fb1e76d7d276",
"totalNumberOfParts": 1,
"taskId": "string"
}

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

Start a synchronization of the quote data with a CRM. The operation executes asynchronously. This API can return 409 in case of dynamics CRM synchronization is not active for the authenticated tenant.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

required	object (Export Quote Operation Request.) This object is passed in the body of the [export quote] request and specify the size of export trunks whenever trunks are required.
	object (Ms Dynamics CRM specific synchronization properties)

Responses

Request samples

Payload

Content type

application/json

{"exportParams": {"viewId": "string",
"componentId": "string",
"linesPerPart": 200,
"language": "fr",
"country": "FR",
"reloadable": true,
"exportMode": "EXCLUDE_NO_VALUES"
},
"crmProperties": {"property1": "string",
"property2": "string"
}
}

Response samples

400
404
409
500

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

This operation synchronizes opportunity products with an MS dynamics CRM.

Start a synchronization of opportunity products of the Quote with a CRM. The operation executes asynchronously. This API can return 409 in case of dynamics CRM synchronization is not active for the authenticated tenant.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

object (Ms Dynamics CRM specific synchronization properties)

Responses

Request samples

Payload

Content type

application/json

{"crmProperties": {"property1": "string",
"property2": "string"
}
}

Response samples

400
404
409
500

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

This operation synchronizes opportunity products with an MS dynamics CRM.

Start a synchronization of the Quote with a CRM to delete opportunity products. The operation executes asynchronously. This API can return 409 in case of dynamics CRM synchronization is not active for the authenticated tenant.

Authorizations:

Token

path Parameters

quoteId

required

string

Quote identifier

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)
X-quotex-modelId	string Use this optional header to pass modelId retrieved after calling the open quote API.

Request Body schema: application/json

object (Ms Dynamics CRM specific synchronization properties)

Responses

Request samples

Payload

Content type

application/json

{"crmProperties": {"property1": "string",
"property2": "string"
}
}

Response samples

400
404
409
500

Content type

application/json

{"operationId": "b91bbf81beb74397ae282d1186aa1798",
"code": 500,
"message": "string"
}

This operation encrypts the authenticated used id, this API can be only used from a standard CRM integration with CRM role

Takes the authenticated user calling the API, encrypts this user id and returns the encrypted user id.

Authorizations:

Token

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-userId required	string The user identifier to encrypt
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.
X-quotex-system-mode	boolean 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)

Responses

Response samples

200
400
500

Content type

application/json

{"encryptedUserId": "string"
}