Conga Product Documentation

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

Performance Quoting APIs Change Log - Model

Overview

Performance Quoting Model APIs allow the management of Quote Models.

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

Current version: 1.4.2

Online Access to Documentation (via Swagger)

APIs are available here:

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

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

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

Version Change Tracking

Changes from version 1.4.1 to version 1.4.2

WHAT'S CHANGED

GET /model/docGen/template

Return Type:

Changed response : 200 OK

Successful response:
  • Changed content type : application/json
    • Changed property templates (array)

Changed items (object):

  • Added property type (string)

Enum values:

  • PDF
  • DOCX
  • XLSX

Changes from version 1.3.2 to version 1.4.0

WHAT’S CHANGED

POST /model/session

Parameters:

Deleted: X-quotex-environment in header

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

GET /model/matrix

Parameters:

Deleted: X-quotex-environment in header

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

POST /model/matrix

Parameters:

Deleted: X-quotex-environment in header

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

DELETE /model/matrix

Parameters:

Deleted: X-quotex-environment in header

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

GET /model/matrix/{modelFamily}

Parameters:

Deleted: X-quotex-environment in header

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

DELETE /model/matrix/{modelFamily}

Parameters:

Deleted: X-quotex-environment in header

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

HEAD /model/matrix/{modelFamily}

Parameters:

Deleted: X-quotex-environment in header

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

GET /model/version

Parameters:

Deleted: X-quotex-environment in header

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

POST /model/validate

Parameters:

Deleted: X-quotex-environment in header

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

POST /model/store

Parameters:

Deleted: X-quotex-environment in header

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

POST /model/validatefile

Parameters:

Deleted: X-quotex-environment in header

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

POST /model/spreadsheet/validatefile

Parameters:

Deleted: X-quotex-environment in header

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

POST /model/storefile

Parameters:

Deleted: X-quotex-environment in header

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

GET /model/{modelName}

Parameters:

Deleted: X-quotex-environment in header

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

GET /model/{modelName}/gridDefinition

Parameters:

Deleted: X-quotex-environment in header

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

GET /model/docGen/template

Parameters:

Deleted: X-quotex-environment in header

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

POST /model/docGen/template

Parameters:

Deleted: X-quotex-environment in header

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

GET /model/docGen/template/{templateName}

Parameters:

Deleted: X-quotex-environment in header

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

Changes from version 1.2.2 to version 1.3.2

WHAT'S CHANGED

POST /model/storefile

Return Type:

New response: 400 Bad Request

Invalid model. You can check on validation errors

Changes from version 1.2.0 to version 1.2.2

WHAT'S NEW

POST /model/{modelName}/translations

Provide model translations:

Changes from version 1.1.12 to version 1.2.0

WHAT'S DELETED

GET /model/{quoteModelId}/translations/quote

Retrieve quote translations for a quote model identifier:

GET /model/{quoteModelId}/supportedLocales

Retrieve supported locales for a quote model identifier:

GET /model/{quoteModelId}/supportedCurrencies

Retrieve supported currencies for a quote model identifier:

GET /model/{quoteModelId}/fallbackLocale

Retrieve fallback locale for a quote model identifier:

GET /model/{quoteModelId}/translations/grid

Retrieve grid translations for a quote model identifier:

WHAT'S CHANGED

GET /model/docGen/template

Return Type:

Changed response : 200 OK

Successful response:
  • Changed content type : application/json
    * Changed property `templates` (array) Changed items (object):

    * Changed property `lastUpdatedOn` (string -> string)

    Last update date of the template

    Changes from version 1.1.10 to version 1.1.12

WHAT'S DELETED

POST /model/admin/domain/{domainName}/upload

Upload a domain file. Deprecated before Version 12.13 - will be discontinued as of september 2023. Can be replaced by domain contract APIs (/domains)

POST /model/admin/domain/activate

Activate domain files. Deprecated before Version 12.13 - will be discontinued as of september 2023. Can be replaced by domain contract APIs (/domains)

POST /model/admin/domain/{domainName}/pushAndActivate

Upload and activate a domain file. Deprecated before Version 12.13 - will be discontinued as of september 2023. Can be replaced by domain contract APIs (/domains)

GET /model/admin/domain/{domainName}/export

Export a domain file. Deprecated before Version 12.13 - will be discontinued as of september 2023. Can be replaced by domain contract APIs (/domains)

GET /model/admin/domain/{domainName}

Get list of domain versions. Deprecated before Version 12.13 - will be discontinued as of september 2023. Can be replaced by domain contract APIs (/domains)

GET /model/admin/domain/{domainName}/backups

Get list of backups. Deprecated before Version 12.13 - will be discontinued as of september 2023.

WHAT'S CHANGED

GET /model/{modelName}/gridDefinition

Return Type:

Changed response : 200 OK

Successful response:
  • Changed content type : application/json
* Changed property `gridColumnDefinitions` (array) Changed items (object):
Definition of public grid field
Changed property `type` (string) Added enum values:
`MEASURE`
`CURRENCY_PER_QUANTITY`
`MONETARY_PER_QUANTITY`
* Changed property `gridFieldsDefinitions` (array) Changed items (object):
Definition of public grid field
Changed property `type` (string) Added enum values:
`MEASURE`
`CURRENCY_PER_QUANTITY`
`MONETARY_PER_QUANTITY`

Changes from version 1.1.9 to version 1.1.10

WHAT'S CHANGED

POST /model/validate

Validate a quote model. Deprecated before Version 12.13 - will be discontinued as of june 2024. Can be replaced by POST /model/validatefile.

POST /model/store

Store a Quote model. Deprecated before Version 12.13 - will be discontinued as of june 2024. Can be replaced by POST /model/storefile.

POST /model/admin/domain/{domainName}/upload

Upload a domain file. Deprecated before Version 12.13 - will be discontinued as of september 2023. Can be replaced by domain contract APIs (/domains)

POST /model/admin/domain/activate

Activate domain files. Deprecated before Version 12.13 - will be discontinued as of september 2023. Can be replaced by domain contract APIs (/domains)

POST /model/admin/domain/{domainName}/pushAndActivate

Upload and activate a domain file. Deprecated before Version 12.13 - will be discontinued as of september 2023. Can be replaced by domain contract APIs (/domains)

GET /model/admin/domain/{domainName}/export

Export a domain file. Deprecated before Version 12.13 - will be discontinued as of september 2023. Can be replaced by domain contract APIs (/domains)

GET /model/admin/domain/{domainName}

Get list of domain versions. Deprecated before Version 12.13 - will be discontinued as of september 2023. Can be replaced by domain contract APIs (/domains)

GET /model/admin/domain/{domainName}/backups

Get list of backups. Deprecated before Version 12.13 - will be discontinued as of september 2023.

Changes from version 1.1.5 to 1.1.6

WHAT'S DELETED

POST /model/admin/domain/copyAndActivate/{toEnvironment}

copy domains revisions from current environment to an other:

Changes from version 1.1.3 to version 1.1.5

WHAT’S CHANGED

POST /model/admin/domain/{domainName}/upload

POST /model/admin/domain/activate

POST /model/admin/domain/{domainName}/pushAndActivate

GET /model/admin/domain/{domainName}/export

GET /model/admin/domain/{domainName}

GET /model/admin/domain/{domainName}/backups

POST /model/admin/domain/copyAndActivate/{toEnvironment}

Changes from version 1.1.0 to version 1.1.2

WHAT'S CHANGED

POST /model/session

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

GET /model/matrix

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

POST /model/matrix

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

DELETE /model/matrix

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

GET /model/matrix/{modelFamily}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

DELETE /model/matrix/{modelFamily}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

HEAD /model/matrix/{modelFamily}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

GET /model/version

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

GET /model/{modelName}/gridDefinition

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

Return Type:

Changed response : 200 OK

Successful response:
  • Changed content type : application/json
    *Changed property `gridColumnDefinitions` (array)
    
    (object):> Definition of public grid field*
    
    Changed items
    Changed property
    
    `type` (string)*`PERIOD`*Changed property `gridFieldsDefinitions` (array)> Definition of public grid field*Changed property `type` (string)
    Added enum value:*`PERIOD`

POST /model/validate

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

POST /model/store

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

POST /model/validatefile

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

POST /model/spreadsheet/validatefile

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

POST /model/storefile

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

GET /model/{modelName}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

GET /model/docGen/template

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

POST /model/docGen/template

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

GET /model/docGen/template/{templateName}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

POST /model/admin/domain/{domainName}/upload

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

POST /model/admin/domain/activate

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

POST /model/admin/domain/{domainName}/pushAndActivate

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

GET /model/admin/domain/{domainName}/export

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

GET /model/admin/domain/{domainName}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

GET /model/admin/domain/{domainName}/backups

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

POST /model/admin/domain/copyAndActivate/{toEnvironment}

Parameters:

Added: X-quotex-system-mode in header

Use this optional header to run an API in system mode. The user must have the API_SUPER_USER or AGREEMENT role to be able to use system mode.

Changed: X-quotex-environment in header

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

Changes from version 1.0.0 to version 1.1.0

WHAT'S CHANGED

GET /model/{modelName}/gridDefinition

Return Type:

Changed response : 200 OK

Successful response:
  • Changed content type : application/json
    *Changed property `gridColumnDefinitions` (array)
    (object):> Definition of public grid field*
    
    `type` (string)Added enum value:*
    
    Changed items Changed property
    `ATTACHMENT`*
    Changed property `gridFieldsDefinitions` (array)(object):> Definition of public grid field*Changed property
    `type` (string)Added enum value:*`ATTACHMENT`*
    Changed property `viewDefinitions` (array)Changed items (object):>
    
    Definition of public grid view
    `componentDefinitions` (array) Definition of a grid component (boolean)
    
    *
    
    Changed property
    Changed items (object):
    
    >
    
    *
    
    Added property `isGrid`